multimethod 1.12

Multiple argument dispatching.

Multimethod provides a decorator for adding multiple argument dispatching to functions. The decorator creates a multimethod object as needed, and registers the function with its annotations.

There are several multiple dispatch libraries on PyPI. This one aims for simplicity and speed. With caching of argument types, it should be the fastest pure Python implementation possible.

Usage

There are a couple options which trade-off dispatch speed for flexibility.

Decorator	Speed	Dispatch	Arguments
multimethod	faster	cached lookup	positional only
multidispatch	slower	binds to first signature + cached lookup	positional + keywords

Dispatching on simple types which use issubclass is cached. Advanced types which use isinstance require a linear scan.

multimethod

from multimethod import multimethod

@multimethod
def func(x: int, y: float):
    ...

func is now a multimethod which will delegate to the above function, when called with arguments of the specified types. Subsequent usage will register new types and functions to the existing multimethod of the same name.

@multimethod
def func(x: float, y: int):
    ...

Alternatively, functions can be explicitly registered in the same style as functools.singledispatch. This syntax is also compatible with mypy, which by default checks that each name is defined once.

@func.register
def _(x: bool, y: bool):
    ...


@func.register(object, bool)
@func.register(bool, object)
def _(x, y):  # stackable without annotations
    ...

Multimethods are implemented as mappings from signatures to functions, and can be introspected as such.

method[type, ...]           # get registered function
method[type, ...] = func    # register function by explicit types

Multimethods support any types that satisfy the issubclass relation, including abstract base classes in collections.abc. Note typing aliases do not support issubclass consistently, and are no longer needed for subscripts. Using ABCs instead is recommended. Subscripted generics are supported:

• Union[...] or ... | ...
• Mapping[...] - the first key-value pair is checked
• tuple[...] - all args are checked
• Iterable[...] - the first arg is checked
• Type[...]
• Literal[...]
• Callable[[...], ...] - parameter types are contravariant, return type is covariant

Naturally checking subscripts is slower, but the implementation is optimized, cached, and bypassed if no subscripts are in use in the parameter. Empty iterables match any subscript, but don't special-case how the types are normally resolved.

Dispatch resolution details:

• If an exact match isn't registered, the next closest method is called (and cached).
• If there are ambiguous methods - or none - a custom TypeError is raised.
• Keyword-only parameters may be annotated, but won't affect dispatching.
• A skipped annotation is equivalent to : object.
• If no types are specified, it will inherently match all arguments.

multidispatch

multidispatch is a wrapper to provide compatibility with functools.singledispatch. It requires a base implementation and use of the register method instead of namespace lookup. It also supports dispatching on keyword arguments.

instance checks

subtype provisionally provides isinstance and issubclass checks for generic types. When called on a non-generic, it will return the origin type.

from multimethod import subtype

cls = subtype(int | list[int])

for obj in (0, False, [0], [False], []):
    assert isinstance(obj, cls)
for obj in (0.0, [0.0], (0,)):
    assert not isinstance(obj, cls)

for subclass in (int, bool, list[int], list[bool]):
    assert issubclass(subclass, cls)
for subclass in (float, list, list[float], tuple[int]):
    assert not issubclass(subclass, cls)

If a type implements a custom __instancecheck__, it can opt-in to dispatch (without caching) by registering its metaclass and bases with subtype.origins. parametric provides a convenient constructor, which will match the base class, predicate functions, and check attributes.

from multimethod import parametric

Coroutine = parametric(Callable, asyncio.iscoroutinefunction)
IntArray = parametric(array, typecode='i')

overload used to dispatch on annotated predicate functions. It is deprecated because a custom instance check - including using parametric - offers the same functionality. Any predicate function can be wrapped with the closest matching base class, including object if necessary.

Cls = parametric(object, predicate)
Digits = parametric(str, str.isdigit)
assert isinstance('0', Digits)
assert not isinstance('a', Digits)

@meth.register
def _(arg: Digits): ...

classes

classmethod and staticmethod may be used with a multimethod, but must be applied last, i.e., wrapping the final multimethod definition after all functions are registered. For class and instance methods, cls and self participate in the dispatch as usual. They may be left blank when using annotations, otherwise use object as a placeholder.

class Cls:
    # @classmethod: only works here if there are no more functions
    @multimethod
    def meth(cls, arg: str): ...

    # @classmethod: can not be used with `register` because `_` is not the multimethod
    @meth.register
    def _(cls, arg: int): ...

    meth = classmethod(meth)  # done with registering

If a method spans multiple classes, then the namespace lookup can not work. The register method can be used instead.

class Base:
    @multimethod
    def meth(self, arg: str): ...

class Subclass(Base):
    @Base.meth.register
    def _(self, arg: int): ...

If the base class can not be modified, the decorator - like any - can be called explicitly.

class Subclass(Base):
    meth = multimethod(Base.meth)
    ...

multimeta creates a class with a special namespace which converts callables to multimethods, and registers duplicate callables with the original.

class Cls(metaclass=multimeta):
    ... # all methods are multimethods

Installation

% pip install multimethod

Tests

100% branch coverage.

% pytest [--cov]