Skip to main content

Rusty 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.5.0.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

patina-0.5.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for patina-0.5.0.tar.gz
Algorithm Hash digest
SHA256 567924ed41492941b603aa23079a320a9b569fd283efa3e1b691e851175a989b
MD5 b2dc51cc65c4a77203d5c3e714a13518
BLAKE2b-256 35a147d96367925c74f0379a69fad33314ef8feafefa2420a430f23705b14404

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for patina-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2996598d41b1c85ff8c27598ef7227f11e33ec4f6927de33df3cf40d9197d96a
MD5 7186c2551cce08c7ab7eaf0af9e46205
BLAKE2b-256 75414da899901f19aa8800dab4c1326774309e764647a36770edc47943652d67

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