Process
Base class
Functions
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 |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| decorator_name | Any |
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 |
Returns the name of the first compatible input for the given resource types Returns None if no compatible input is found
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_types | List |
Return type:
bool |
Returns the name of the first compatible output for the given resource types Returns None if no compatible output is found
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_types | List |
Return type:
bool |
Get the human name of the resource
Return type:
str |
Returns the input specs of the process
Return type:
InputSpecs |
Returns the input specs of the process
Return type:
OutputSpecs |
Get the short description of the resource
Return type:
str |
Get the typing name of the resource
Return type:
str |
Get all the classes that inherit this class
Return type:
List |
Returns the list of the methods
Return type:
List |
Returns the module name of the class
Return type:
str |
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 |