Login
Back to bricks list
Introduction Version

OutputSpec

Spec for an output task port

Attributes

human_name: Optionalis_optional: boolresource_types: Listshort_description: Optionalvalidators: List

Functions

__INIT__

summary

    are compatible with any child class of the provided resource type, defaults to False
  and it does not need to create a new resource after the task, defaults to False
Parameters:
NameTypeDefault valueDescription
resource_typesUnion _description_ resourcetypes
is_optionalbool False Tell that this output may return none or not being provided, defaults to false , optional
sub_classbool False When true, it tells that the resource_types
is_constantbool False When true, this tells the system that the output resource was not modified from the input resource
human_nameOptional _description_, defaults to none [str], optional
short_descriptionOptional _description_, defaults to none [str], optional
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
Parameters:
NameTypeDefault valueDescription
in_specIOSpec
Return type:
bool
IS_COMPATIBLE_WITH_RESOURCE_TYPE
Parameters:
NameTypeDefault valueDescription
resource_typeType
Return type:
bool
IS_COMPATIBLE_WITH_RESOURCE_TYPES

return True if one of the resource_types is compatible with the this spec

Parameters:
NameTypeDefault valueDescription
resource_typesIterable
Return type:
bool
IS_CONSTANT_OUT
Return type:
bool
IS_SUBCLASS_OUT
Return type:
bool
TO_DTO
Return type:
IOSpecDTO
VALIDATE_RESOURCE

Validate a resource with the validators

Parameters:
NameTypeDefault valueDescription
resourceResource
FROM_DTO - @classmethod
Parameters:
NameTypeDefault valueDescription
dtoIOSpecDTO
Return type:
OutputSpec