Skip to main content

Result and Option types for Python

Project description

patina

Documentation Status Supports Python 3.6 and up PyPI

This is an implementation of Rust's Result and Option types in Python. Most methods have been implemented, and the (very good) original documentation has been adapted into docstrings.

The documentation for this package can be read here. All doctests are run and type-checked as part of the CI pipeline as unit tests. The tests are direct ports of those in the Rust documentation.

Why?

2 reasons:

  • Python (in 3.10) now has pattern matching, wouldn't it be cool if we could make the most of that?
  • Sometimes it's nice to have types for your errors.
  • Being able to map over possible failure can be very powerful.

Check this out:

from patina import Some, None_

# This value is an Option[str]
maybe_value = api_call_that_might_produce_a_value()

match maybe_value.map(str.upper):  # Make it uppercase if it exists
    case Some(val):
        print("We got a val:", val)
    case None_():  # Don't forget the parentheses (otherwise it's binding a name)
        print("There was no val :(")

A similar thing can be done with the Result type (matching on Ok or Err). This can be handy if you want to be more explicit about the fact that a function might fail. If the function returns a Result, we can explicitly type the possible error values.

If this all sounds good, I recommend looking into functional programming, particularly of the ML variety (e.g. Haskell, OCaml, SML) or Rust.

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

patina-0.3.1.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

patina-0.3.1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file patina-0.3.1.tar.gz.

File metadata

  • Download URL: patina-0.3.1.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.0 Darwin/20.3.0

File hashes

Hashes for patina-0.3.1.tar.gz
Algorithm Hash digest
SHA256 d13f7675f36a67e52a3a4724e6602e3e423e0b3c8e00a763205a220d4dd0af16
MD5 acafde7679449d3e265ecd2968cd80a2
BLAKE2b-256 8c984e038899c7bb1ee54565a43c57fa66c721cb202d704b17d64e4b581bf0a7

See more details on using hashes here.

File details

Details for the file patina-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: patina-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.0 Darwin/20.3.0

File hashes

Hashes for patina-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a91e4baad2d71e3487c93de43ea593eae3e3d625d7a97437514d8f8ee2e34b2d
MD5 b74f8b723c17e39e4104fe1beee90ce2
BLAKE2b-256 689ae8ac930ae66619be521efe0a43f7342aa137445a6fce81cccf8cd5314b4e

See more details on using hashes here.

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