OutputSpec
Spec for an output task port
Attributes
human_name: str | Noneoptional: boolresource_types: listshort_description: str | Nonevalidators: listFunctions
__init__
resource_types :
type[gws_core.resource.resource.Resource] | collections.abc.Iterable[type[gws_core.resource.resource.Resource]] the resource types accepted by this output port
optional :
bool - False tell that this output may return None or not being provided
sub_class :
bool - False When true, it tells that the resource_types
are compatible with any child class of the provided resource type
human_name :
str | None human readable name for this port
short_description :
str | None short description for this port
check_resource_types
get_default_resource_type
return the first default type
Return type :
type get_resource_type_tuples
Return type :
tuple get_resources_human_names
Return type :
str is_compatible_with_in_spec
in_spec :
IOSpec Return type :
bool is_compatible_with_resource_type
resource_type :
type Return type :
bool is_compatible_with_resource_types
return True if one of the resource_types is compatible with the this spec
resource_types :
Iterable Return type :
bool subclass_out
Return type :
bool to_dto
Return type :
IOSpecDTO validate_resource
Validate a resource with the validators
resource :
Resource from_dto @classmethod
dto :
IOSpecDTO Return type :
OutputSpec