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

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.6.0.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

more_executors-2.6.0-py2.py3-none-any.whl (51.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: more-executors-2.6.0.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.8.0 tqdm/4.61.0 CPython/3.8.5

File hashes

Hashes for more-executors-2.6.0.tar.gz
Algorithm Hash digest
SHA256 96bfda4177d69698dfa468660ab2b506417fb76b8c0f84c4f55f26cb6b92778e
MD5 669e9edd87ff705b868a2ae1db6469e3
BLAKE2b-256 22fe60e321410223a82b2743f40c0b06f4951cabfe81623deea9240f927976ac

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for more_executors-2.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2781b89ec0066e656ac938a5aa8e5925825c78168ac4281d89f33cb98d68a0b9
MD5 921fb9352330ec47de669971139ead66
BLAKE2b-256 4e4aa61d61ffdecdd1cade0fd08da731500f8c2b42a2fc9d50a44f90f3f334d5

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