Skip to main content

A library of composable Python executors and futures

Project description

more-executors

Build Status Maintainability Test Coverage

This library is intended for use with the concurrent.futures module. It includes a collection of Executor implementations in order to extend the behavior of Future objects.

Features

  • Futures with implicit retry
  • Futures with implicit cancel on executor shutdown
  • Futures with implicit cancel after timeout
  • Futures with transformed output values (sync & async)
  • Futures resolved by a caller-provided polling function
  • Throttle the number of futures running at once
  • Synchronous executor
  • Bridge concurrent.futures with asyncio
  • Convenience API for creating executors
  • Instrumented with Prometheus

See the API documentation for detailed information on usage.

Example

This example combines the map and retry executors to create futures for HTTP requests running concurrently, decoding JSON responses within the future and retrying on error.

import requests
from concurrent.futures import as_completed
from more_executors import Executors


def get_json(response):
    response.raise_for_status()
    return (response.url, response.json())


def fetch_urls(urls):
    # Configure an executor:
    # - run up to 4 requests concurrently, in separate threads
    # - run get_json on each response
    # - retry up to several minutes on any errors
    executor = Executors.\
        thread_pool(max_workers=4).\
        with_map(get_json).\
        with_retry()

    # Submit requests for each given URL
    futures = [executor.submit(requests.get, url)
               for url in urls]

    # Futures API works as normal; we can block on the completed
    # futures and map/retry happens implicitly
    for future in as_completed(futures):
        (url, data) = future.result()
        do_something(url, data)

Development

virtualenv and pip may be used to locally install this project from source:

virtualenv ~/dev/python
. ~/dev/python/bin/activate

git clone https://github.com/rohanpm/more-executors
cd more-executors

pip install --editable .

Autotests may be run with pytest:

pip install -r test-requirements.txt
py.test

Submit pull requests against https://github.com/rohanpm/more-executors.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

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

more-executors-2.8.1.tar.gz (50.0 kB view details)

Uploaded Source

Built Distribution

more_executors-2.8.1-py2.py3-none-any.whl (69.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file more-executors-2.8.1.tar.gz.

File metadata

  • Download URL: more-executors-2.8.1.tar.gz
  • Upload date:
  • Size: 50.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.8.0 tqdm/4.61.2 CPython/3.8.5

File hashes

Hashes for more-executors-2.8.1.tar.gz
Algorithm Hash digest
SHA256 4438f60e79b713a6160e2d710d28379f5ae38c9ca45e2058665250ee2a15ab4b
MD5 cf2fa8a7a4a19758e2b10e2e4f432836
BLAKE2b-256 24980cb00bceb456d07b813c67f0429f7c0787ae3e31ba22c461dc439fabf2ba

See more details on using hashes here.

Provenance

File details

Details for the file more_executors-2.8.1-py2.py3-none-any.whl.

File metadata

  • Download URL: more_executors-2.8.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 69.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.8.0 tqdm/4.61.2 CPython/3.8.5

File hashes

Hashes for more_executors-2.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5d0be55f193a7667dd93852093737dffd797397e3097ade57a1110cf2382c713
MD5 d3312b7f5ca66ae068f5f4fd414a5503
BLAKE2b-256 fa0ba5b67f46a2af248d2c518c32c0b0357a37d9eda7fca452b9466eb0393d97

See more details on using hashes here.

Provenance

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