Skip to main content

Multiple dispatch

Project description

Build Status

A relatively sane approach to multiple dispatch in Python.

There exists several implementations of multiple dispatch (see links below). This implementation is efficient, relatively complete, and performs static analysis to avoid common issues.

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

What this doesn’t do

  • Vararg dispatch

@dispatch([int])
def add(*args):
    ...
  • Diagonal dispatch

a = arbitrary_type()
@dispatch(a, a)
def are_same_type(x, y):
    return True
  • Respect namespaces

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 no dependencies beyond the standard library.

It is, in short, a light weight dependency.

License

New BSD. See License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

multipledispatch-0.3.0.tar.gz (5.7 kB view details)

Uploaded Source

File details

Details for the file multipledispatch-0.3.0.tar.gz.

File metadata

File hashes

Hashes for multipledispatch-0.3.0.tar.gz
Algorithm Hash digest
SHA256 11640902f2028ee05d1522620a66f5c881aa11effa1e6aa6c5148671a570fba3
MD5 3d34f44ea92179d061651d6fad0db23a
BLAKE2b-256 4dd4a83b6a9fa9090d493a1590a8758974ee4d7c56a00f096e3ebb1f5dbc42bc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page