Login
Back to bricks list
Introduction Version

Inputs

Input class

Functions

__INIT__

Initialize self. See help(type(self)) for accurate signature.

Parameters:
NameTypeDefault valueDescription
type_Literal normal
additional_infodict
ADD_PORT
Parameters:
NameTypeDefault valueDescription
namestr
portPortType
CREATE_PORT

Creates a port.

Parameters:
NameTypeDefault valueDescription
namestr Name of the port
resource_specIOSpec
Return type:
PortType
GET_PORT

Returns the resources of all the ports.

Parameters:
NameTypeDefault valueDescription
port_namestr
Return type:
PortType
GET_PORT_NAMES

Returns the names of all the ports.

Return type:
List
GET_RESOURCE_MODEL

Get the resource_model of a port

Parameters:
NameTypeDefault valueDescription
port_namestr
Return type:
ResourceModel
GET_RESOURCE_MODELS

Get the resource_model of a port

Return type:
Dict
GET_RESOURCES

Returns the resources of all the ports to be used for the input of a task.

Parameters:
NameTypeDefault valueDescription
new_instancebool False
Return type:
Dict
GET_SPECS

Returns the specs of all the ports.

Return type:
IOSpecs
GET_SPECS_AS_DICT
Return type:
dict
HAS_RESOURCE_MODEL

return true if one of the ports contain the resource model

Parameters:
NameTypeDefault valueDescription
resource_model_idstr
Return type:
bool
PORT_EXISTS
Parameters:
NameTypeDefault valueDescription
namestr
Return type:
bool
REMOVE_PORT
Parameters:
NameTypeDefault valueDescription
port_namestr
RESET
SET_RESOURCE_MODEL

Set the resource_model of a port

Parameters:
NameTypeDefault valueDescription
port_namestr
resource_modelResourceModel
TO_DTO
Return type:
IODTO
TO_JSON
Return type:
dict
UPDATE_PORT

Update a port.

Parameters:
NameTypeDefault valueDescription
namestr Name of the port
resource_specIOSpec
Return type:
PortType
CLASSNAME - @classmethod

Returns the name of the class

Parameters:
NameTypeDefault valueDescription
slugifybool False True to slugify the class name if true, defaults to false , optional
snakefybool False True to snakefy the class name if true, defaults to false , optional
replace_uppercasebool False Replace upper cases by "-" if true, defaults to false , optional
Return type:
str
DECORATED_METHOD_NAMES - @classmethod
Parameters:
NameTypeDefault valueDescription
decorator_nameAny
FULL_CLASSNAME - @classmethod

Returns the full name of the class

Parameters:
NameTypeDefault valueDescription
slugifybool False Slugify the returned class name if true, defaults to false , optional
snakefybool False Snakefy the returned class name if true, defaults to false ``
Return type:
str
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:
List
LOAD_FROM_DTO - @classmethod
Parameters:
NameTypeDefault valueDescription
io_dtoIODTO
Return type:
IO
LOAD_FROM_JSON - @classmethod
Parameters:
NameTypeDefault valueDescription
io_jsondict
Return type:
IO
LOAD_FROM_SPECS - @classmethod
Parameters:
NameTypeDefault valueDescription
specsIOSpecs
Return type:
IO
METHOD_NAMES - @classmethod

Returns the list of the methods

Return type:
List
MODULE_NAME - @classmethod

Returns the module name of the class

Return type:
str
PROPERTY_METHOD_NAMES - @classmethod
PROPERTY_NAMES - @classmethod

Retrieves the property names

Parameters:
NameTypeDefault valueDescription
instancetype The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]`
excludetype
Return type:
List