TableRowSelector - gws_core

Select part of a table using row names. Multiple row names can be provided.

It also supports regexp.

Attributes

config_specs: Dictfile_downloader: FileDownloaderinput_name: strinput_specs: InputSpecsmessage_dispatcher: MessageDispatcheroutput_name: stroutput_specs: OutputSpecsstyle: TypingStyle

Functions

__INIT__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters

CHECK_BEFORE_RUN

This can be overwritten to perform custom check before running task. See doc of CheckBeforeTaskResult for more information

Parameters:

Name	Type	Default value	Description
params	`ConfigParams`
inputs	`TaskInputs`

Return type:

CheckBeforeTaskResult

CONVERT

Override this method to implement convert method

Parameters:

Name	Type	Description
source	`Resource`
params	`ConfigParams`	[description]
target_type	`Type`	[description] [resource]

Return type:

Resource

CREATE_TMP_DIR

Create a temporary directory. This directory will be deleted after the task is run. Output file or folder are moved out of this directory before it is deleted.

Return type:

str

GET_DEFAULT_OUTPUT_SPEC_TYPE

Parameters:

Name	Type	Default value	Description
spec_name	`str`

Return type:

Type

GET_SCENARIO_ID

Return type:

str

GET_TASK_ID

Return type:

str

INIT

This can be overwritten to perform custom initialization of the task. This method is called just after the init and before the check_before_run method

LOG_DEBUG_MESSAGE

Parameters:

Name	Type	Default value	Description
message	`str`

LOG_ERROR_MESSAGE

Parameters:

Name	Type	Default value	Description
message	`str`

LOG_INFO_MESSAGE

Parameters:

Name	Type	Default value	Description
message	`str`

LOG_MESSAGE

Store a message in the progress

Parameters:

Name	Type	Default value	Description
message	`str`		Message to store in the progress
type_	`MessageLevel`

LOG_SUCCESS_MESSAGE

Parameters:

Name	Type	Default value	Description
message	`str`

LOG_WARNING_MESSAGE

Parameters:

Name	Type	Default value	Description
message	`str`

RUN

This must be overiwritten to perform the task of the task.

This is where most of your code must go

Parameters:

Name	Type	Default value	Description
params	`ConfigParams`		[description] config
inputs	`TaskInputs`		[description] input

Return type:

Dict

RUN_AFTER_TASK

This can be overwritten to perform action after the task run. This method is called after the resources are saved. This method is useful to delete temporary objects (like files) to clear the server after the task is run.

TRANSFORM

Override this method to write the Transformer code

Parameters:

Name	Type	Default value	Description
source	`Table`		Resource to modifify, the source object can be directly modify as this is already a new copy resource
params	`ConfigParams`		Params for the transform

Return type:

Table

UPDATE_PROGRESS_VALUE

Update the progress value

Parameters:

Name	Type	Default value	Description
value	`float`		Value between 0 and 100 of the progress
message	`str`		If provided a message is stored on the progress

CALL - @classmethod

Call the ResourceExporter method manually

Parameters:

Name	Type	Default value	Description
source	`Resource`
params	`Dict`		Params for the import_from_path_method configparams

Return type:

Resource

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

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

Return type:

str

GET_CONFIG_SPECS_DTO - @classmethod

Return type:

Dict

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

Get the type of the input source

Return type:

Tuple

GET_STYLE - @classmethod

Get the style of the resource

Return type:

TypingStyle

GET_TARGET_TYPE - @classmethod

Get the type of the output target

Return type:

Type

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