Skip to main content

Simple python rate limiting object

Project description

Build Status

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 flavor:

>>> from ratelimiter import RateLimiter
>>> @RateLimiter(max_calls=10, period=1.0)
... def do_something():
...     pass
...

Context manager flavor:

>>> from ratelimiter import RateLimiter
>>> rate_limiter = RateLimiter(max_calls=10, period=1.0)
>>> for i in range(100):
...     with rate_limiter:
...         do_something()
...

Using with callback:

>>> from ratelimiter import RateLimiter
>>> import time
>>> def limited(until):
...     duration = int(round(until - time.time()))
...     print('Rate limited, sleeping for %d seconds' % duration)
...
>>> rate_limiter = RateLimiter(max_calls=2, period=3, callback=limited)
>>> for i in range(3):
...     with rate_limiter:
...         print('Iteration', i)
...
Iteration 0
Iteration 1
Rate limited, sleeping for 3 seconds
Iteration 2

License

Original work Copyright 2013 Arnaud Porterie
Modified work Copyright 2015 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-0.2.4.zip (8.4 kB view details)

Uploaded Source

Built Distribution

ratelimiter-0.2.4-py2.py3-none-any.whl (6.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ratelimiter-0.2.4.zip.

File metadata

  • Download URL: ratelimiter-0.2.4.zip
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ratelimiter-0.2.4.zip
Algorithm Hash digest
SHA256 a9331f800115bab587582cd63fffb0c079407cd349e9a1d4a864971f1348decd
MD5 1af0af5676aeb7b7753ad47ddd908d1e
BLAKE2b-256 1644c62ad8f5aec2dad3c39b8be134c2b3316ce550757139b55d996e3e54b76d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for ratelimiter-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 579ed7e3248ba6d2f874f83ab7522ec44bef303ab34a16b36896f6fe2d639b0b
MD5 93b5f8d16ee6b0ac1285d2a26e63e5b0
BLAKE2b-256 3f94fe7589c06e2ea7930db69d7fa4804b414acafbb68c869b1e67d07ef19e67

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