mypy.types.Parameters

class documentation

class Parameters(ProperType): (source)

Type that represents the parameters to a function. Used for ParamSpec analysis.

Class Method	`deserialize`	Undocumented
Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`accept`	Undocumented
Method	`argument_by_name`	Undocumented
Method	`argument_by_position`	Undocumented
Method	`copy_modified`	Undocumented
Method	`formal_arguments`	Yields the formal arguments corresponding to this callable, ignoring arg and *kwargs.
Method	`kw_arg`	The formal argument for **kwargs.
Method	`serialize`	Undocumented
Method	`try_synthesizing_arg_from_kwarg`	Undocumented
Method	`try_synthesizing_arg_from_vararg`	Undocumented
Method	`var_arg`	The formal argument for *args.
Class Variable	`__slots__`	Undocumented
Instance Variable	`arg_kinds`	Undocumented
Instance Variable	`arg_names`	Undocumented
Instance Variable	`arg_types`	Undocumented
Instance Variable	`is_ellipsis_args`	Undocumented
Instance Variable	`min_args`	Undocumented
Instance Variable	`variables`	Undocumented

Inherited from Type (via ProperType):

Method	`__repr__`	Undocumented
Method	`can_be_false.setter`	Undocumented
Method	`can_be_false_default`	Undocumented
Method	`can_be_true.setter`	Undocumented
Method	`can_be_true_default`	Undocumented
Method	`is_singleton_type`	Undocumented
Property	`can_be_false`	Undocumented
Property	`can_be_true`	Undocumented
Instance Variable	`_can_be_false`	Undocumented
Instance Variable	`_can_be_true`	Undocumented

Inherited from Context (via ProperType, Type):

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_column`	Undocumented
Instance Variable	`end_line`	Undocumented
Instance Variable	`line`	Undocumented

@classmethod
def deserialize(cls, data: JsonDict) -> Parameters: (source) ¶

overrides mypy.types.Type.deserialize

Undocumented

def __eq__(self, other: object) -> bool: (source) ¶

Undocumented

def __hash__(self) -> int: (source) ¶

Undocumented

def __init__(self, arg_types: Sequence[Type], arg_kinds: list[ArgKind], arg_names: Sequence[str|None], *, variables: Sequence[TypeVarLikeType]|None = None, is_ellipsis_args: bool = False, line: int = -1, column: int = -1): (source) ¶

overrides mypy.types.Type.__init__

Undocumented

def accept(self, visitor: TypeVisitor[T]) -> T: (source) ¶

overrides mypy.types.Type.accept

Undocumented

def argument_by_name(self, name: str|None) -> FormalArgument|None: (source) ¶

Undocumented

def argument_by_position(self, position: int|None) -> FormalArgument|None: (source) ¶

Undocumented

def copy_modified(self, arg_types: Bogus[Sequence[Type]] = _dummy, arg_kinds: Bogus[list[ArgKind]] = _dummy, arg_names: Bogus[Sequence[str|None]] = _dummy, *, variables: Bogus[Sequence[TypeVarLikeType]] = _dummy, is_ellipsis_args: Bogus[bool] = _dummy) -> Parameters: (source) ¶

Undocumented

def formal_arguments(self, include_star_args: bool = False) -> list[FormalArgument]: (source) ¶

Yields the formal arguments corresponding to this callable, ignoring *arg and **kwargs. To handle *args and **kwargs, use the 'callable.var_args' and 'callable.kw_args' fields, if they are not None. If you really want to include star args in the yielded output, set the 'include_star_args' parameter to 'True'.

def kw_arg(self) -> FormalArgument|None: (source) ¶

The formal argument for **kwargs.

def serialize(self) -> JsonDict: (source) ¶

overrides mypy.types.Type.serialize

Undocumented