vickumar1981/pyeffects

Handle side-effects in Python like a boss. Implements functional types for Either, Option, Try, and Future.

pyeffects's Issues

Error with CI/CD on Python 3.11

As part of: #34

The 3.11 build/test action was disabled in the github actions. Running 3.11, gives an error ModuleNotFoundError: No module named 'typing_extensions.

Not sure what changed from the previous builds, particularly with the Pipfile. The only change was to update flake8 to black.

Expected Result

Enabling the 3.11 build in the github actions will run successfully.

Actual Result

Build complains that there is no module for typing-extensions.

Reproduction Steps

• Enable the 3.11 build in the github actions: https://github.com/vickumar1981/pyeffects/pull/34/files#diff-a0fe23534b616d51ce686d2a1bcd1a78bc75074aef1a2f6ee96c9469991e1a4cL20

and the github action checks succeed for all the builds.

Use asyncio instead of threading

The current Future implementation uses python's threading library, to maintain backwards compatibility with Python 2.

If Python 2 is no longer supported, then the class can instead use asyncio.

Add builds for python 3.7, 3.8 to tox setup and travis build

Add steps to run unit tests on python 3.7, and python 3.8 in the tox.ini file, and in the travis build.

Add `on_failure` callback to the `Try` class

Add an on_success callback to the Try class, so that you can call a function w/o returning a value, when the Try succeeds.

Add linters for the project

What do you think about adding several popular linters/formatters for this project, i.e. isort, black, flake8 (or ruff)?

Also, do you want to migrate to poetry from pipenv/tox/...?

Add support for case / data classes

Case classes were implemented in macropy, but AFAIK, this library isn't supported and doesn't work on Python 3. There's a lot in macropy, but the case class functionality is great for saving on boiler plate code.

https://macropy3.readthedocs.io/en/latest/case_classes.html

Add __str__ method to classes that can be initialized

Most of the classes already have an __repr__ for printing/debugging, but should move this to a __str__ method and have the repr function just call the str function.

Add .on_success to Future object

Add an on_success subscriber method. Should work like on_complete but only trigger the callback if the resulting Future is successful.

Compatibility with Type Hinting

Using type hinting, you can't specify the type parameter to any of the classes.

i.e.:

def find_person(id: int) -> Option:
    # pass

will work, but

def find_person(id: int) -> Option[string]:
    # doesn't work, should

will not work.

Expected Result

Expect to be able to pass the type parameters via type hinting. Python's Iterable and List do this, for example.

Actual Result

An exception is thrown: 'type' object is not subscriptable

Reproduction Steps

import pyeffects.Option.*

def find_person(id: int) -> Option[string]:
  pass

Add quick lambdas like macropy

Macropy doesn't look like it is supported yet on Python 3. Would like to use the quick lambdas.

https://macropy3.readthedocs.io/en/latest/quick_lambda.html

Add Documentation (Sphinx) for `on_failure` and `on_success` for both `Try` and `Future` classes

Now that we have on_success and on_failure working for Try and Future, we should add them to the Read the Docs.

https://github.com/vickumar1981/pyeffects/blob/master/docs/future.rst

https://github.com/vickumar1981/pyeffects/blob/master/docs/try.rst

Add `__eq__` so classes can be compared for equality

All implemented classes need to have a dunder __eq__ method so that they can be compared for equality.

Release 1.0.6 Build

Pending completion of:

#26
#24

I think we can release a 1.0.6 build.

Add coverage report to CI/CD

The project has recently switched to using Github actions over using Travis CI/CD: #22

We should add the step that generates the coverage report to the CI/CD for github actions and link the README to the test coverage results.

The command to generate a coverage.xml is make coverage, and you can also generate an HTML version using make coverhtml.

The line in the README.md should link to the coverage report for the master branch:

[![Build Status](https://api.travis-ci.com/vickumar1981/pyeffects.svg?branch=master)]

Add a collections Api: List, Set, and Map

Add classes for List, Set, and Map that wrap the python built-in list, set, and dict objects. Will extend the base Monad object and support map and flat_map operations, as well as other basic operations that can be wrapped by just calling the built-in methods.

Add an `on_failure` subscriber to `Future` class

Add an on_failure subscriber method for the Future class. Should work like on_complete but only trigger the callback if the resulting Future has failed.

Add `on_success` callback to `Try` class

Add an on_success callback to the Try class, so that you can call a function w/o returning a value, when the Try succeeds.