mypy.types.TypedDictType

class documentation

class TypedDictType(ProperType): (source)

Type of TypedDict object {'k1': v1, ..., 'kn': vn}.

A TypedDict object is a dictionary with specific string (literal) keys. Each key has a value with a distinct type that depends on the key. TypedDict objects are normal dict objects at runtime.

A TypedDictType can be either named or anonymous. If it's anonymous, its fallback will be typing_extensions._TypedDict (Instance). _TypedDict is a subclass of Mapping[str, object] and defines all non-mapping dict methods that TypedDict supports. Some dict methods are unsafe and not supported. _TypedDict isn't defined at runtime.

If a TypedDict is named, its fallback will be an Instance of the named type (ex: "Point") whose TypeInfo has a typeddict_type that is anonymous. This is similar to how named tuples work.

TODO: The fallback structure is perhaps overly complicated.

Class Method	`deserialize`	Undocumented
Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`accept`	Undocumented
Method	`as_anonymous`	Undocumented
Method	`copy_modified`	Undocumented
Method	`create_anonymous_fallback`	Undocumented
Method	`is_anonymous`	Undocumented
Method	`names_are_wider_than`	Undocumented
Method	`serialize`	Undocumented
Method	`zip`	Undocumented
Method	`zipall`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`can_be_false`	Undocumented
Instance Variable	`can_be_true`	Undocumented
Instance Variable	`fallback`	Undocumented
Instance Variable	`items`	Undocumented
Instance Variable	`required_keys`	Undocumented

Inherited from Type (via ProperType):

Method	`__repr__`	Undocumented
Method	`can_be_false_default`	Undocumented
Method	`can_be_true_default`	Undocumented

Inherited from Context (via ProperType, Type):

Method	`get_column`	Don't use. Use x.column.
Method	`get_line`	Don't use. Use x.line.
Method	`set_line`	If target is a node, pull line (and column) information into this node. If column is specified, this will override any column information coming from a node.
Instance Variable	`column`	Undocumented
Instance Variable	`end_line`	Undocumented
Instance Variable	`line`	Undocumented

@classmethod
def deserialize(cls, data): (source)

overrides mypy.types.Type.deserialize

Undocumented

Parameters
data:`JsonDict`	Undocumented
Returns
`TypedDictType`	Undocumented

def __eq__(self, other): (source)

Undocumented

Parameters
other:`object`	Undocumented
Returns
`bool`	Undocumented

def __hash__(self): (source)

Undocumented

Returns
`int`	Undocumented

def __init__(self, items, required_keys, fallback, line=-1, column=-1): (source)

overrides mypy.types.Type.__init__

Undocumented

Parameters
items:`OrderedDict[str, Type]`	Undocumented
required_keys:`Set[str]`	Undocumented
fallback:`Instance`	Undocumented
line:`int`	Undocumented
column:`int`	Undocumented

def accept(self, visitor): (source)

overrides mypy.types.Type.accept

Undocumented

Parameters
visitor:`TypeVisitor[T]`	Undocumented
Returns
`T`	Undocumented

def as_anonymous(self): (source)

Undocumented

Returns
`TypedDictType`	Undocumented

def copy_modified(self, *, fallback=None, item_types=None, required_keys=None): (source)

Undocumented

Parameters
fallback:`Optional[Instance]`	Undocumented
item_types:`Optional[List[Type]]`	Undocumented
required_keys:`Optional[Set[str]]`	Undocumented
Returns
`TypedDictType`	Undocumented

def create_anonymous_fallback(self, *, value_type): (source)

Undocumented

Parameters
value_type:`Type`	Undocumented
Returns
`Instance`	Undocumented

def is_anonymous(self): (source)

Undocumented

Returns
`bool`	Undocumented

def names_are_wider_than(self, other): (source)

Undocumented

Parameters
other:`TypedDictType`	Undocumented
Returns
`bool`	Undocumented

def serialize(self): (source)

overrides mypy.types.Type.serialize

Undocumented

Returns
`JsonDict`	Undocumented

def zip(self, right): (source)

Undocumented

Parameters
right:`TypedDictType`	Undocumented
Returns
`Iterable[Tuple[str, Type, Type]]`	Undocumented

def zipall(self, right): (source)

Undocumented

Parameters
right:`TypedDictType`	Undocumented
Returns
`Iterable[Tuple[str, Optional[Type], Optional[Type]]]`	Undocumented

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

overrides mypy.types.ProperType.__slots__

Undocumented

can_be_false = (source)

overrides mypy.types.Type.can_be_false

Undocumented

can_be_true = (source)

overrides mypy.types.Type.can_be_true

Undocumented

fallback = (source)

Undocumented

items = (source)

Undocumented

required_keys = (source)

Undocumented