sumtypes

November 30, 2021 · View on GitHub

sumtypes provides Algebraic Data Types for Python. The main benefit is the implementation of Sum Types (aka Tagged Unions_), which Python doesn't have any native representation for. Product Types are just objects with multiple attributes.

.. _Tagged Unions: http://en.wikipedia.org/wiki/Tagged_union

Documentation is at https://sumtypes.readthedocs.org/

This module uses the attrs_ library to provide features like attribute validation and defaults.

.. _attrs: http://pypi.python.org/pypi/attrs

Example

Decorate your classes to make them a sum type:

.. code:: python

import attr
from sumtypes import sumtype, constructor, match

@sumtype
class MyType(object):
    # constructors specify names for their arguments
    MyConstructor = constructor('x')
    AnotherConstructor = constructor('x', 'y')

    # You can also make use of any feature of the attrs
    # package by using attr.ib in constructors
    ThirdConstructor = constructor(
        one=attr.ib(default=42),
        two=attr.ib(validator=attr.validators.instance_of(int)))

(attrs package, and attr.ib documentation)

.. _attrs package: https://pypi.python.org/pypi/attrs .. _attr.ib documentation: http://attrs.readthedocs.org/en/stable/api.html#attr.ib

Then construct them by calling the constructors:

.. code:: python

v = MyType.MyConstructor(1)
v2 = MyType.AnotherConstructor('foo', 2)

You can get the values from the tagged objects:

.. code:: python

assert v.x == 1
assert v2.x == 'foo'
assert v2.y == 2

You check the constructor used:

.. code:: python

assert type(v) is MyType.MyConstructor

And, like Scala case classes, the constructor type is a subclass of the main type:

.. code:: python

assert isinstance(v, MyType)

And the tagged objects support equality:

.. code:: python

assert v == MyType.MyConstructor(1)
assert v != MyType.MyConstructor(2)

Simple pattern matching is also supported. To write a function over all the cases of a sum type:

.. code:: python

@match(MyType)
class get_number(object):
    def MyConstructor(x): return x
    def AnotherConstructor(x, y): return y
    def ThirdConstructor(one, two): return one + two

assert get_number(v) == 1
assert get_number(v2) == 2

match ensures that all cases are handled. If you really want to write a 'partial function' (i.e. one that doesn't cover all cases), use match_partial.

Example

See Also