datawork.instances.config

Common instances of Option including most JSON types.

class datawork.instances.config.BoolOption(desc=None, name=None, required=False, default=None)[source]

A boolean option.

add_argument(parser)[source]

Add an argument with an action to an argparse ‘ArgumentParser’.

value_type

alias of builtins.bool

class datawork.instances.config.EnumOption(desc, choices=None, **kwargs)[source]

An enum option represents a choice from a finite list.

__init__(desc, choices=None, **kwargs)[source]

Construct option that records possible choices.

__str__()[source]

Format string that shows choices.

set_value(value)[source]

Restrict set values to choices.

value_type

alias of builtins.str

class datawork.instances.config.FloatOption(desc=None, name=None, required=False, default=None)[source]

A single float option.

value_type

alias of builtins.float

class datawork.instances.config.IntOption(desc=None, name=None, required=False, default=None)[source]

A single integer option.

value_type

alias of builtins.int

class datawork.instances.config.RandomSeedOption(desc=None, name=None, required=False, default=None)[source]

An IntOption subclass specifically for random seeds.

This class makes it a bit easier to detect random seeds in large pipelines, which should make studying variability due to controllable (RNG) randomness straightforward.

class datawork.instances.config.StringOption(desc=None, name=None, required=False, default=None)[source]

A string option.

value_type

alias of builtins.str