datawork.api.config

Basic Option and Config functionality.

class datawork.api.config.Config(options)

A ‘Config’ is a collection of ‘Option’s.

__init__(options)

Construct a Config with given list of ‘Option’s.

__setattr__(name, val)

Overload setattr to only allow setting of listed options.

__str__()

Convert to string by listing all options.

get_hash()

Return hash of the dictionary representation of this ‘Config’.

parents()

Return empty list of parents.

to_dict()

Convert to dictionary to prepare for JSON conversion.

class datawork.api.config.Configurable

A Configurable class contains a ‘Config’ attribute called ‘.config’.

__init__()

Set a default .config using the class attribute ‘.OPTIONS’.

parents()

Return .config as the only parent.

class datawork.api.config.Option(desc=None, name=None, required=False, default=None)

An Option is a JSON serializable argument to a function.

__init__(desc=None, name=None, required=False, default=None)

Construct an ‘Option’ with name, default value, and description.

__str__()

Show value and name for this Option.

add_argument(parser)

Add an argument to an argparse ‘ArgumentParser’.

get_value()

Get the set value or raise a ValueError.

set_value(value)

Implement a guarded setter for this Option type.

value

Get the set value or raise a ValueError.