Login
Back to bricks list
Introduction Version

ProcessModel

Base abstract class for Process and Protocol

:param Viewable: [description] :type Viewable: [type]

Attributes

config: Configdata: Dict[str, Any]error_info: ProcessErrorInfoexperiment: Experimentprogress_bar: ProgressBarstatus: ProcessStatusstyle: TypingStyle

Functions

__INIT__

Constructor

ARCHIVE
CHECK_IS_UPDATABLE
Parameters:
NameTypeDefault valueDescription
error_if_finishedbool True
CLONE
COERCE
Parameters:
NameTypeDefault valueDescription
_coercebool True
DELETE_INSTANCE
DEPENDENCIES
Parameters:
NameTypeDefault valueDescription
search_nullablebool False
GET_ERROR_INFO
Return type:
Optional[ProcessErrorInfo]
GET_EXECUTION_TIME

Return the execution time of the process

Return type:
float
GET_ID
GET_INSTANCE_NAME_CONTEXT

return the instance name in the context

Return type:
str
GET_LAST_MESSAGE

Return the last message of the process

Return type:
Optional[ProgressBarMessageDTO]
GET_NAME

Return the name of the process

Return type:
str
GET_PROCESS_TYPE
Return type:
Type[Process]
GET_PROCESS_TYPING
Return type:
Typing
GET_PROGRESS_VALUE

Return the last message of the process

Return type:
float
IN_PORT

Returns the port of the inputs by its name.

Parameters:
NameTypeDefault valueDescription
port_namestr
Return type:
InPort
IS_ALIAS
IS_AUTO_RUN

Return true if the process is of type Source

Return type:
bool
IS_DIRTY
IS_PROTOCOL
Return type:
bool
IS_SAVED

Returns True if the model is saved in db, False otherwise

Return type:
bool
IS_SINK_TASK

return true if the process is of type Sink

Return type:
bool
IS_SOURCE_TASK

return true if the process is of type Source

Return type:
bool
MARK_AS_ERROR
Parameters:
NameTypeDefault valueDescription
error_infoProcessErrorInfo
MARK_AS_ERROR_AND_PARENT
Parameters:
NameTypeDefault valueDescription
process_errorProcessRunException
contextstr
MARK_AS_STARTED
MARK_AS_SUCCESS
MARK_AS_WAITING_FOR_CLI_PROCESS
OUT_PORT

Returns the port of the outputs by its name.

Parameters:
NameTypeDefault valueDescription
port_namestr
Return type:
OutPort
REFRESH
Return type:
ModelType
RESET
RUN

Run the process and save its state in the database.

SAVE

Override save to save the inputs and outputs

Return type:
'ProcessModel'
SAVE_FULL

Function to run overrided by the sub classes

Return type:
'ProcessModel'
SET_ERROR_INFO
Parameters:
NameTypeDefault valueDescription
error_infoProcessErrorInfo
SET_EXPERIMENT
Parameters:
NameTypeDefault valueDescription
experimentExperiment
SET_PARENT_PROTOCOL

Sets the parent protocol of the process

Parameters:
NameTypeDefault valueDescription
parent_protocolProtocolModel
SET_PROCESS_TYPE
Parameters:
NameTypeDefault valueDescription
process_typeType[Process]
TO_CONFIG_DTO

Return the config DTO

Parameters:
NameTypeDefault valueDescription
ignore_source_configbool False If true, the config values of source task is ignored, defaults to false , optional
Return type:
ProcessConfigDTO
TO_DTO
Return type:
ProcessDTO
TO_MINIMUM_DTO

Return the minium json to recognize this process

Return type:
ProcessMinimumDTO
UNWRAP
ADD_INDEX - @classmethod
Parameters:
NameTypeDefault valueDescription
fieldsAny
AFTER_ALL_TABLES_INIT - @classmethod

Method call after all the table are inited

Useful when use DeferredForeignKey to create the foreign key manually latter

AFTER_TABLE_CREATION - @classmethod

Method call after the table is created

Usefull to create the full text indexes

ALIAS - @classmethod
Parameters:
NameTypeDefault valueDescription
aliasAny
BIND - @classmethod
Parameters:
NameTypeDefault valueDescription
databaseAny
bind_refsbool True
bind_backrefsbool True
_excludeAny
BIND_CTX - @classmethod
Parameters:
NameTypeDefault valueDescription
databaseAny
bind_refsbool True
bind_backrefsbool True
BULK_CREATE - @classmethod
Parameters:
NameTypeDefault valueDescription
model_listAny
batch_sizeAny
BULK_UPDATE - @classmethod
Parameters:
NameTypeDefault valueDescription
model_listAny
fieldsAny
batch_sizeAny
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
COLUMN_EXISTS - @classmethod

Returns True if the column exists in the table

Parameters:
NameTypeDefault valueDescription
column_namestr The column name ``
Return type:
bool
CREATE - @classmethod
Parameters:
NameTypeDefault valueDescription
queryAny
CREATE_FOREIGN_KEY_IF_NOT_EXIST - @classmethod

Create a foreign key for a Foreign key field only if the foreign key does not exists

Parameters:
NameTypeDefault valueDescription
fieldForeignKeyField [description]
CREATE_FULL_TEXT_INDEX - @classmethod

Method to create a full text index

Parameters:
NameTypeDefault valueDescription
columnsList [description] [str]
index_namestr
CREATE_TABLE - @classmethod

Create model table

DECORATED_METHOD_NAMES - @classmethod
Parameters:
NameTypeDefault valueDescription
decorator_nameAny
DELETE - @classmethod
DELETE_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
pkAny
DROP_TABLE - @classmethod

Drop model table

FILTER - @classmethod
Parameters:
NameTypeDefault valueDescription
dq_nodesAny
filtersAny
FOREIGN_KEY_EXISTS - @classmethod
Parameters:
NameTypeDefault valueDescription
column_namestr
Return type:
bool
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 - @classmethod
Parameters:
NameTypeDefault valueDescription
queryAny
filtersAny
GET_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Optional
GET_BY_ID_AND_CHECK - @classmethod

Get by ID and throw 404 error if object not found

Parameters:
NameTypeDefault valueDescription
idstr [description]
Return type:
ModelType
GET_BY_IDS - @classmethod
Parameters:
NameTypeDefault valueDescription
idsList
Return type:
List
GET_DB - @classmethod
Return type:
DatabaseProxy
GET_DB_MANAGER - @classmethod

Returns the (current) DbManager of this model

Return type:
Type
GET_OR_CREATE - @classmethod
GET_OR_NONE - @classmethod
Parameters:
NameTypeDefault valueDescription
queryAny
filtersAny
GET_TABLE_NAME - @classmethod

Returns the table name of this class

Return type:
str
INDEX - @classmethod
Parameters:
NameTypeDefault valueDescription
fieldsAny
INDEX_EXISTS - @classmethod

Returns True if the index exists in the table

Parameters:
NameTypeDefault valueDescription
index_namestr The index name ``
Return type:
bool
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:
List
INSERT - @classmethod
Parameters:
NameTypeDefault valueDescription
_Model__dataAny
insertAny
INSERT_FROM - @classmethod
Parameters:
NameTypeDefault valueDescription
queryAny
fieldsAny
INSERT_MANY - @classmethod
Parameters:
NameTypeDefault valueDescription
rowsAny
fieldsAny
IS_MYSQL_ENGINE - @classmethod
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
NOOP - @classmethod
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
RAW - @classmethod
Parameters:
NameTypeDefault valueDescription
sqlAny
paramsAny
REPLACE - @classmethod
Parameters:
NameTypeDefault valueDescription
_Model__dataAny
insertAny
REPLACE_MANY - @classmethod
Parameters:
NameTypeDefault valueDescription
rowsAny
fieldsAny
SAVE_ALL - @classmethod
SELECT - @classmethod
Parameters:
NameTypeDefault valueDescription
fieldsAny
SET_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
keyAny
valueAny
TABLE_EXISTS - @classmethod
TRUNCATE_TABLE - @classmethod
Parameters:
NameTypeDefault valueDescription
optionsAny
UPDATE - @classmethod
Parameters:
NameTypeDefault valueDescription
_Model__dataAny
updateAny
VALIDATE_MODEL - @classmethod
COPY - @staticmethod
Parameters:
NameTypeDefault valueDescription
methodAny