mypy.types.CallableType

class documentation

class CallableType(FunctionLike): (source)

Type of a non-overloaded callable object (such as function).

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	`expand_param_spec`	Undocumented
Method	`formal_arguments`	Yields the formal arguments corresponding to this callable, ignoring arg and *kwargs.
Method	`get_name`	Undocumented
Method	`is_generic`	Undocumented
Method	`is_type_obj`	Undocumented
Method	`kw_arg`	The formal argument for **kwargs.
Method	`max_possible_positional_args`	Returns maximum number of positional arguments this method could possibly accept.
Method	`param_spec`	Return ParamSpec if callable can be called with one.
Method	`serialize`	Undocumented
Method	`try_synthesizing_arg_from_kwarg`	Undocumented
Method	`try_synthesizing_arg_from_vararg`	Undocumented
Method	`type_object`	Undocumented
Method	`type_var_ids`	Undocumented
Method	`var_arg`	The formal argument for *args.
Method	`with_name`	Return a copy of this type with the specified name.
Class Variable	`__slots__`	Undocumented
Instance Variable	`arg_kinds`	Undocumented
Instance Variable	`arg_names`	Undocumented
Instance Variable	`arg_types`	Undocumented
Instance Variable	`bound_args`	Undocumented
Instance Variable	`def_extras`	Undocumented
Instance Variable	`definition`	Undocumented
Instance Variable	`fallback`	Undocumented
Instance Variable	`from_type_type`	Undocumented
Instance Variable	`implicit`	Undocumented
Instance Variable	`is_ellipsis_args`	Undocumented
Instance Variable	`min_args`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`ret_type`	Undocumented
Instance Variable	`special_sig`	Undocumented
Instance Variable	`type_guard`	Undocumented
Instance Variable	`variables`	Undocumented
Property	`is_kw_arg`	Does this callable have a **kwargs argument?
Property	`is_var_arg`	Does this callable have a *args argument?
Property	`items`	Undocumented

Inherited from FunctionLike:

Instance Variable can_be_false Undocumented

Inherited from Type (via FunctionLike, ProperType):

Method	`__repr__`	Undocumented
Method	`can_be_false_default`	Undocumented
Method	`can_be_true_default`	Undocumented
Instance Variable	`can_be_true`	Undocumented

Inherited from Context (via FunctionLike, 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
`CallableType`	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, arg_types, arg_kinds, arg_names, ret_type, fallback, name=None, definition=None, variables=None, line=-1, column=-1, is_ellipsis_args=False, implicit=False, special_sig=None, from_type_type=False, bound_args=(), def_extras=None, type_guard=None): (source)

overrides mypy.types.FunctionLike.__init__

Undocumented

Parameters
arg_types:`Sequence[Type]`	Undocumented
arg_kinds:`List[ArgKind]`	Undocumented
arg_names:`Sequence[Optional[str]]`	Undocumented
ret_type:`Type`	Undocumented
fallback:`Instance`	Undocumented
name:`Optional[str]`	Undocumented
definition:`Optional[SymbolNode]`	Undocumented
variables:`Optional[Sequence[TypeVarLikeType]]`	Undocumented
line:`int`	Undocumented
column:`int`	Undocumented
is_ellipsis_args:`bool`	Undocumented
implicit:`bool`	Undocumented
special_sig:`Optional[str]`	Undocumented
from_type_type:`bool`	Undocumented
bound_args:`Sequence[Optional[Type]]`	Undocumented
def_extras:`Optional[Dict[str, Any]]`	Undocumented
type_guard:`Optional[Type]`	Undocumented

def accept(self, visitor): (source)

overrides mypy.types.Type.accept

Undocumented

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

def argument_by_name(self, name): (source)

Undocumented

Parameters
name:`Optional[str]`	Undocumented
Returns
`Optional[FormalArgument]`	Undocumented

def argument_by_position(self, position): (source)

Undocumented

Parameters
position:`Optional[int]`	Undocumented
Returns
`Optional[FormalArgument]`	Undocumented

def copy_modified(self, arg_types=_dummy, arg_kinds=_dummy, arg_names=_dummy, ret_type=_dummy, fallback=_dummy, name=_dummy, definition=_dummy, variables=_dummy, line=_dummy, column=_dummy, is_ellipsis_args=_dummy, implicit=_dummy, special_sig=_dummy, from_type_type=_dummy, bound_args=_dummy, def_extras=_dummy, type_guard=_dummy): (source)

Undocumented

Parameters
arg_types:`Bogus[Sequence[Type]]`	Undocumented
arg_kinds:`Bogus[List[ArgKind]]`	Undocumented
arg_names:`Bogus[List[Optional[str]]]`	Undocumented
ret_type:`Bogus[Type]`	Undocumented
fallback:`Bogus[Instance]`	Undocumented
name:`Bogus[Optional[str]]`	Undocumented
definition:`Bogus[SymbolNode]`	Undocumented
variables:`Bogus[Sequence[TypeVarLikeType]]`	Undocumented
line:`Bogus[int]`	Undocumented
column:`Bogus[int]`	Undocumented
is_ellipsis_args:`Bogus[bool]`	Undocumented
implicit:`Bogus[bool]`	Undocumented
special_sig:`Bogus[Optional[str]]`	Undocumented
from_type_type:`Bogus[bool]`	Undocumented
bound_args:`Bogus[List[Optional[Type]]]`	Undocumented
def_extras:`Bogus[Dict[str, Any]]`	Undocumented
type_guard:`Bogus[Optional[Type]]`	Undocumented
Returns
`CallableType`	Undocumented

def expand_param_spec(self, c): (source)

Undocumented

Parameters
c:`CallableType`	Undocumented
Returns
`CallableType`	Undocumented

def formal_arguments(self, include_star_args=False): (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'.

Parameters
include_star_args:`bool`	Undocumented
Returns
`List[FormalArgument]`	Undocumented

def get_name(self): (source)

overrides mypy.types.FunctionLike.get_name

Undocumented

Returns
`Optional[str]`	Undocumented

def is_generic(self): (source)

Undocumented

Returns
`bool`	Undocumented

def is_type_obj(self): (source)

overrides mypy.types.FunctionLike.is_type_obj

Undocumented

Returns
`bool`	Undocumented

def kw_arg(self): (source)

The formal argument for **kwargs.

Returns
`Optional[FormalArgument]`	Undocumented

def max_possible_positional_args(self): (source)

Returns maximum number of positional arguments this method could possibly accept.

This takes into account *arg and **kwargs but excludes keyword-only args.

Returns
`int`	Undocumented

def param_spec(self): (source)

Return ParamSpec if callable can be called with one.

A Callable accepting ParamSpec P args (*args, **kwargs) must have the two final parameters like this: *args: P.args, **kwargs: P.kwargs.

Returns
`Optional[ParamSpecType]`	Undocumented

def serialize(self): (source)

overrides mypy.types.Type.serialize

Undocumented

Returns
`JsonDict`	Undocumented

def try_synthesizing_arg_from_kwarg(self, name): (source)

Undocumented

Parameters
name:`Optional[str]`	Undocumented
Returns
`Optional[FormalArgument]`	Undocumented

def try_synthesizing_arg_from_vararg(self, position): (source)

Undocumented

Parameters
position:`Optional[int]`	Undocumented
Returns
`Optional[FormalArgument]`	Undocumented

def type_object(self): (source)

overrides mypy.types.FunctionLike.type_object

Undocumented

Returns
`mypy.nodes.TypeInfo`	Undocumented

def type_var_ids(self): (source)

Undocumented

Returns
`List[TypeVarId]`	Undocumented

def var_arg(self): (source)

The formal argument for *args.

Returns
`Optional[FormalArgument]`	Undocumented

def with_name(self, name): (source)

overrides mypy.types.FunctionLike.with_name

Return a copy of this type with the specified name.

Parameters
name:`str`	Undocumented
Returns
`CallableType`	Undocumented

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

overrides mypy.types.FunctionLike.__slots__

Undocumented

arg_kinds = (source)

Undocumented

arg_names = (source)

Undocumented

arg_types = (source)

Undocumented

bound_args = (source)

Undocumented

def_extras = (source)

Undocumented

definition = (source)

Undocumented

fallback = (source)

overrides mypy.types.FunctionLike.fallback

Undocumented

from_type_type = (source)

Undocumented

implicit = (source)

Undocumented

is_ellipsis_args = (source)

Undocumented

min_args = (source)

Undocumented

name = (source)

Undocumented

ret_type = (source)

Undocumented

special_sig = (source)

Undocumented

type_guard = (source)

Undocumented

variables = (source)

Undocumented

@property
is_kw_arg: bool = (source)

Does this callable have a **kwargs argument?

@property
is_var_arg: bool = (source)

Does this callable have a *args argument?

@property
items: List[CallableType] = (source)

overrides mypy.types.FunctionLike.items

Undocumented