Back to bricks list

Research documentation

Introduction

Getting Started

Developer guide

Release

Architecture

CLI

Technical Documentation

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:

Name	Type	Default value	Description
error_if_finished	`bool`	True

CLONE

COERCE

Parameters:

Name	Type	Default value	Description
_coerce	`bool`	True

DELETE_INSTANCE

DEPENDENCIES

Parameters:

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

Return the instance path

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:

Name	Type	Default value	Description
port_name	`str`

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:

Name	Type	Default value	Description
error_info	`ProcessErrorInfo`

MARK_AS_ERROR_AND_PARENT

Parameters:

Name	Type	Default value	Description
process_error	`ProcessRunException`
context	`str`

MARK_AS_STARTED

MARK_AS_SUCCESS

MARK_AS_WAITING_FOR_CLI_PROCESS

OUT_PORT

Returns the port of the outputs by its name.

Parameters:

Name	Type	Default value	Description
port_name	`str`

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_CONFIG

Set the config object

Parameters:

Name	Type	Default value	Description
config	`Config`		[description] paramsdict

SET_CONFIG_VALUE

Set a value of the config

Parameters:

Name	Type	Default value	Description
param_name	`str`		[description]
value	`Any`		[description]

SET_CONFIG_VALUES

Set the config values

Parameters:

Name	Type	Default value	Description
config_values	`ConfigParamsDict`		[description] dict[str, any]

SET_ERROR_INFO

Parameters:

Name	Type	Default value	Description
error_info	`ProcessErrorInfo`

SET_EXPERIMENT

Parameters:

Name	Type	Default value	Description
experiment	`Experiment`

SET_INPUTS_FROM_DTO

Set the inputs from a DTO

Parameters:

Name	Type	Default value	Description
inputs_dto	`IODTO`
reset	`bool`	False

SET_INPUTS_FROM_SPECS

Set the inputs from specs

Parameters:

Name	Type	Default value	Description
inputs_specs	`IOSpecs`

SET_OUTPUTS_FROM_DTO

Set the outputs from a DTO

Parameters:

Name	Type	Default value	Description
outputs_dto	`IODTO`
reset	`bool`	False

SET_OUTPUTS_FROM_SPECS

Set the outputs from specs

Parameters:

Name	Type	Default value	Description
outputs_specs	`IOSpecs`

SET_PARENT_PROTOCOL

Sets the parent protocol of the process

Parameters:

Name	Type	Default value	Description
parent_protocol	`ProtocolModel`

SET_PROCESS_TYPE

Parameters:

Name	Type	Default value	Description
process_type	`Type[Process]`

TO_CONFIG_DTO

Return the config DTO

Parameters:

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

Name	Type	Default value	Description
fields	`Any`

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:

Name	Type	Default value	Description
alias	`Any`

BIND - @classmethod

Parameters:

Name	Type	Default value
database	`Any`
bind_refs	`bool`	True
bind_backrefs	`bool`	True
_exclude	`Any`

BIND_CTX - @classmethod

Parameters:

Name	Type	Default value
database	`Any`
bind_refs	`bool`	True
bind_backrefs	`bool`	True

BULK_CREATE - @classmethod

Parameters:

Name	Type	Default value	Description
model_list	`Any`
batch_size	`Any`

BULK_UPDATE - @classmethod

Parameters:

Name	Type	Default value	Description
model_list	`Any`
fields	`Any`
batch_size	`Any`

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

COLUMN_EXISTS - @classmethod

Returns True if the column exists in the table

Parameters:

Name	Type	Default value	Description
column_name	`str`		The column name ``

Return type:

bool

CREATE - @classmethod

Parameters:

Name	Type	Default value	Description
query	`Any`

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:

Name	Type	Default value	Description
field	`ForeignKeyField`		[description]

CREATE_FULL_TEXT_INDEX - @classmethod

Method to create a full text index

Parameters:

Name	Type	Default value	Description
columns	`List`		[description] [str]
index_name	`str`

CREATE_TABLE - @classmethod

Create model table

DECORATED_METHOD_NAMES - @classmethod

Parameters:

Name	Type	Default value	Description
decorator_name	`Any`

DELETE - @classmethod

DELETE_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
pk	`Any`

DROP_TABLE - @classmethod

Drop model table

FILTER - @classmethod

Parameters:

Name	Type	Default value	Description
dq_nodes	`Any`
filters	`Any`

FOREIGN_KEY_EXISTS - @classmethod

Parameters:

Name	Type	Default value	Description
column_name	`str`

Return type:

bool

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

GET - @classmethod

Parameters:

Name	Type	Default value	Description
query	`Any`
filters	`Any`

GET_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

Optional

GET_BY_ID_AND_CHECK - @classmethod

Get by ID and throw 404 error if object not found

Parameters:

Name	Type	Default value	Description
id	`str`		[description]

Return type:

ModelType

GET_BY_IDS - @classmethod

Parameters:

Name	Type	Default value	Description
ids	`List`

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:

Name	Type	Default value	Description
query	`Any`
filters	`Any`

GET_TABLE_NAME - @classmethod

Returns the table name of this class

Return type:

str

INDEX - @classmethod

Parameters:

Name	Type	Default value	Description
fields	`Any`

INDEX_EXISTS - @classmethod

Returns True if the index exists in the table

Parameters:

Name	Type	Default value	Description
index_name	`str`		The index name ``

Return type:

bool

INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:

List

INSERT - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
insert	`Any`

INSERT_FROM - @classmethod

Parameters:

Name	Type	Default value	Description
query	`Any`
fields	`Any`

INSERT_MANY - @classmethod

Parameters:

Name	Type	Default value	Description
rows	`Any`
fields	`Any`

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:

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

RAW - @classmethod

Parameters:

Name	Type	Default value	Description
sql	`Any`
params	`Any`

REPLACE - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
insert	`Any`

REPLACE_MANY - @classmethod

Parameters:

Name	Type	Default value	Description
rows	`Any`
fields	`Any`

SAVE_ALL - @classmethod

SEARCH - @classmethod

Performs full-text search on the field. Must be overrided by child class to work

Parameters:

Name	Type	Default value	Description
phrase	`str`		The phrase to search ``
modifier	`str`

Return type:

ModelSelect

SELECT - @classmethod

Parameters:

Name	Type	Default value	Description
fields	`Any`

SET_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
key	`Any`
value	`Any`

TABLE_EXISTS - @classmethod

TRUNCATE_TABLE - @classmethod

Parameters:

Name	Type	Default value	Description
options	`Any`

UPDATE - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
update	`Any`

VALIDATE_MODEL - @classmethod

COPY - @staticmethod

Parameters:

Name	Type	Default value	Description
method	`Any`

Stories

Live tasks

Bricks

Documentation

ProcessModel

Attributes

Functions