IO - gws_core - Community

Base IO class. The IO class defines base functionalitie for the Input and Output classes. A IO is a set of ports.

Functions

__INIT__

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

Parameters:

Name	Type	Default value	Description
type_	`Literal`	normal
additional_info	`dict`

ADD_PORT

Parameters:

Name	Type	Default value	Description
name	`str`
port	`PortType`

CREATE_PORT

Creates a port.

Parameters:

Name	Type	Default value	Description
name	`str`		Name of the port
resource_spec	`IOSpec`

Return type:

PortType

GET_PORT

Returns the resources of all the ports.

Parameters:

Name	Type	Default value	Description
port_name	`str`

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:

Name	Type	Default value	Description
port_name	`str`

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:

Name	Type	Default value	Description
new_instance	`bool`	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

summary return true if one of the ports contain the resource model

Parameters:

Name	Type	Default value	Description
resource_model_id	`str`		Resource model id to check
include_sub_resouces	`bool`	False	If true, it also check if provided resource is inside resourcelistbase, defaults to false , optional

Return type:

bool

PORT_EXISTS

Parameters:

Name	Type	Default value	Description
name	`str`

Return type:

bool

REMOVE_PORT

Parameters:

Name	Type	Default value	Description
port_name	`str`

RESET

SET_RESOURCE_MODEL

Set the resource_model of a port

Parameters:

Name	Type	Default value	Description
port_name	`str`
resource_model	`ResourceModel`

TO_DTO

Return type:

IODTO

TO_JSON

Return type:

dict

UPDATE_PORT

Update a port.

Parameters:

Name	Type	Default value	Description
name	`str`		Name of the port
resource_spec	`IOSpec`

Return type:

PortType

CLASSNAME - @classmethod

Returns the name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	True to slugify the class name if true, defaults to false , optional
snakefy	`bool`	False	True to snakefy the class name if true, defaults to false , optional
replace_uppercase	`bool`	False	Replace upper cases by "-" if true, defaults to false , optional

Return type:

str

DECORATED_METHOD_NAMES - @classmethod

Parameters:

Name	Type	Default value	Description
decorator_name	`Any`

FULL_CLASSNAME - @classmethod

Returns the full name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	Slugify the returned class name if true, defaults to false , optional
snakefy	`bool`	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:

Name	Type	Default value	Description
io_dto	`IODTO`

Return type:

IOType

LOAD_FROM_JSON - @classmethod

Parameters:

Name	Type	Default value	Description
io_json	`dict`

Return type:

IOType

LOAD_FROM_SPECS - @classmethod

Parameters:

Name	Type	Default value	Description
specs	`IOSpecs`

Return type:

IOType

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:

Name	Type	Default value	Description
instance	`type`		The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]`
exclude	`type`

Return type:

List