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.2.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

ratelimiter-1.0.2-py2-none-any.whl (12.8 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for ratelimiter-1.0.2.tar.gz
Algorithm Hash digest
SHA256 2e6dcb33a80420a4a7c6934d0a3bb412de2d6ee4053493f22062ecf4484770e8
MD5 458738fc01c52e49958716ae74f9ba81
BLAKE2b-256 69ac0d06c8c88a49f3487010c2c10e2050d59b838d1214ddeeb6a22f12cb4de2

See more details on using hashes here.

Provenance

File details

Details for the file ratelimiter-1.0.2-py2-none-any.whl.

File metadata

File hashes

Hashes for ratelimiter-1.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 216022befa19998113aa2279dd837b6cca3e0bf30a466a54deafbbbc1d848166
MD5 0de1e369bd6d58a0dfe34a31bee6c0a5
BLAKE2b-256 a07eb107916602f0b7757535956e9fd63f53b91920d4a1f85fd8f8e7f3034b3c

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