JsonCodeParam
Param for json code. It shows a simple json IDE in the interface to provide code for json. The value of this param is a dict.
It can also handle comments in the JSON code. It supports only single-line comments. Valid example: { // This is a comment "key": "value" }
Unvalid example: { /* This is a comment */ "key": "value" }
Unvalid example: { "key": "value" // This is a comment }
:param ParamSpec: description :type ParamSpec: type
Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: Optionaldefault_value: Optionalhuman_name: Optionaloptional: boolshort_description: Optionalvisibility: LiteralFunctions
__init__
default_value :
Optional Default value, if None, and optional is false, the config is mandatory
If a value is provided there is no need to set the optional
Setting optional to True, allows default None value
optional :
bool - False See default value
visibility :
Literal - public Visibility of the param, 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
build
Validate the json code.
value :
Any The value of the param
Return type :
dict get_default_value
Return type :
Any 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.
value :
Any Return type :
Any empty @classmethod
Return type :
ParamSpec get_additional_infos @classmethod
Return type :
Dict get_default_value_param_spec @classmethod
Return type :
JsonCodeParam get_str_type @classmethod
Return type :
ParamSpecTypeStr load_from_dto @classmethod
spec_dto :
ParamSpecDTO Return type :
ParamSpec to_param_spec_info_specs @classmethod
Return type :
ParamSpecInfoSpecs