Skip to main content

Dependent types for Python

Project description

dependent-types

Dependent types for Python.

Installation

python3 -m pip install dependent-types

Abstract

  • Make illegal states unrepresentable.
  • Abuse __instancecheck__ and type-guards.

Usage

Builtin types

dept.datetime

  • TZAware
  • TZNaive

dept.numeric

  • Natural
  • NegativeInt
  • Portion

dept.sized

  • NonEmpty
  • Empty

Creating dependent types

To create new dependent types, subclass dept.base.Dependent and define a __instancecheck__ method:

from typing import Any
from dept.base import Dependent


class StartsWithHello(str, Dependent[str]):
    def __instancecheck__(self, instance: Any) -> bool:
        return isinstance(instance, str) and instance.startswith("Hello")


isinstance("Hello there", StartsWithHello)  # True
isinstance("Hi there", StartsWithHello)  # False

Checkout out the dacite example for how to create dataclasses with rich dependently typed fields without duplicating type definitions or losing parsed information.

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

dependent-types-0.0.0.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

dependent_types-0.0.0-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

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