IO
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.
type_ :
Literal - normal additional_info :
dict add_port
name :
str port :
PortType create_port
Creates a port.
name :
str Name of the port
resource_spec :
IOSpec Return type :
PortType get_port
Returns the resources of all the ports.
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
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.
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
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
Return type :
bool port_exists
name :
str Return type :
bool remove_port
port_name :
str reset
set_resource_model
Set the resource_model of a port
port_name :
str resource_model :
ResourceModel to_dto
Return type :
IODTO to_json
Return type :
dict update_port
Update a port.
name :
str Name of the port
resource_spec :
IOSpec Return type :
PortType classname @classmethod
Returns the name of the class
slugify :
bool - False True to slugify the class name if True
snakefy :
bool - False True to snakefy the class name if True
replace_uppercase :
bool - False Replace upper cases by "-" if True
Return type :
str full_classname @classmethod
Returns the full name of the class
slugify :
bool - False Slugify the returned class name if True
snakefy :
bool - False Snakefy the returned class name if True
Return type :
str inheritors @classmethod
Get all the classes that inherit this class
Return type :
List load_from_dto @classmethod
io_dto :
IODTO Return type :
IOType load_from_json @classmethod
io_json :
dict Return type :
IOType load_from_specs @classmethod
specs :
IOSpecs Return type :
IOType