Skip to main content

Simple python rate limiting object

Project description

PyPI Version Build Status Python Version License

Simple Python module providing rate limiting.

Overview

This package provides the ratelimiter module, which ensures that an operation will not be executed more than a given number of times on a given period. This can prove useful when working with third parties APIs which require for example a maximum of 10 requests per second.

Usage

Decorator

from ratelimiter import RateLimiter

@RateLimiter(max_calls=10, period=1)
def do_something():
    pass

Context Manager

from ratelimiter import RateLimiter

rate_limiter = RateLimiter(max_calls=10, period=1)

for i in range(100):
    with rate_limiter:
        do_something()

Callback

The callback is called in its own thread, so your callback may use sleep without delaying the rate limiter.

import time

from ratelimiter import RateLimiter

def limited(until):
    duration = int(round(until - time.time()))
    print('Rate limited, sleeping for {:d} seconds'.format(duration))

rate_limiter = RateLimiter(max_calls=2, period=3, callback=limited)

for i in range(3):
    with rate_limiter:
        print('Iteration', i)

Output:

Iteration 0
Iteration 1
Rate limited, sleeping for 3 seconds
Iteration 2

asyncio

The RateLimiter object can be used in an async with statement on Python 3.5+. Note that the callback must be a coroutine in this context. The coroutine callback is not called in a separate thread.

import asyncio
import time

from ratelimiter import RateLimiter

async def limited(until):
    duration = int(round(until - time.time()))
    print('Rate limited, sleeping for {:d} seconds'.format(duration))

async def coro():
    rate_limiter = RateLimiter(max_calls=2, period=3, callback=limited)
    for i in range(3):
        async with rate_limiter:
            print('Iteration', i)

loop = asyncio.get_event_loop()
loop.run_until_complete(coro())

License

Original work Copyright 2013 Arnaud Porterie
Modified work Copyright 2016 Frazer McLean

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the 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

ratelimiter-1.0.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

ratelimiter-1.0.1-py2.py3-none-any.whl (7.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ratelimiter-1.0.1.tar.gz.

File metadata

File hashes

Hashes for ratelimiter-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4c375759b326e99b7b96ecaae62826d1c37f285517ff0587399a67fc8deec474
MD5 3c098b301e2fcbf1df379874e3fda713
BLAKE2b-256 6a3c4f2d902e0f7c50c72b6049fbb13fd58dcb402df6cb30c32469d8eb750bf0

See more details on using hashes here.

Provenance

File details

Details for the file ratelimiter-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ratelimiter-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 75a21711455ef9908702e9123049e45e95aefd0a6117cd43973d55a0edd50a03
MD5 c48821c0848d776353023d7fcf4dcf95
BLAKE2b-256 a6065a11478db858734c7694ab2a94d1dc0f2cf8efa3c3ade69ca2bbcb8b9bcf

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