evargs package v1.0.0

EvArgs’s Module Index

Example code

from evargs import EvArgs

evargs = EvArgs()

evargs.initialize({
   'a': {'cast': int},
   'b': {'cast': str},
   'c': {'cast': int, 'list': True},
})

evargs.parse('a=1;b=abc;c=1,2,3;')

assert evargs.get('a') == 1
assert evargs.get('b') == 'abc'
assert evargs.get('c') == [1, 2, 3]

More example codes are here .

EvArgs class

class EvArgs(validator=None)

Bases: object

Initialize instance with default settings and an optional validator.

Parameters

validator (evargs.validator.Validator) –

get_validator()

Return Validator instance.

Return type

Validator

set_validator(validator)

Set Validator instance.

Parameters

validator (evargs.validator.Validator) –

get_type_cast()

Return TypeCast class.

Return type

Type[TypeCast]

set_type_cast(type_cast)

Set TypeCast class.

Parameters

type_cast (Type[evargs.type_cast.TypeCast]) –

get_help_formatter()

Return HelpFormatter instance.

Return type

HelpFormatter

set_help_formatter(help_formatter)

Set HelpFormatter instance.

Parameters

help_formatter (evargs.list_formatter.HelpFormatter) –

set_options(flexible=False, required_all=False, ignore_unknown=False)

Set options.

Parameters

  • flexible (bool) –

  • required_all (bool) –

  • ignore_unknown (bool) –

set_default_rule(default_rule)

Set the default rule.

Parameters

default_rule (dict) –

initialize(rules, default_rule=None, flexible=False, required_all=False, ignore_unknown=False)

Initialize rules and options for the instance.

Parameters

  • rules (Optional[dict]) –

  • default_rule (Optional[dict]) –

  • flexible (bool) –

  • required_all (bool) –

  • ignore_unknown (bool) –

set_rule(name, rule)

Set rule.

Parameters

  • name (str) –

  • rule (dict) –

set_rules(rules)

Set rules.

Parameters

rules (dict) –

make_kwargs(args, keys, kwargs=None)

Make kwargs from args.

Parameters

  • args (tuple) –

  • keys (list) –

  • kwargs (Optional[dict]) –

create_rule(cast: Union[str, callable] = None, required: bool = False, default: any = None, nullable: bool = True, trim: Union[bool, str] = None, validation: Union[str, list, tuple, callable] = None, choices: Union[list, tuple, Type[enum.Enum]] = None, pre_cast: callable = None, post_cast: callable = None, pre_apply: callable = None, post_apply: Union[callable, str, list, tuple] = None, raise_error: int = TypeCast.ERROR_DEFAULT_NONE, list: bool = False, multiple: bool = False, rule: dict = None) → dict
Return type

dict

assign(value: any, cast: Union[str, callable] = None, required: bool = False, default: any = None, nullable: bool = True, trim: Union[bool, str] = None, validation: Union[str, list, tuple, callable] = None, choices: Union[list, tuple, Type[enum.Enum]] = None, pre_cast: callable = None, post_cast: callable = None, pre_apply: callable = None, post_apply: callable = None, raise_error: int = TypeCast.ERROR_DEFAULT_NONE, list: bool = False, multiple: bool = False, rule: dict = None, name: str = None) → any
Return type

any

assign_values(values, rules, store=False)

Assign values by rule options.

Return type

dict

Parameters

  • values (dict) –

  • rules (dict) –

  • store (bool) –

get_rule(name=None, rule=None, rules=None)

Get a rule.

Return type

dict

Parameters

  • name (Optional[str]) –

  • rule (Optional[dict]) –

  • rules (Optional[dict]) –

get_rule_options(option, rules=None)

Get the rule’s option values.

Return type

dict

Parameters

  • option (str) –

  • rules (Optional[dict]) –

get(name, index=- 1)

Get a parameter value by name and index.

Return type

any

Parameters

  • name (str) –

  • index (int) –

get_values()

Get a dict of values.

Return type

dict

put(name, value, multiple_reset=False, keep_original=False)

Add or update a parameter value.

Parameters

  • name (str) –

  • value (any) –

  • multiple_reset (bool) –

  • keep_original (bool) –

put_values(values, multiple_reset=False, keep_original=False)

Add or update parameter values.

Parameters

  • values (dict) –

  • multiple_reset (bool) –

  • keep_original (bool) –

has_param(name)

Check if a parameter with the given name exists.

Return type

bool

Parameters

name (str) –

get_param(name)

Get a parameter by name.

Return type

Union[ParamValue, MultipleParam]

Parameters

name (str) –

get_params()

Get the parameters.

Return type

dict

get_size()

Get the number of parameters.

Return type

int

delete(name)

Delete a parameter value.

Parameters

name (str) –

reset()

Delete all parameter values.

make_help(params=None, append_example=False, skip_headers=False)

Make a formatted help message based on rules.

Return type

str

Parameters

  • params (Optional[list]) –

  • append_example (bool) –

  • skip_headers (bool) –

ExpEvArgs class

class ExpEvArgs(validator=None)

Bases: evargs.evargs.EvArgs

Initialize instance with default settings and an optional validator.

Parameters

validator (evargs.validator.Validator) –

parse(expression, reset=True)

Parse the expression.

Parameters

  • expression (str) –

  • reset (bool) –

evaluate(name, v)

Evaluate a value against a rule and parameter configuration.

Return type

bool

Parameters

  • name (str) –

  • v (any) –