Skip to main content

Pattern matching in Python

Project description

Matchstick provides a decorator that allows for the overloading of Python functions.

>>> from matchstick import when
>>> @when('x >= 0')
... def f(x):
...     return x
>>> @when('x < 0')
... def f(x):
...     return -x
>>> f(3)
>>> f(-2)
>>> f('a')

Basic Use


The match decorator takes a condition as a string. When the decorated function gets called, overloaded functions (grouped by module and qualified name) are checked in the order they are defined. Each condition is evaluated with the arguments passed to the function (including default parameter values, where applicable). If the condition evaluates truthy, the corresponding function is called. If the condition evaluates falsy or raises an exception, the corresponding function is passed over.

>>> @when('x[2] == 5')
... def f(x):
...     return sum(x)
>>> @when('len(x) > 3')
... def f(x):
...     return x[3:]
>>> @when('True')
... def f(x):
...     return x
>>> f([3, 4, 5, 6])
>>> f([0, 1, 2, 3])
>>> f('abcd')
>>> f({})


If none of the conditions for a function evaluate truthy, a matchstick.NoMatchException is raised.

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

matchstick-0.1.1.tar.gz (3.8 kB view hashes)

Uploaded Source

Supported by

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