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

Uploaded Source

Built Distribution

more_executors-2.2.0-py2.py3-none-any.whl (46.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: more-executors-2.2.0.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.35.0 CPython/3.7.2

File hashes

Hashes for more-executors-2.2.0.tar.gz
Algorithm Hash digest
SHA256 3afa73dceda3d541b05c56c4e5ebbd8cededa9e0d57380eb5241aa3d6f2b582b
MD5 666dc519329f978409798138da2b43dc
BLAKE2b-256 5f2fcaf391c23a3e1dab8a5c04ae68fce1bb792a43899bfc530be5dcb28109be

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: more_executors-2.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 46.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.35.0 CPython/3.7.2

File hashes

Hashes for more_executors-2.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bc6d354b1f1788063118b8e20205de961b023df7acb1b774555dc96f42f5bee2
MD5 fb8a36243f18c3b67395b119c0a63b11
BLAKE2b-256 6b7f90f6ee812c6e51e8df6f455a788bc97188c3fff87c78472ffe87557c0bc5

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