https://github.com/depthbomb/waiter.py

A more efficient way of conforming to limits via waiting
https://github.com/depthbomb/waiter.py

Last synced: about 1 month ago
JSON representation

A more efficient way of conforming to limits via waiting

• Host: GitHub
• URL: https://github.com/depthbomb/waiter.py
• Owner: depthbomb
• License: mit
• Created: 2023-07-13T08:46:56.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-13T08:51:29.000Z (over 1 year ago)
• Last Synced: 2024-11-01T08:18:08.275Z (about 2 months ago)
• Language: Python
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# waiter.py

[![PyPI](https://img.shields.io/pypi/v/waiter.py?color=0073b7&label=version&logo=python&logoColor=white&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dd/waiter.py?color=0073b7&logo=python&logoColor=white&style=flat-square)](https://pypi.org/project/waiter.py/)

A more efficient way of conforming to limits via waiting

---

Think of _waiter_ as Python's built-in `sleep()` function but instead of sleeping every time it is called, it will only sleep if it **needs** to. This makes it easier to conform to known rate limits while avoiding unnecessary sleeps.

Let's assume you are consuming a REST API that has a rate limit of 2 requests per second. Naturally you could simply sleep for 500ms after each request as to not hit this limit. However what if you make one request, sleep for 500ms, do something else that takes longer than 500ms, make another request, and then sleep once more for 500ms? The last sleep would be unnecessary.

_waiter_ lets you create functions that will only sleep when needed:

```python

from waiter import create_waiter

wait = create_waiter(500)

make_quick_request()  # takes 10ms

wait()  # sleeps for 490ms

make_slow_request()  # takes 1000ms

wait()  # does not sleep

```

You can also decorate functions:

```python

from waiter.decorator import will_wait

@will_wait(500)

def my_func():

    #  ...

#  You know the drill

```