ParamSet. Use to define a group of parameters that can be added multiple times. This will provid a list of dictionary as values : List[Dict[str, Any]]
Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: Optionaldefault_value: Optionalhuman_name: Optionalmax_number_of_occurrences: intoptional: boolparam_set: Dictshort_description: Optionalvisibility: LiteralFunctions
__init__
param_set :
Dict optional :
bool - False It true, the param_set can have 0 occurence, the value will then be an empty array [].
visibility :
Literal - public Visibility of the param. It override all child spec visibility. see doc on type ParamSpecVisibilty for more info
human_name :
Optional Human readable name of the param, showed in the interface
short_description :
Optional Description of the param, showed in the interface
max_number_of_occurrences :
int - -1 Nb max of occurence of values the params. If negative, there is no limit.
build
Method call before the value is used (in task or view) to apply some transformation if needed by the ParamSpec. This does not affect the value in the database.
value :
Any Return type :
Any get_default_value
Return type :
ParamSpecType to_dto
Return type :
ParamSpecDTO to_simple_dto
Return type :
ParamSpecSimpleDTO validate
Validate the value of the param and return the modified value if needed. This method is called when the param is set in the config before saving it in the database. The returned value must be serializable in json.l
value :
List Return type :
ParamSpecType empty @classmethod
Return type :
ParamSpec get_additional_infos @classmethod
Return type :
Dict get_default_value_param_spec @classmethod
Return type :
ParamSet get_str_type @classmethod
Return type :
ParamSpecTypeStr load_from_dto @classmethod
spec_dto :
ParamSpecDTO Return type :
ParamSet to_param_spec_info_specs @classmethod
Return type :
ParamSpecInfoSpecs