Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

OutputSpec

Spec for an output task port

Attributes
human_name: Optionalis_optional: boolresource_types: Listshort_description: Optionalvalidators: List
Functions
__INIT__

summary

resource_types : Union
_description_
is_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
is_constant : bool - False
When true, this tells the system that the output resource was not modified from the input resource and it does not need to create a new resource after the task
human_name : Optional
_description_
short_description : Optional
_description_
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
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

resource : Resource
FROM_DTO - @classmethod
dto : IOSpecDTO
Return type : OutputSpec