btwallet.config

btwallet.config#

Implementation of the config class, which manages the configuration of different Bittensor modules.

Attributes#

T

Exceptions#

InvalidConfigFile

In place of YAMLError

Classes#

Config

Implementation of the config class, which manages the configuration of different Bittensor modules.

DefaultConfig

A Config with a set of default values.

Module Contents#

exception btwallet.config.InvalidConfigFile#

Bases: Exception

In place of YAMLError

Initialize self. See help(type(self)) for accurate signature.

class btwallet.config.Config(parser=None, args=None, strict=False, default=None)#

Bases: munch.DefaultMunch

Implementation of the config class, which manages the configuration of different Bittensor modules.

Construct a new DefaultMunch. Like collections.defaultdict, the first argument is the default value; subsequent arguments are the same as those for dict.

Parameters:
__is_set: Dict[str, bool]#

Translates the passed parser into a nested Bittensor config.

Parameters:

  • parser (argparse.ArgumentParser) – Command line parser object.

  • strict (bool) – If true, the command line arguments are strictly parsed.

  • args (list of str) – Command line arguments.

  • default (Optional[Any]) – Default value for the Config. Defaults to None. This default will be returned for attributes that are undefined.

Returns:

Nested config object created from parser arguments.

Return type:

config (Config)

missing_required_args#
config_params#
strict#
params#
_config#
parser_no_defaults#
default_param_args#
default_params#
all_default_args#
defaults_as_suppress#
params_no_defaults#
static __split_params__(params, _config)#
Parameters:
static __parse_args__(args, parser=None, strict=False)#

Parses the passed args use the passed parser.

Parameters:

  • args (List[str]) – List of arguments to parse.

  • parser (argparse.ArgumentParser) – Command line parser object.

  • strict (bool) – If true, the command line arguments are strictly parsed.

Returns:

Namespace object created from parser arguments.

Return type:

Namespace

__deepcopy__(memo)#
Return type:

Config

__repr__()#

Invertible* string-form of a Munch.

>>> b = Munch(foo=Munch(lol=True), hello=42, ponies='are pretty!')
>>> print (repr(b))
Munch({'ponies': 'are pretty!', 'foo': Munch({'lol': True}), 'hello': 42})
>>> eval(repr(b))
Munch({'ponies': 'are pretty!', 'foo': Munch({'lol': True}), 'hello': 42})

>>> with_spaces = Munch({1: 2, 'a b': 9, 'c': Munch({'simple': 5})})
>>> print (repr(with_spaces))
Munch({'a b': 9, 1: 2, 'c': Munch({'simple': 5})})
>>> eval(repr(with_spaces))
Munch({'a b': 9, 1: 2, 'c': Munch({'simple': 5})})

(*) Invertible so long as collection contents are each repr-invertible.

Return type:

str

static _remove_private_keys(d)#
__str__()#

Return str(self).

Return type:

str

copy()#

D.copy() -> a shallow copy of D

Return type:

Config

to_string(items)#

Get string from items

Return type:

str

update_with_kwargs(kwargs)#

Add config to self

classmethod _merge(a, b)#

Merge two configurations recursively. If there is a conflict, the value from the second configuration will take precedence.

merge(b)#

Merges the current config with another config.

Parameters:

b – Another config to merge.

classmethod merge_all(configs)#

Merge all configs in the list into one config. If there is a conflict, the value from the last configuration in the list will take precedence.

Parameters:

configs (list of config) – List of configs to be merged.

Returns:

Merged config object.

Return type:

config

is_set(param_name)#

Returns a boolean indicating whether the parameter has been set or is still the default.

Parameters:

param_name (str)

Return type:

bool

__check_for_missing_required_args(parser, args)#
Parameters:
Return type:

List[str]

static __get_required_args_from_parser(parser)#
Parameters:

parser (argparse.ArgumentParser)

Return type:

List[str]

btwallet.config.T#
class btwallet.config.DefaultConfig(parser=None, args=None, strict=False, default=None)#

Bases: Config

A Config with a set of default values.

Construct a new DefaultMunch. Like collections.defaultdict, the first argument is the default value; subsequent arguments are the same as those for dict.

Parameters:
classmethod default()#
Abstractmethod:

Return type:

T

Get default config.

Contents