sumtypes

What it is and what it does

sumtypes brings algebraic data types to Python by implementing sum types (also called tagged unions), which let you define a type with multiple named constructor variants. Each variant can carry its own set of attributes. The package builds on attrs to provide attribute validation, defaults, and other features. You decorate a class with @sumtype, define constructors as class attributes, and then instantiate them by calling those constructors; the resulting objects track which constructor was used and can be pattern-matched over all cases.

The main use case is writing code that handles multiple distinct cases of a logical type in a type-safe, exhaustive way. Instead of using strings or integers to tag variants, sum types make the structure explicit and let the match decorator verify that all cases are handled. This is particularly useful in functional programming styles or when modeling domain logic with multiple states or alternatives.

Use it for

• Model domain types with multiple variants such as Result as Success or Failure, or AST nodes with different expression types
• Write exhaustive pattern-matching functions over all constructor cases without risk of missing a case
• Define state machines or state enums where each state can carry different associated data
• Implement functional-style error handling with explicit Success and Error constructors
• Build parsers or interpreters that need to represent different kinds of syntax tree nodes

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

sumtypes on PyPI

Before you install

Low install friction with a single runtime dependency on attrs. However, the package is abandoned as of 2021-11-30 with no commits since then, so maintenance and compatibility with modern Python versions are concerns.

License in practice

MIT license is permissive, allowing commercial and private use with minimal restrictions.

Quickstart

pip install sumtypes

from sumtypes import sumtype, constructor, match

@sumtype
class Color(object):
    Red = constructor()
    Green = constructor()
    Blue = constructor('intensity')

red = Color.Red()
blue = Color.Blue(42)

@match(Color)
class describe(object):
    def Red(): return 'red'
    def Green(): return 'green'
    def Blue(intensity): return 'blue'

Package facts

Evidence: sumtypes-0.1a6-py2.py3-none-any.whl

Tags

More Software Development packages

See also oslash · runtype · numerary · Expression · itypes · amplpy · typing-inspect · pampy · jsons · symengine