HelperArgs Class

class kwhelp.HelperArgs(key: str, **kwargs)[source]

Helper class that provides KwArgs arguments

__init__(key: str, **kwargs)[source]

Constructor

Parameters

key (str) – Key Arg

Keyword Arguments

  • default (obj, optional) – Default arg. Default NO_THING

  • field (str, optional) – field arg. Default None

  • require (bool, optional) – require arg. Default False

  • rules_all (Iterable, optional) – rules_any list. Default Empty List.

  • rules_any (Iterable, optional) – rules_all list. Default Empty List.

  • types (set, optional) – types arg. Default Empty set

to_dict() → dict[source]

Gets a dictionary representation of current instance fields

property default: object

Default Value

Getter

Gets default value

Setter

Sets default value

property field: Optional[str]

Field Value

Getter

Gets field value

Setter

Sets field value

property key: str

Key Value

Getter

Gets Key Value

Setter

Sets key value

property require: bool

Require Value

Getter

Gets require value

Setter

Sets require value

property rules_all: List[Callable[[kwhelp.rules.IRule], bool]]

Rules values

Getter

Gets rules_all

Setter

Sets rules_all

property rules_any: List[Callable[[kwhelp.rules.IRule], bool]]

Rules values

Getter

Gets rules_any

Setter

Sets rules_any

property types: Set[type]

Types values

Getter

Gets types values

Setter

Sets types values