mypy.types.LiteralType

class documentation

class LiteralType(ProperType): (source)

The type of a Literal instance. Literal[Value]

A Literal always consists of:

A native Python object corresponding to the contained inner value
A fallback for this Literal. The fallback also corresponds to the parent type this Literal subtypes.

For example, 'Literal[42]' is represented as 'LiteralType(value=42, fallback=instance_of_int)'

As another example, Literal[Color.RED] (where Color is an enum) is represented as `LiteralType(value="RED", fallback=instance_of_color)'.

Class Method	`deserialize`	Undocumented
Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`accept`	Undocumented
Method	`can_be_false_default`	Undocumented
Method	`can_be_true_default`	Undocumented
Method	`is_enum_literal`	Undocumented
Method	`serialize`	Undocumented
Method	`value_repr`	Returns the string representation of the underlying type.
Class Variable	`__slots__`	Undocumented
Instance Variable	`fallback`	Undocumented
Instance Variable	`value`	Undocumented

Inherited from Type (via ProperType):

Method	`__repr__`	Undocumented
Instance Variable	`can_be_false`	Undocumented
Instance Variable	`can_be_true`	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
`LiteralType`	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, value, fallback, line=-1, column=-1): (source)

overrides mypy.types.Type.__init__

Undocumented

Parameters
value:`LiteralValue`	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 can_be_false_default(self): (source)

overrides mypy.types.Type.can_be_false_default

Undocumented

Returns
`bool`	Undocumented

def can_be_true_default(self): (source)

overrides mypy.types.Type.can_be_true_default

Undocumented

Returns
`bool`	Undocumented

def is_enum_literal(self): (source)

Undocumented

Returns
`bool`	Undocumented

def serialize(self): (source)

overrides mypy.types.Type.serialize

Undocumented

Returns
`Union[JsonDict, str]`	Undocumented

def value_repr(self): (source)

Returns the string representation of the underlying type.

This function is almost equivalent to running repr(self.value), except it includes some additional logic to correctly handle cases where the value is a string, byte string, a unicode string, or an enum.

Returns
`str`	Undocumented

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

overrides mypy.types.ProperType.__slots__

Undocumented

fallback = (source)

Undocumented

value = (source)

Undocumented