v1 · Configuration

Legacy v1 parameter declarations, flags, prefixes, and CLI decorators.

These compatibility APIs ship with the selected source version. See the compatibility overview for other v1/v2 APIs, or migration when upgrading.

API index

Name	Kind	Defined in
`is_hidden`	function	`params_proto.v1.params_proto`
`ParamsProto`	class	`params_proto.v1.params_proto`
`Proto`	function	`params_proto.v1.params_proto`
`BoolFlag`	function	`params_proto.v1.params_proto`
`prefix_proto`	function	`params_proto.v1.params_proto`
`cli_parse`	function	`params_proto.v1.params_proto`
`proto_signature`	function	`params_proto.v1.params_proto`
`proto_partial`	function	`params_proto.v1.params_proto`
`PREFIXES`	attribute	`params_proto.v1.params_proto`

params_proto.v1

Public imports

These symbols are available from this module. Their definitions are documented in the linked modules.

is_hidden — params_proto.v1.params_proto.is_hidden
ParamsProto — params_proto.v1.params_proto.ParamsProto
Proto — params_proto.v1.params_proto.Proto
BoolFlag — params_proto.v1.params_proto.BoolFlag
prefix_proto — params_proto.v1.params_proto.prefix_proto
cli_parse — params_proto.v1.params_proto.cli_parse
proto_signature — params_proto.v1.params_proto.proto_signature
proto_partial — params_proto.v1.params_proto.proto_partial
PREFIXES — params_proto.v1.params_proto.PREFIXES

params_proto.v1.params_proto

`is_hidden`

functionparams_proto.v1.params_proto.is_hiddenSource ↗

is_hidden(k: str) → bool

return True is method is hidden

Parameters

Parameter	Type / default	Description
`k`	`str` required	—

Returns

bool

`ParamsProto`

classparams_proto.v1.params_proto.ParamsProtoSource ↗

ParamsProto(proto, **d)

Bases: DefaultBear

Parameter ptype Class, has toDict method and proto attribute for the original namespace object.

Parameters

Parameter	Type / default	Description
`proto`	`—` required	—
`**d`	`—` variadic	—

`ParamsProto.init`

methodparams_proto.v1.params_proto.ParamsProto.__init__Source ↗

ParamsProto.__init__(proto, **d)

Parameters

Parameter	Type / default	Description
`proto`	`—` required	—
`**d`	`—` variadic	—

`Proto`

functionparams_proto.v1.params_proto.ProtoSource ↗

Proto(default: T, help = None, dtype = None, aliases = None, **kwargs) → T

Parameters

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

Returns

T

`BoolFlag`

functionparams_proto.v1.params_proto.BoolFlagSource ↗

BoolFlag(default: bool, help = None, aliases = None, **kwargs) → T

this one generates a boolean flag that requires no arguments.

The value of the flag is the opposite of the default. if default is True, then --bool-flag (such as --no-flag) would return False. if default is False, then (such as --render) would return True.

Parameters

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

Returns

T

`prefix_proto`

functionparams_proto.v1.params_proto.prefix_protoSource ↗

prefix_proto(prefix_or_fn: Union[str, None, Callable] = None, parse = False, **ext)

Parameters

Parameter	Type / default	Description
`prefix_or_fn`	`Union[str, None, Callable]` = None	—
`parse`	`—` = False	—
`**ext`	`—` variadic	—

`cli_parse`

functionparams_proto.v1.params_proto.cli_parseSource ↗

cli_parse(proto: T) → T

parser command line options, and repackage into a typed object.

Parameters

Parameter	Type / default	Description
`proto`	`T` required	T

Returns

T

`proto_signature`

functionparams_proto.v1.params_proto.proto_signatureSource ↗

proto_signature(parameter_prototype, need_self = False)

Parameters

Parameter	Type / default	Description
`parameter_prototype`	`—` required	—
`need_self`	`—` = False	—

`proto_partial`

functionparams_proto.v1.params_proto.proto_partialSource ↗

proto_partial(proto, method = False)

Overrides the function with values from the Proto Object.

Parameters

Parameter	Type / default	Description
`proto`	`—` required	—
`method`	`—` = False	—

`PREFIXES`

attributeparams_proto.v1.params_proto.PREFIXESSource ↗

PREFIXES = []