TypeCheck Class

class kwhelp.decorator.TypeCheck(*args: Union[type, Iterable[type]], **kwargs)[source]

Decorator that decorates methods that requires args to match a type specificed in a list

See also

TypeCheck Usage

__init__(*args: Union[type, Iterable[type]], **kwargs)[source]

Constructor

Parameters

args (type) – One or more types for wrapped function args to match.

Keyword Arguments

  • raise_error – (bool, optional): If True then a TypeError will be raised if a validation fails. If False then an attribute will be set on decorated function named is_types_valid indicating if validation status. Default True.

  • type_instance_check (bool, optional) – If True then args are tested also for isinstance() if type does not match, rather then just type check. If False then values willl only be tested as type. Default True

  • ftype (DecFuncType, optional) – Type of function that decorator is applied on. Default DecFuncType.FUNCTION

  • opt_return (object, optional) – Return value when decorator is invalid. By default an error is rasied when validation fails. If opt_return is supplied then it will be return when validation fails and no error will be raised.

  • opt_args_filter (DecArgEnum, optional) – Filters the arguments that are validated. Default DecArgEnum.ALL.

  • opt_logger (Union[Logger, LoggerAdapter], optional) – Logger that logs exceptions when validation fails.

Raises

  • TypeError – If types arg is not a iterable object such as a list or tuple.

  • TypeError – If any arg is not of a type listed in types.