Back to bricks list
Introduction Version

Process

Base class

Functions

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
GET_COMPATIBLE_INPUT_NAME - @classmethod

Returns the name of the first compatible input for the given resource types Returns None if no compatible input is found

Parameters:
NameTypeDefault valueDescription
resource_typesList
Return type:
bool
GET_COMPATIBLE_OUTPUT_NAME - @classmethod

Returns the name of the first compatible output for the given resource types Returns None if no compatible output is found

Parameters:
NameTypeDefault valueDescription
resource_typesList
Return type:
bool
GET_HUMAN_NAME - @classmethod

Get the human name of the resource

Return type:
str
GET_INPUT_SPECS - @classmethod

Returns the input specs of the process

Return type:
InputSpecs
GET_OUTPUT_SPECS - @classmethod

Returns the input specs of the process

Return type:
OutputSpecs
GET_SHORT_DESCRIPTION - @classmethod

Get the short description of the resource

Return type:
str
GET_TYPING_NAME - @classmethod

Get the typing name of the resource

Return type:
str
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:
List
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