Skip to main content

Python decorators for asyncio

Project description

aiodecorator

Python decorators for asyncio, including

  • throttle: Throttle a (coroutine) function that return an Awaitable

Install

$ pip install aiodecorator

Usage

import time
import asyncio

from aiodecorator import (
    throttle
)

now = time.time()


# -----------------------------------------------------
# The throttled function is only called twice a second
@throttle(2, 1)
async def throttled(index: int):
    diff = format(time.time - now, '.0f')
    print(index, f'{diff}s')
# -----------------------------------------------------


async def main():
    loop = asyncio.get_running_loop()
    tasks = [
        loop.create_task(throttled(index))
        for index in range(5)
    ]

    await asyncio.wait(tasks)


asyncio.run(main())

# Output
# 0 0s
# 1 0s
# 2 1s
# 3 1s
# 4 2s

APIs

throttle(limit: int, interval: Union[float, int])

  • limit int Maximum number of calls within an interval.
  • interval Union[int, float] Timespan for limit in seconds.

Returns a decorator function

License

MIT

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

aiodecorator-1.0.2.tar.gz (3.2 kB view hashes)

Uploaded source

Built Distribution

aiodecorator-1.0.2-py3-none-any.whl (3.9 kB view hashes)

Uploaded py3

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