mypy.plugins.singledispatch

module documentation
(source)

Undocumented

Function call​_singledispatch​_function​_after​_register​_argument Called on the function after passing a type to register
Function call​_singledispatch​_function​_callback Called for functools._SingleDispatchCallable.__call__
Function create​_singledispatch​_function​_callback Called for functools.singledispatch
Function fail Emit an error message.
Function get​_dispatch​_type Undocumented
Function get​_first​_arg Get the element that corresponds to the first argument passed to the function
Function get​_singledispatch​_info Undocumented
Function make​_fake​_register​_class​_instance Undocumented
Function register​_function Register a function
Function rename​_func Return a new CallableType that is function with the name of new_name
Function singledispatch​_register​_callback Called for functools._SingleDispatchCallable.register
Constant REGISTER​_CALLABLE​_CALL​_METHOD Undocumented
Constant REGISTER​_RETURN​_CLASS Undocumented
Constant SINGLEDISPATCH​_CALLABLE​_CALL​_METHOD Undocumented
Constant SINGLEDISPATCH​_REGISTER​_METHOD Undocumented
Constant SINGLEDISPATCH​_TYPE Undocumented
Constant T Undocumented
Variable ​Plugin​Context Undocumented
Variable ​Register​Callable​Info Undocumented
Variable ​Singledispatch​Type​Vars Undocumented
def call_singledispatch_function_after_register_argument(ctx): (source)
Called on the function after passing a type to register
Parameters
ctx:MethodContextUndocumented
Returns
TypeUndocumented
def call_singledispatch_function_callback(ctx): (source)
Called for functools._SingleDispatchCallable.__call__
Parameters
ctx:MethodSigContextUndocumented
Returns
FunctionLikeUndocumented
def create_singledispatch_function_callback(ctx): (source)
Called for functools.singledispatch
Parameters
ctx:FunctionContextUndocumented
Returns
TypeUndocumented
def fail(ctx, msg, context): (source)

Emit an error message.

This tries to emit an error message at the location specified by context, falling back to the location specified by ctx.context. This is helpful when the only context information about where you want to put the error message may be None (like it is for CallableType.definition) and falling back to the location of the calling function is fine.

Parameters
ctx:PluginContextUndocumented
msg:strUndocumented
context:Optional[Context]Undocumented
def get_dispatch_type(func, register_arg): (source)

Undocumented

Parameters
func:CallableTypeUndocumented
register​_arg:Optional[Type]Undocumented
Returns
Optional[Type]Undocumented
def get_first_arg(args): (source)
Get the element that corresponds to the first argument passed to the function
Parameters
args:List[List[T]]Undocumented
Returns
Optional[T]Undocumented
def get_singledispatch_info(typ): (source)

Undocumented

Parameters
typ:InstanceUndocumented
Returns
Optional[SingledispatchTypeVars]Undocumented
def make_fake_register_class_instance(api, type_args): (source)

Undocumented

Parameters
api:CheckerPluginInterfaceUndocumented
type​_args:Sequence[Type]Undocumented
Returns
InstanceUndocumented
def register_function(ctx, singledispatch_obj, func, register_arg=None): (source)
Register a function
Parameters
ctx:PluginContextUndocumented
singledispatch​_obj:InstanceUndocumented
func:TypeUndocumented
register​_arg:Optional[Type]Undocumented
def rename_func(func, new_name): (source)
Return a new CallableType that is function with the name of new_name
Parameters
func:CallableTypeUndocumented
new​_name:CallableTypeUndocumented
Returns
CallableTypeUndocumented
def singledispatch_register_callback(ctx): (source)
Called for functools._SingleDispatchCallable.register
Parameters
ctx:MethodContextUndocumented
Returns
TypeUndocumented
REGISTER_CALLABLE_CALL_METHOD = (source)

Undocumented

Value
"""functools.{}.__call__""".format(REGISTER_RETURN_CLASS)
REGISTER_RETURN_CLASS: str = (source)

Undocumented

Value
'_SingleDispatchRegisterCallable'
SINGLEDISPATCH_CALLABLE_CALL_METHOD = (source)

Undocumented

Value
"""{}.__call__""".format(SINGLEDISPATCH_TYPE)
SINGLEDISPATCH_REGISTER_METHOD = (source)

Undocumented

Value
"""{}.register""".format(SINGLEDISPATCH_TYPE)
SINGLEDISPATCH_TYPE: str = (source)

Undocumented

Value
'functools._SingleDispatchCallable'
T = (source)

Undocumented

Value
TypeVar('T')
PluginContext = (source)

Undocumented

RegisterCallableInfo = (source)

Undocumented

SingledispatchTypeVars = (source)

Undocumented