diplomat.processing.type_casters

Provides an interface and several types for performing automatic typecasting. Also provides an alternative API for adding type hints to python functions with more capabilities than python’s builtin type hints via the typecaster protocol and the typecaster_function decorator.

Module Attributes

Any	A type caster representing typing.Any.
NoneType	Represents None as a type caster.
PathLike	Represents os.PathLike as a type caster.

Functions

get_type_name(caster)	Get the underlying name of a typecaster or type for printing...
get_typecaster_annotations(func)	Get the type casting annotations of a type caster function.
get_typecaster_kwd_arg_name(func)	Get the name of the wildcard keyword argument for this type caster function if it exists.
get_typecaster_required_arguments(func)	Get the arguments that must be passed to this typecasting function (one's that lack a default argument).
to_hint(t)	Convert a type caster to a python type hint.
to_metavar(t)	Convert a type caster to a command line meta-variable string.
typecaster_function(func)	Turns a function annotated with typecaster objects into a regular function with normal type annotations.

Classes

ConvertibleTypeCaster(*args, **kwargs)	A convertible typecaster, or one that can be converted to normal python type hints.
Dict(key, value)	Represents typing.Dict as a type caster
List(item_type)	A type which represents a sequence, or list.
Literal(*objects)	Represents the typing.Literal type as a type caster.
Optional(t)	Represents typing.Optional as a type caster.
RangedFloat(minimum, maximum)	Represents a float with a restricted range of values it can take on.
RangedInteger(minimum, maximum)	Represents an integer with a restricted range of values it can take on.
RoundedDecimal([precision])	Represents a decimal rounded to a fixed precision.
SingletonConvertibleTypeCaster()
StrictCallable(*[, _return, _kwargs])	A type caster that can be used to run strict argument name and type checking on type casting functions.
Tuple(*type_list)	Represents a fixed length tuple of types.
TypeCaster(*args, **kwargs)	Protocol for a type casting method.
TypeCasterFunction(*args, **kwargs)	Protocol for representing a type caster function.
Union(*types)	Represents the typing.Union type as a type caster.