Rate-limiting for the requests library
Project description
Requests-Ratelimiter
This package is a thin wrapper around pyrate-limiter that adds convenient integration with the requests library.
Project documentation can be found at requests-ratelimiter.readthedocs.io.
Features
pyrate-limiter
implements the leaky bucket algorithm, supports multiple rate limits, and an optional Redis backendrequests-ratelimiter
can be used as a transport adapter, session, or session mixin for compatibility with otherrequests
-based libraries.- Rate limits can be automatically tracked separately per host, and different rate limits can be manually applied to different hosts
Installation
pip install requests-ratelimiter
Usage
Sessions
Example with LimiterSession
:
from requests import Session
from requests_ratelimiter import LimiterSession
# Apply a rate-limit (5 requests per second) to all requests
session = LimiterSession(per_second=5)
# Make rate-limited requests that stay within 5 requests per second
for _ in range(10):
response = session.get('https://httpbin.org/get')
print(response.json())
Adapters
Example with LimiterAdapter
:
from requests import Session
from requests_ratelimiter import LimiterAdapter
session = Session()
# Apply a rate-limit (5 requests per second) to all requests
adapter = LimiterAdapter(per_second=5)
session.mount('http://', adapter)
session.mount('https://', adapter)
# Make rate-limited requests
for user_id in range(100):
response = session.get(f'https://api.some_site.com/v1/users/{user_id}')
print(response.json())
Per-Host Rate Limits
With LimiterAdapter
, you can apply different rate limits to different hosts or URLs:
# Apply different rate limits (2/second and 100/minute) to a specific host
adapter_2 = LimiterAdapter(per_second=2, per_minute=100)
session.mount('https://api.some_site.com', adapter_2)
Behavior for matching requests is the same as other transport adapters: requests
will use the
adapter with the most specific (i.e., longest) URL prefix for a given request. For example:
session.mount('https://api.some_site.com/v1', adapter_3)
session.mount('https://api.some_site.com/v1/users', adapter_4)
# This request will use adapter_3
session.get('https://api.some_site.com/v1/')
# This request will use adapter_4
session.get('https://api.some_site.com/v1/users/1234')
Per-Host Rate Limit Tracking
With either LimiterSession
or LimiterAdapter
, you can automatically track rate limits separately
for each host; in other words, requests sent to one host will not count against the rate limit for
any other hosts. This can be enabled with the per_host
option:
session = LimiterSession(per_second=5, per_host=True)
# Make requests for two different hosts
for _ in range(10):
response = session.get(f'https://httpbin.org/get')
print(response.json())
session.get(f'https://httpbingo.org/get')
print(response.json())
Compatibility
There are many other useful libraries out there that add features to requests
, most commonly by
extending or modifying
requests.Session.
To use requests-ratelimiter
with one of these libraries, you have at least two options:
- Mount a
LimiterAdapter
on an instance of the library'sSession
class - Use
LimiterMixin
to create a customSession
class with features from both libraries
Requests-Cache
For example, to combine with requests-cache, which also includes a separate mixin class:
from pyrate_limiter import RedisBucket
from requests import Session
from requests_cache import CacheMixin, RedisCache
from requests_ratelimiter import LimiterMixin
class CachedLimiterSession(CacheMixin, LimiterMixin, Session):
"""Session class with caching and rate-limiting behavior. Accepts arguments for both
LimiterSession and CachedSession.
"""
# Optionally use Redis as both the bucket backend and the cache backend
session = CachedLimiterSession(
per_second=5,
bucket_class=RedisBucket,
backend=RedisCache(),
)
This example has an extra benefit: cache hits won't count against your rate limit!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for requests-ratelimiter-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c9271c9435eea9e50b87837c32c23dd6f421c8303cbf615e0b52ee5e640015a |
|
MD5 | b3c8e002ab77b88ff0022c4747294dd9 |
|
BLAKE2b-256 | 1f6bb5ee24a312e8a4020258ce45e41dad818dc849da7e4ebe150aa922e0535b |
Hashes for requests_ratelimiter-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67ddb03c86c12fd41c3c8c204ccaf72553459ba37ab73a2b99312447fcd1e34a |
|
MD5 | c2dc4eb6b8ad9c8fcb8d3d8e40ddccfa |
|
BLAKE2b-256 | d1ce48e2667d2621fba51a93cfd34ff013693bf6f8a73f3758a0c86b3ae5a3c3 |