CTRL + K
Stories
Apps
Agents
Bricks
Constellab Space LogoSpace
Login

gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

TableColumnSelector

Select part of a table using column names. Multiple column 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

params : ConfigParams
inputs : TaskInputs
Return type : CheckBeforeTaskResult
convert

Override this method to implement convert method

source : Resource
params : ConfigParams
[description]
target_type : Type
[description]
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
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
message : str
log_error_message
message : str
log_info_message
message : str
log_message

Store a message in the progress

message : str
message to store in the progress
type_ : MessageLevel
log_success_message
message : str
log_warning_message
message : str
run

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

This is where most of your code must go

params : ConfigParams
[description]
inputs : TaskInputs
[description]
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

source : Table
resource to modifify, the source object can be directly modify as this is already a new copy
params : ConfigParams
params for the transform
Return type : Table
update_progress_value

Update the progress value

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

source : Resource
params : Dict
params for the import_from_path_method
Return type : Resource
classname @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
full_classname @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
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
has_visible_config_specs @classmethod
Return type : bool
inheritors @classmethod

Get all the classes that inherit this class

Return type : List