parameters#

Custom luigi parameters.

Classes:

SettingsParameter(**kwargs)

Parameter that parses the input of a CSVParameter into a dictionary Example:

MultiSettingsParameter(**kwargs)

Parameter that parses the input of a MultiCSVParameter into a double-dict structure.

class SettingsParameter(**kwargs)[source]#

Bases: CSVParameter

Parameter that parses the input of a CSVParameter into a dictionary Example:

p = SettingsParameter()

p.parse("param1=10,param2,param3=text,param4=false")
=> {"param1": 10.0, "param2": True, "param3": "text", "param4": False}

p.serialize({"param1": 2, "param2": False})
=> "param1=2,param2=False"

Attributes:

settings_delimiter

tuple_delimiter

Methods:

parse_setting(setting)

rtype:

tuple[str, float | bool | str]

parse_value(value)

serialize_setting(name, value)

rtype:

str

parse(inp)

serialize(value)

settings_delimiter = '='#
tuple_delimiter = ';'#
classmethod parse_setting(setting)[source]#
Return type:

tuple[str, float | bool | str]

classmethod parse_value(value)[source]#
classmethod serialize_setting(name, value)[source]#
Return type:

str

parse(inp)[source]#
serialize(value)[source]#
class MultiSettingsParameter(**kwargs)[source]#

Bases: MultiCSVParameter

Parameter that parses the input of a MultiCSVParameter into a double-dict structure. Example:

p = MultiSettingsParameter()

p.parse("obj1,k1=10,k2,k3=text:obj2,k4=false")
# => {"obj1": {"k1": 10.0, "k2": True, "k3": "text"}, "obj2": {"k4": False}}

p.serialize({"obj1": {"k1": "val"}, "obj2": {"k2": 2}})
# => "obj1,k1=val:obj2,k2=2"

Methods:

parse(inp)

serialize(value)

parse(inp)[source]#
serialize(value)[source]#