Skip to content
Branch: master
Clone or download
Latest commit 2cc8df6 Aug 8, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bench
docs Typo Aug 3, 2018
multipledispatch bump version to 0.6.0 Aug 8, 2018
.binstar.yml add win-64 to binstar.yml Nov 12, 2014
.gitignore Ignore .pytest_cache/ Jul 12, 2018
.travis.yml
LICENSE.txt
README.rst Update readme to reflect the new six addition Aug 4, 2018
conda.yaml Convert readthedocs links for their .org -> .io migration for hosted … Jan 1, 2017
release-notes.txt bump version to 0.4.7 Sep 1, 2014
setup.py Add six Jul 30, 2018

README.rst

Multiple Dispatch

Build Status Coverage Status Version Status

A relatively sane approach to multiple dispatch in Python.

This implementation of multiple dispatch is efficient, mostly complete, performs static analysis to avoid conflicts, and provides optional namespace support. It looks good too.

See the documentation at https://multiple-dispatch.readthedocs.io/

Example

>>> from multipledispatch import dispatch

>>> @dispatch(int, int)
... def add(x, y):
...     return x + y

>>> @dispatch(object, object)
... def add(x, y):
...     return "%s + %s" % (x, y)

>>> add(1, 2)
3

>>> add(1, 'hello')
'1 + hello'

What this does

  • Dispatches on all non-keyword arguments
  • Supports inheritance
  • Supports instance methods
  • Supports union types, e.g. (int, float)
  • Supports builtin abstract classes, e.g. Iterator, Number, ...
  • Caches for fast repeated lookup
  • Identifies possible ambiguities at function definition time
  • Provides hints to resolve ambiguities when they occur
  • Supports namespaces with optional keyword arguments
  • Supports variadic dispatch

What this doesn't do

  • Diagonal dispatch
a = arbitrary_type()
@dispatch(a, a)
def are_same_type(x, y):
    return True
  • Efficient update: The addition of a new signature requires a full resolve of the whole function. This becomes troublesome after you get to a few hundred type signatures.

Installation and Dependencies

multipledispatch is on the Python Package Index (PyPI):

pip install multipledispatch

or

easy_install multipledispatch

multipledispatch supports Python 2.6+ and Python 3.2+ with a common codebase. It is pure Python and requires only the small six library as a dependency.

It is, in short, a light weight dependency.

License

New BSD. See License file.

Links

You can’t perform that action at this time.