Login
Back to bricks list
Introduction Version

InputSpec

Spec for an input task port

Attributes

human_name: Optionalis_optional: boolresource_types: Listshort_description: Optionalvalidators: List

Functions

__INIT__

summary

          If the input is connected, the system will wait for the input to be provided before running the task.
          Also tells that None value is allowed as input.  , defaults to False
Parameters:
NameTypeDefault valueDescription
resource_typesUnion _description_ resourcetypes
is_optionalbool False This input might not be connected to another task output and the task will still be executed. , optional
is_skippablebool False :param is_skippable deprecated, use is_optional instead. , optional
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:
IOSpec