mypy.types

module documentation

(source)

Classes for representing mypy types.

Class	`AnyType`	The type 'Any'.
Class	`CallableArgument`	Represents a Arg(type, 'name') inside a Callable's type list.
Class	`CallableType`	Type of a non-overloaded callable object (such as function).
Class	`DeletedType`	Type of deleted variables.
Class	`EllipsisType`	The type ... (ellipsis).
Class	`ErasedType`	Placeholder for an erased type.
Class	`FunctionLike`	Abstract base class for function types.
Class	`HasTypeVars`	Undocumented
Class	`Instance`	An instance type of form C[T1, ..., Tn].
Class	`InstantiateAliasVisitor`	Undocumented
Class	`LiteralType`	The type of a Literal instance. Literal[Value]
Class	`NoneType`	The type of 'None'.
Class	`Overloaded`	Overloaded function type T1, ... Tn, where each Ti is CallableType.
Class	`ParamSpecFlavor`	Undocumented
Class	`ParamSpecType`	Type that refers to a ParamSpec.
Class	`PartialType`	Type such as List[?] where type arguments are unknown, or partial None type.
Class	`PlaceholderType`	Temporary, yet-unknown type during semantic analysis.
Class	`ProperType`	Not a type alias.
Class	`RawExpressionType`	A synthetic type representing some arbitrary expression that does not cleanly translate into a type.
Class	`RequiredType`	Required[T] or NotRequired[T]. Only usable at top-level of a TypedDict definition.
Class	`StarType`	The star type *type_parameter.
Class	`TupleType`	The tuple type Tuple[T1, ..., Tn] (at least one type argument).
Class	`Type`	Abstract base class for all types.
Class	`TypeAliasType`	A type alias to another type.
Class	`TypedDictType`	Type of TypedDict object {'k1': v1, ..., 'kn': vn}.
Class	`TypeGuardedType`	Only used by find_isinstance_check() etc.
Class	`TypeList`	Information about argument types and names [...].
Class	`TypeOfAny`	This class describes different types of Any. Each 'Any' can be of only one type at a time.
Class	`TypeStrVisitor`	Visitor for pretty-printing types into strings.
Class	`TypeType`	For types like Type[User].
Class	`TypeVarId`	Undocumented
Class	`TypeVarLikeType`	Undocumented
Class	`TypeVarType`	Type that refers to a type variable.
Class	`UnboundType`	Instance type that has not been bound during semantic analysis.
Class	`UninhabitedType`	This type has no members.
Class	`UnionType`	The union type Union[T1, ..., Tn] (at least one type argument).
Class	`UnrollAliasVisitor`	Undocumented
Function	`callable_with_ellipsis`	Construct type Callable[..., ret_type].
Function	`copy_type`	Build a copy of the type; used to mutate the copy with truthiness information
Function	`deserialize_type`	Undocumented
Function	`flatten_nested_unions`	Flatten nested unions in a type list.
Function	`get_proper_type`	Get the expansion of a type alias type.
Function	`get_proper_types`	Undocumented
Function	`has_type_vars`	Check if a type contains any type variables (recursively).
Function	`is_generic_instance`	Undocumented
Function	`is_literal_type`	Check if this type is a LiteralType with the given fallback type and value.
Function	`is_named_instance`	Undocumented
Function	`is_optional`	Undocumented
Function	`is_union_with_any`	Is this a union with Any or a plain Any type?
Function	`remove_optional`	Undocumented
Function	`replace_alias_tvars`	Replace type variables in a generic type alias tp with substitutions subs resetting context. Length of subs should be already checked.
Function	`strip_type`	Make a copy of type without 'debugging info' (function name).
Function	`union_items`	Return the flattened items of a union type.
Constant	`deserialize_map`	Undocumented
Constant	`names`	Undocumented
Constant	`NOT_READY`	Undocumented
Constant	`T`	Undocumented
Constant	`TP`	Undocumented
Constant	`TPDICT_FB_NAMES`	Undocumented
Constant	`TPDICT_NAMES`	Undocumented
Variable	`FormalArgument`	Undocumented
Variable	`JsonDict`	Undocumented
Variable	`LiteralValue`	Undocumented
Constant	`_dummy`	Undocumented

def callable_with_ellipsis(any_type, ret_type, fallback): (source)

Construct type Callable[..., ret_type].

Parameters
any_type:`AnyType`	Undocumented
ret_type:`Type`	Undocumented
fallback:`Instance`	Undocumented
Returns
`CallableType`	Undocumented

def copy_type(t): (source)

Build a copy of the type; used to mutate the copy with truthiness information

Parameters
t:`TP`	Undocumented
Returns
`TP`	Undocumented

def deserialize_type(data): (source)

Undocumented

Parameters
data:`Union[JsonDict, str]`	Undocumented
Returns
`Type`	Undocumented

def flatten_nested_unions(types, handle_type_alias_type=False): (source)

Flatten nested unions in a type list.

Parameters
types:`Iterable[Type]`	Undocumented
handle_type_alias_type:`bool`	Undocumented
Returns
`List[Type]`	Undocumented

def get_proper_type(typ): (source)

Get the expansion of a type alias type.

If the type is already a proper type, this is a no-op. Use this function wherever a decision is made on a call like e.g. 'if isinstance(typ, UnionType): ...', because 'typ' in this case may be an alias to union. Note: if after making the decision on the isinstance() call you pass on the original type (and not one of its components) it is recommended to always pass on the unexpanded alias.

Parameters
typ:`Optional[Type]`	Undocumented
Returns
`Optional[ProperType]`	Undocumented

def get_proper_types(it): (source)

Undocumented

Parameters
it:`Iterable[Optional[Type]]`	Undocumented
Returns
`Union[List[ProperType], List[Optional[ProperType]]]`	Undocumented

def has_type_vars(typ): (source)

Check if a type contains any type variables (recursively).

Parameters
typ:`Type`	Undocumented
Returns
`bool`	Undocumented

def is_generic_instance(tp): (source)

Undocumented

Parameters
tp:`Type`	Undocumented
Returns
`bool`	Undocumented

def is_literal_type(typ, fallback_fullname, value): (source)

Check if this type is a LiteralType with the given fallback type and value.

Parameters
typ:`ProperType`	Undocumented
fallback_fullname:`str`	Undocumented
value:`LiteralValue`	Undocumented
Returns
`bool`	Undocumented

def is_named_instance(t, fullname): (source)

Undocumented

Parameters
t:`Type`	Undocumented
fullname:`str`	Undocumented
Returns
`bool`	Undocumented

def is_optional(t): (source)

Undocumented

Parameters
t:`Type`	Undocumented
Returns
`bool`	Undocumented

def is_union_with_any(tp): (source)

Is this a union with Any or a plain Any type?

Parameters
tp:`Type`	Undocumented
Returns
`bool`	Undocumented

def remove_optional(typ): (source)

Undocumented

Parameters
typ:`Type`	Undocumented
Returns
`Type`	Undocumented

def replace_alias_tvars(tp, vars, subs, newline, newcolumn): (source)

Replace type variables in a generic type alias tp with substitutions subs resetting context. Length of subs should be already checked.

Parameters
tp:`Type`	Undocumented
vars:`List[str]`	Undocumented
subs:`List[Type]`	Undocumented
newline:`int`	Undocumented
newcolumn:`int`	Undocumented
Returns
`Type`	Undocumented

def strip_type(typ): (source)

Make a copy of type without 'debugging info' (function name).

Parameters
typ:`Type`	Undocumented
Returns
`ProperType`	Undocumented

def union_items(typ): (source)

Return the flattened items of a union type.

For non-union types, return a list containing just the argument.

Parameters
typ:`Type`	Undocumented
Returns
`List[ProperType]`	Undocumented

deserialize_map = (source)

Undocumented

Value

{key: obj.deserialize for key, obj in names.items() if isinstance(obj, type
    ) and issubclass(obj, Type) and obj is not Type}

names = (source)

Undocumented

Value

globals().copy()

NOT_READY = (source)

Undocumented

Value

mypy.nodes.FakeInfo('De-serialization failure: TypeInfo not fixed')

T = (source)

Undocumented

Value

TypeVar('T')

TP = (source)

Undocumented

Value

TypeVar('TP',
        bound=Type)

TPDICT_FB_NAMES: tuple[str, ...] = (source)

Undocumented

Value

('typing._TypedDict',
 'typing_extensions._TypedDict',
 'mypy_extensions._TypedDict')

TPDICT_NAMES: tuple[str, ...] = (source)

Undocumented

Value

('typing.TypedDict', 'typing_extensions.TypedDict', 'mypy_extensions.TypedDict')

FormalArgument = (source)

Undocumented

JsonDict: _TypeAlias = (source)

Undocumented

LiteralValue: _TypeAlias = (source)

Undocumented

_dummy: Any = (source)

Undocumented

Value

object()