Skip to main content

Throttles for Python coroutines.

Project description

https://img.shields.io/badge/license-BSD-blue.svg https://img.shields.io/pypi/v/aiothrottles.svg https://img.shields.io/pypi/pyversions/aiothrottles.svg https://readthedocs.org/projects/aiothrottles/badge/?version=latest https://travis-ci.org/KonstantinTogoi/aiothrottles.svg

aiothrottles

aiothrottles synchronization primitives are designed to be extension (along the time) to asyncio synchronization primitives.

aiothrottles has the following basic synchronization primitives:

  • Throttle

For more details, see aiothrottles Documentation.

Usage

Throttle implements a rate limiting for asyncio task. A throttle can be used to guarantee limited access to a shared resources.

The preferred way to use a Throttle is an async with statement:

throttle = Throttle('3/s')

# ... later
async with throttle:
    # access shared state

which is equivalent to:

throttle  = Throttle('3/s')

# ... later
await throttle.acquire()
try:
    # access shared state
finally:
    throttle.release()

A call rate is determined by the rate argument. Pass the rate in the following formats:

  • "{integer limit}/{unit time}"
  • "{limit's numerator}/{limit's denominator}{unit time}"

Examples:

  • 4/s, 5/m, 6/h, 7/d
  • 1/second, 2/minute, 3/hour, 4/day
  • 1/3s, 12/37m, 1/5h, 8/3d

Installation

pip install aiothrottles

or

python setup.py install

Supported Python Versions

Python 3.5, 3.6, 3.7 and 3.8 are supported.

Test

Run all tests.

python setup.py test

Run tests with PyTest.

python -m pytest [-k TEST_NAME] [-m MARKER]

License

aiothrottles is released under the BSD 3-Clause License.

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

aiothrottles-0.1.1.post1.tar.gz (4.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page