evargs package¶
Example code¶
from evargs import EvArgs
evargs = EvArgs()
evargs.initialize({
'a': {'type': int},
'b': {'type': str},
'c': {'type': 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 module¶
- class EvArgs(validator=None)¶
Bases:
object- Parameters
validator (evargs.validator.Validator) –
- RULE = {'choices': None, 'default': None, 'evaluate': None, 'evaluate_param': None, 'help': None, 'list': False, 'list_or': None, 'multiple': False, 'multiple_or': None, 'post_apply': None, 'post_apply_param': None, 'pre_apply': None, 'pre_apply_param': None, 'prevent_error': False, 'require': False, 'type': None, 'validation': None}¶
- set_validator(validator)¶
- Parameters
validator (evargs.validator.Validator) –
- get_value_caster()¶
- Return type
type
- set_value_caster(value_caster)¶
- Parameters
value_caster (type) –
- get_help_formatter()¶
- Return type
- set_help_formatter(help_formatter)¶
- Parameters
help_formatter (evargs.help_formatter.HelpFormatter) –
- initialize(rules, default_rule=None, flexible=False, require_all=False, ignore_unknown=False)¶
- Parameters
rules (dict) –
default_rule (Optional[dict]) –
flexible (bool) –
require_all (bool) –
ignore_unknown (bool) –
- set_options(flexible=False, require_all=False, ignore_unknown=False)¶
- Parameters
flexible (bool) –
require_all (bool) –
ignore_unknown (bool) –
- set_default(default_rule=None)¶
- Parameters
default_rule (Optional[dict]) –
- set_rules(rules)¶
- Parameters
rules (dict) –
- set_rule(name, rule)¶
- Parameters
name (str) –
rule (dict) –
- parse(assigns)¶
- Parameters
assigns (str) –
- evaluate(name, v)¶
- Return type
bool- Parameters
name (str) –
v (any) –
- get_rule(name)¶
- Return type
dict- Parameters
name (str) –
- get(name, index=- 1)¶
- Return type
any- Parameters
name (str) –
index (int) –
- get_values()¶
- Return type
dict
- put(name, value, operator=1, reset=False)¶
- Parameters
name (str) –
value (any) –
operator (int) –
reset (bool) –
- put_values(values, operator=1, reset=False)¶
- Parameters
values (dict) –
operator (int) –
reset (bool) –
- reset(name)¶
- Parameters
name (str) –
- reset_params()¶
- has_param(name)¶
- Return type
bool- Parameters
name (str) –
- get_params()¶
- Return type
dict
- count_params()¶
- Return type
int
- make_help(params=None, append_example=False, skip_headers=False)¶
- Parameters
params (Optional[list]) –
append_example (bool) –
skip_headers (bool) –