class params_proto.v2.proto.Proto Source ↗

Proto(default = None, help = None, dtype = None, metavar = '\x08', env = None, strict_parsing = False, **kwargs)

Bases: SimpleNamespace

Parameters

Parameter	Type / default	Description
`default`	`—` = None	—
`help`	`—` = None	—
`dtype`	`—` = None	—
`metavar`	`—` = '\x08'	—
`env`	`—` = None	the environment variable for the default value -- in the next version could be set automatically from the prefix of the class.
`strict_parsing`	`—` = False	default to False, when true raises error for env var that are not set. this is passed onto the expandvars function as nounset.
`**kwargs`	`—` variadic	—

Attributes

Name	Type / value	Description
`default`	`None`	—
`help`	`None`	—
`dtype`	`None`	—

#### `Proto.__init__`

method params_proto.v2.proto.Proto.__init__ Source ↗

Proto.__init__(default = None, help = None, dtype = None, metavar = '\x08', env = None, strict_parsing = False, **kwargs)

The proto object. The env attribute allows one to set the environment variable from which this proto reads value from.

Parameters

Parameter	Type / default	Description
`default`	`—` = None	—
`help`	`—` = None	—
`dtype`	`—` = None	—
`metavar`	`—` = '\x08'	—
`env`	`—` = None	the environment variable for the default value -- in the next version could be set automatically from the prefix of the class.
`strict_parsing`	`—` = False	default to False, when true raises error for env var that are not set. this is passed onto the expandvars function as nounset.
`**kwargs`	`—` variadic	—

#### `Proto.value`

property params_proto.v2.proto.Proto.value Source ↗

Proto.value

Writable property

### `Flag`

class params_proto.v2.proto.Flag Source ↗

Flag(help = None, to_value = True, default = None, dtype = None, **kwargs)

Bases: Proto

Parameters

Parameter	Type / default	Description
`help`	`—` = None	—
`to_value`	`—` = True	—
`default`	`—` = None	—
`dtype`	`—` = None	—
`**kwargs`	`—` variadic	—

Inherited members

- `default` — from [`params_proto.v2.proto.Proto`](/reference/compatibility/v2-configuration#params_proto.v2.proto--proto) - `help` — from [`params_proto.v2.proto.Proto`](/reference/compatibility/v2-configuration#params_proto.v2.proto--proto) - `dtype` — from [`params_proto.v2.proto.Proto`](/reference/compatibility/v2-configuration#params_proto.v2.proto--proto) - `value` — from [`params_proto.v2.proto.Proto`](/reference/compatibility/v2-configuration#params_proto.v2.proto--proto)

#### `Flag.__init__`

method params_proto.v2.proto.Flag.__init__ Source ↗

Flag.__init__(help = None, to_value = True, default = None, dtype = None, **kwargs)

Parameters

Parameter	Type / default	Description
`help`	`—` = None	—
`to_value`	`—` = True	—
`default`	`—` = None	—
`dtype`	`—` = None	—
`**kwargs`	`—` variadic	—

### `Accumulant`

class params_proto.v2.proto.Accumulant Source ↗

Accumulant(*args, **kwargs)

Bases: Proto

used by neo_hyper to avoid reset.

Parameters

Parameter	Type / default	Description
`*args`	`—` variadic	—
`**kwargs`	`—` variadic	—

Attributes

Name	Type / value	Description
`accumulant`	`True`	—

Inherited members

#### `Accumulant.__init__`

method params_proto.v2.proto.Accumulant.__init__ Source ↗

Accumulant.__init__(*args, **kwargs)

Parameters

Parameter	Type / default	Description
`*args`	`—` variadic	—
`**kwargs`	`—` variadic	—

### `StrType`

class params_proto.v2.proto.StrType Source ↗

class StrType(type)

Bases: type

Attributes

Name	Type / value	Description
`thunk`	`None`	—
`help`	`None`	—

### `Eval`

class params_proto.v2.proto.Eval Source ↗

Eval(default, help = None, **kwargs)

Bases: Proto

Parameters

Parameter	Type / default	Description
`default`	`—` required	—
`help`	`—` = None	—
`**kwargs`	`—` variadic	—

Attributes

Name	Type / value	Description
`thunk`	`None`	—

Inherited members

#### `Eval.__init__`

method params_proto.v2.proto.Eval.__init__ Source ↗

Eval.__init__(default, help = None, **kwargs)

Parameters

Parameter	Type / default	Description
`default`	`—` required	—
`help`	`—` = None	—
`**kwargs`	`—` variadic	—

### `is_private`

function params_proto.v2.proto.is_private Source ↗

is_private(k: str) → bool

Filter Private Attributes. Returns True if key equals "_prefix", or starts with "__" or "_<ParentClass>_"

Parameters

Parameter	Type / default	Description
`k`	`str` required	<str> the key to be tested.

Returns

bool

### `get_children`

function params_proto.v2.proto.get_children Source ↗

get_children(__init__)

decorator to parse the dependencies into current scope, using the cls._prefix attribute of the namespace. Allows one to use _prefix to override to original class._prefix

Parameters

Parameter	Type / default	Description
`__init__`	`—` required	—

### `Meta`

class params_proto.v2.proto.Meta Source ↗

Meta(name, bases, namespace, cli = True, cli_parse = True, **kwargs)

Bases: type

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`bases`	`—` required	—
`namespace`	`—` required	—
`cli`	`—` = True	—
`cli_parse`	`—` = True	—
`**kwargs`	`—` variadic	—

#### `Meta.__init__`

method params_proto.v2.proto.Meta.__init__ Source ↗

Meta.__init__(name, bases, namespace, cli = True, cli_parse = True, **kwargs)

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`bases`	`—` required	—
`namespace`	`—` required	—
`cli`	`—` = True	—
`cli_parse`	`—` = True	—
`**kwargs`	`—` variadic	—

### `ArgFactory`

class params_proto.v2.proto.ArgFactory Source ↗

ArgFactory()

The reason we do not inherit from argparse, is because the argument group returns new instances, so unless we patch those classes as well, we will not be able to intercept these calls. (I tried that first.) For this reason we implement this as a funciton, with a stateful context.

Attributes

Name	Type / value	Description
`groups`	`defaultdict(lambda: None)`	—
`last_group`	`None`	—
`clear`	`__init__`	—

#### `ArgFactory.__init__`

method params_proto.v2.proto.ArgFactory.__init__ Source ↗

ArgFactory.__init__()

#### `ArgFactory.add_argument`

method params_proto.v2.proto.ArgFactory.add_argument Source ↗

ArgFactory.add_argument(proto, key, *name_or_flags, _argument_group = None, default = None, dtype = None, to_value = None, **kwargs)

Parameters

Parameter	Type / default	Description
`proto`	`—` required	—
`key`	`—` required	—
`*name_or_flags`	`—` variadic	—
`_argument_group`	`—` = None	Keyword-only parameter.
`default`	`—` = None	Keyword-only parameter.
`dtype`	`—` = None	Keyword-only parameter.
`to_value`	`—` = None	Keyword-only parameter.
`**kwargs`	`—` variadic	—

#### `ArgFactory.add_argument_group`

method params_proto.v2.proto.ArgFactory.add_argument_group Source ↗

ArgFactory.add_argument_group(name, description)

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`description`	`—` required	—

#### `ArgFactory.parse_args`

method params_proto.v2.proto.ArgFactory.parse_args Source ↗

ArgFactory.parse_args(*args)

Parameters

Parameter	Type / default	Description
`*args`	`—` variadic	—

### `ParamsProto`

class params_proto.v2.proto.ParamsProto Source ↗

ParamsProto(_deps = None, _prefix = None, **children)

Bases: Bear

Parameters

Parameter	Type / default	Description
`_deps`	`—` = None	—
`_prefix`	`—` = None	—
`**children`	`—` variadic	—

#### `ParamsProto.__init__`

method params_proto.v2.proto.ParamsProto.__init__ Source ↗

ParamsProto.__init__(_deps = None, _prefix = None, **children)

default init function, called after __new__.

Parameters

Parameter	Type / default	Description
`_deps`	`—` = None	—
`_prefix`	`—` = None	—
`**children`	`—` variadic	—

### `find_ancestors`

function params_proto.v2.proto.find_ancestors Source ↗

find_ancestors(cls)

Find all ancestors of a class. Returns:

Parameters

Parameter	Type / default	Description
`cls`	`—` required	—

### `PrefixProto`

class params_proto.v2.proto.PrefixProto Source ↗

class PrefixProto(ParamsProto)

Bases: ParamsProto

A ParamsProto class with prefix set to True. Since we override the __init_subclass__ method, the returned classes instance is still a ParamsProto class. NOT a PrefixProto class.

Inherited members

- `__init__` — from [`params_proto.v2.proto.ParamsProto`](/reference/compatibility/v2-configuration#params_proto.v2.proto--paramsproto)

### `is_subclass`

function params_proto.v2.proto.is_subclass Source ↗

is_subclass(cls, *, ancestors = (ParamsProto, PrefixProto), extra = tuple())

Parameters

Parameter	Type / default	Description
`cls`	`—` required	—
`ancestors`	`—` = (ParamsProto, PrefixProto)	Keyword-only parameter.
`extra`	`—` = tuple()	Keyword-only parameter.

### `is_base_class`

function params_proto.v2.proto.is_base_class Source ↗

is_base_class(cls, extra = tuple())

Check if a class is a base class of ParamsProto. Returns:

Parameters

Parameter	Type / default	Description
`cls`	`—` required	—
`extra`	`—` = tuple()	—

### `update`

function params_proto.v2.proto.update Source ↗

update(Config: Union[type, Meta, ParamsProto], override)

Update a ParamsProto namespace, or instance by the override dictionary. Note the dictionary is dot.separated dot-keys are not yet implemented. Returns:

Parameters

Parameter	Type / default	Description
`Config`	`Union[type, Meta, ParamsProto]` required	—
`override`	`—` required	—

### `ARGS`

callable singleton params_proto.v2.proto.ARGS Source ↗

ARGS = ArgFactory()

Attributes

Name	Type / value	Description
`groups`	`defaultdict(lambda: None)`	—
`last_group`	`None`	—
`clear`	`__init__`	—

#### `ARGS.__init__`

method params_proto.v2.proto.ARGS.__init__ Source ↗

ARGS.__init__()

#### `ARGS.add_argument`

method params_proto.v2.proto.ARGS.add_argument Source ↗

ARGS.add_argument(proto, key, *name_or_flags, _argument_group = None, default = None, dtype = None, to_value = None, **kwargs)

Parameters

Parameter	Type / default	Description
`proto`	`—` required	—
`key`	`—` required	—
`*name_or_flags`	`—` variadic	—
`_argument_group`	`—` = None	Keyword-only parameter.
`default`	`—` = None	Keyword-only parameter.
`dtype`	`—` = None	Keyword-only parameter.
`to_value`	`—` = None	Keyword-only parameter.
`**kwargs`	`—` variadic	—

#### `ARGS.add_argument_group`

method params_proto.v2.proto.ARGS.add_argument_group Source ↗

ARGS.add_argument_group(name, description)

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`description`	`—` required	—

#### `ARGS.parse_args`

method params_proto.v2.proto.ARGS.parse_args Source ↗

ARGS.parse_args(*args)

Parameters

Parameter	Type / default	Description
`*args`	`—` variadic	—

### Public imports These symbols are available from this module. Their definitions are documented in the linked modules. - [`all_available`](/reference/environment#params_proto.parse_env_template--all_available) — `params_proto.parse_env_template.all_available` - [`dot_to_deps`](/reference/compatibility/v2-helpers#params_proto.v2.utils--dot_to_deps) — `params_proto.v2.utils.dot_to_deps`