gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

ConfigParams

Config values send to the task

Functions
get_value

Returns the value of a parameter by its name.

This is different from get method. If the param doesn't exist or its value is None, it returns the default_value. It considers None as not defined. The get method only returns the default value if the param does not exists. It considers None as defined

param_name : str
default_value : Any
Return type : Any
save_params

Special method to update the config during the task run. The update is directly saved in the database /!\ To use with caution, only when you know what you are doing /!

set_config
config : Config
set_config_model_id
config_model_id : str
set_value

Set the value of a parameter by its name.

param_name : str
value : Any
The value of the parameter
value_is_set

Test if a parameter exists and is not none

param_name : str
Return type : bool
from_config @classmethod

Create a config params from a config

config : Config
Return type : ConfigParams