diplomat.processing.type_casters.Optional

class diplomat.processing.type_casters.Optional(*args, **kwds)[source]

Bases: Union

Represents typing.Optional as a type caster.

__init__(t: TypeCaster)[source]

Methods

__init__(t)

to_metavar()

Convert this type to a CLI-Friendly format for display on the command line as a metavar.

to_type_hint()

Abstract method: Convert this typecaster instance to a regular type hint.
to_metavar() → str[source]

Convert this type to a CLI-Friendly format for display on the command line as a metavar.

Returns:

A string, the CLI Friendly format for this type.

to_type_hint() → Type[source]

Abstract method: Convert this typecaster instance to a regular type hint.

Returns:

A type from the typing module or primitive, being the underlying type this typecaster converts values to and represents.