Skip to main content

An implementation of Data.Either from Haskell in Python

Project description

# pyeither

A functional Python library that exposes `Data.Either` from Haskell.

```haskell
data Either e a = Left e | Right a
```

## Example Usage

```python
import os
import json
import either

def main():
path = "~/myfile.json"

# Lift a normal value into Either
e_path = either.pure(path)

# Ensure the path is valid, returning Right(path) if it is or Left("not a file") if it isn't
e_valid = e_path.bind(either.predicate(os.path.isfile, "not a file"))

# Load a file as json, returning Right(contents) if it works, or Left(exc) if it doesn't
e_data = e_valid.bind(lambda p: either.attempt(json.load, p))

# It's annoying to assign intermediate values to variables, so you can chain expressions
# Equivalent to above:

e_data2 = (either.pure(path)
.bind(either.predicate(os.path.isfile, "not a file"))
.bind(lambda p: either.attempt(json.load, p)))

# Python lacks do-notation, so there's not a nice equivalent syntax

# Build pipelines of actions using monadic composition

ensure_path = either.predicate(os.path.isfile, "not a file")
load_file = lambda p: either.attempt(json.load, p)

process = either.kleisli(ensure_path, load_file)

# Equivalent to above:
e_data3 = either.pure(path).bind(process)
```

## Getting pyeither

```
pip install pyeither
```

## Motivation

I've created an IPython Notebook that describes the motivation for this project
as an interactive tutorial building an analogous system from scratch. If you're
interested in learning more about the **why** of this project, please check it
out!

[**Motivation Notebook**](https://github.com/SegFaultAX/pyeither/blob/master/pyeither_demo.ipynb)

## Special Thanks

This library depends on the absolutely wonderful
[`attrs`](http://www.attrs.org/en/stable/) library, without which there would
have been far more ugly boilerplate.

## License

Copyright 2018 Michael-Keith Bernard

See LICENSE.txt for the full license.

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

pyeither-0.1.1.tar.gz (7.6 kB view details)

Uploaded Source

File details

Details for the file pyeither-0.1.1.tar.gz.

File metadata

  • Download URL: pyeither-0.1.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyeither-0.1.1.tar.gz
Algorithm Hash digest
SHA256 94b81cfee95babe28e00ece54f376969d48e0721bc9ba109e90a5aa1e1393cbc
MD5 d97de96748459c7e04da707fc16f2894
BLAKE2b-256 03ebf3aa3a384c1e9548e77c24ecc81944b1076ad9fdfc343bc9237e45be2708

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page