Skip to main content

Build Status

גamla is a performant functional programming library for python which supports async.

Installation

pip install gamla

Debugging anonymous compositions

gamla.debug

It is sometimes hard to debug pipelines because you can't place ordinary breakpoints. For this gamla.debug and gamla.debug_exception were created.

gamla.debug can be used within pipelines and provide a pdb breakpoint prompt where the value at this position can be referenced by x.

def increment(x):
    return x + 1

increment_twice = gamla.compose_left(increment, gamla.debug, increment)

increment_twice(1)

The above code will break with x being 2.

When you have a long pipeline and want to debug at each step of the way, you can use gamla.debug_compose and gamla.debug_compose_left.

gamla.debug_exception

In some cases tracking down an exception involves inspecting code that runs many times. Consider the following example:

def increment(x):
    return x + 1

def sometimes_has_a_bug(x):
    if x == 666:
        raise Exception
    return x

increment_with_bug = gamla.map(gamla.compose_left(increment, sometimes_has_a_bug))

tuple(inrement_with_bug(range(1000)))

Adding a gamla.debug here can be quite tedious, because the code will break many times.

Instead we can use gamla.debug_exception to break only in the case the inner function raises, at which case we would get a breakpoint prompt, and be able to inspect the value causing the exception, use the name x. This would like this:

increment_with_bug = gamla.map(gamla.compose_left(increment, gamla.debug_exception(sometimes_has_a_bug)))

One can also use gamla.debug_exception using a decorator.

@gamla.debug_exception
def sometimes_has_a_bug(x):
    if x == 666:
        raise Exception
    return x

Debug mode

gamla.compose(x, y, z) produces a new function which doesn't have a proper name. If x raises an exception, it is sometimes hard to figure out where this occurred. To overcome this, set the env variable GAMLA_DEBUG_MODE (to anything) to get more useful exceptions. This is turned on only by flag because it incurs significant overhead so things might get slow.

Mixing asynchronous and synchronous code

Most functions in this lib will work seamlessly with async and regular functions, and allow the developer to focus on the logic instead of deciding where to place an await.

For example:

import asyncio

import gamla


def increment(i):
    return i + 1


async def increment_async(i):
    asyncio.sleep(1)
    return i + 1


async def run():
    mixed_composition = gamla.compose_left(increment, increment_async, increment)
    return await mixed_composition(0)  # returns 3!

Migrating from toolz

The main problems - toolz is slow and does not support async functions.

Why are curried functions and composition in toolz slow?

These functions use an expensive inspect call to look at a function’s arguments, and doing so at each run.

Why does gamla not suffer from this problem?

Two reasons:

  1. It does not have binary signatures on things like map, so it doesn’t need to infer anything (these are higher order functions in gamla).
  2. The gamla.curry function eagerly pays for the signature inspection in advance, and remembers its results for future runs.

Function mapping and common gotchas:

Most functions are drop in replacements. Here are some examples:

  • curried.(filter|map|valmap|itemmap|keymap) -> gamla.$1 (make sure the call is with a single argument)
  • toolz.identity -> gamla.identity
  • toolz.contains -> gamla.contains
  • toolz.lt -> gamla.greater_than
  • toolz.gt -> gamla.less_than
  • toolz.ge -> gamla.less_equals
  • toolz.le -> gamla.greater_equals
  • toolz.filter(None) -> gamla.filter(gamla.identity)
  • toolz.excepts(a, b, c) -> gamla.excepts(a, c, b)
  • toolz.excepts(a, b) -> gamla.excepts(a, gamla.just(None), b) (following the “data-last” currying convention)

Releasing a new version

  1. Create a pypi account.
  2. Download twine and give it your pypi credentials.
  3. Get pypi permissions for the project from its owner.
  4. python setup.py sdist bdist_wheel; twine upload dist/*; rm -rf dist;

How to update gamla documentation after library update

If a new function was added

  1. Go to docs/api.rst and add your function name under the relevant module, with an indentation of 3 spaces. For example:
.. currentmodule:: gamla.functional_generic

.. autosummary::
   old_functions
   .
   .
   .
   my_new_function

If README.md was updated

While in gamla directory:

  1. Install md-to-rst converter: pip install m2r
  2. Convert README.md to README.rst: m2r README.md
  3. Move README.rst to docs/source folder instead of existing one: mv README.rst docs/source

If an existing function was updated

Do nothing. The documentation will update itself.

Metadata

Release files for gamla 68

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gamla 68
File Size Uploaded Provenance Actions
gamla-68.tar.gz 32.6 kB Without provenance Details for gamla-68.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gamla 68
File Interpreter ABI Platform Actions
gamla-68-py3-none-any.whl Python 3 none any Details for gamla-68-py3-none-any.whl

Total release size: 177.5 kB

Release files / gamla-68.tar.gz

Download URL gamla-68.tar.gz
Size 32.6 kB
Tags Source
SHA-256 checksum
How to use checksums
9aac959d66f5e47911d968b962b8ada7ed6614e4becca728cbe7ae9fdc857292
BLAKE2b-256 checksum
How to use checksums
15ff0e6ae70670b258833417c25dc82f7a1d067c2069fde85a678edc477dc444
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release files / gamla-68-py3-none-any.whl

Download URL gamla-68-py3-none-any.whl
Size 144.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
874bd33ca15e2bc05e2969b7938e915ddeddc054425935a8d77427a47dbcc577
BLAKE2b-256 checksum
How to use checksums
8218499260f24d4de28064661a33866b8c0fcc17a68d16efcbfc604646d46fee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Security for gamla 68

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

68 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page