ratelimiter-1.2.0.post0/0000755000076500000240000000000013213621722015512 5ustar frazerstaff00000000000000ratelimiter-1.2.0.post0/LICENSE0000644000076500000240000002613613060603735016533 0ustar frazerstaff00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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. ratelimiter-1.2.0.post0/MANIFEST.in0000644000076500000240000000005513213621424017247 0ustar frazerstaff00000000000000include LICENSE recursive-include tests *.py ratelimiter-1.2.0.post0/PKG-INFO0000644000076500000240000001134713213621722016615 0ustar frazerstaff00000000000000Metadata-Version: 1.1 Name: ratelimiter Version: 1.2.0.post0 Summary: Simple python rate limiting object Home-page: https://github.com/RazerM/ratelimiter Author: Frazer McLean Author-email: frazer@frazermclean.co.uk License: Apache Description: RateLimiter =========== |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 ~~~~~~~~~ .. code:: python from ratelimiter import RateLimiter @RateLimiter(max_calls=10, period=1) def do_something(): pass Context Manager ~~~~~~~~~~~~~~~ .. code:: python 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. .. code:: python 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. .. code:: python 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. .. |PyPI Version| image:: http://img.shields.io/pypi/v/ratelimiter.svg?style=flat-square :target: https://pypi.python.org/pypi/ratelimiter .. |Build Status| image:: http://img.shields.io/travis/RazerM/ratelimiter/master.svg?style=flat-square :target: https://travis-ci.org/RazerM/ratelimiter .. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square :target: https://www.python.org/downloads/ .. |License| image:: http://img.shields.io/badge/license-Apache-blue.svg?style=flat-square :target: https://github.com/RazerM/ratelimiter/blob/master/LICENSE Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: License :: OSI Approved :: Apache Software License ratelimiter-1.2.0.post0/ratelimiter.egg-info/0000755000076500000240000000000013213621722021525 5ustar frazerstaff00000000000000ratelimiter-1.2.0.post0/ratelimiter.egg-info/dependency_links.txt0000644000076500000240000000000113213621722025573 0ustar frazerstaff00000000000000 ratelimiter-1.2.0.post0/ratelimiter.egg-info/PKG-INFO0000644000076500000240000001134713213621722022630 0ustar frazerstaff00000000000000Metadata-Version: 1.1 Name: ratelimiter Version: 1.2.0.post0 Summary: Simple python rate limiting object Home-page: https://github.com/RazerM/ratelimiter Author: Frazer McLean Author-email: frazer@frazermclean.co.uk License: Apache Description: RateLimiter =========== |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 ~~~~~~~~~ .. code:: python from ratelimiter import RateLimiter @RateLimiter(max_calls=10, period=1) def do_something(): pass Context Manager ~~~~~~~~~~~~~~~ .. code:: python 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. .. code:: python 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. .. code:: python 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. .. |PyPI Version| image:: http://img.shields.io/pypi/v/ratelimiter.svg?style=flat-square :target: https://pypi.python.org/pypi/ratelimiter .. |Build Status| image:: http://img.shields.io/travis/RazerM/ratelimiter/master.svg?style=flat-square :target: https://travis-ci.org/RazerM/ratelimiter .. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square :target: https://www.python.org/downloads/ .. |License| image:: http://img.shields.io/badge/license-Apache-blue.svg?style=flat-square :target: https://github.com/RazerM/ratelimiter/blob/master/LICENSE Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: License :: OSI Approved :: Apache Software License ratelimiter-1.2.0.post0/ratelimiter.egg-info/requires.txt0000644000076500000240000000010113213621722024115 0ustar frazerstaff00000000000000 [test] pytest>=3.0 [test:python_version>="3.5"] pytest-asyncio ratelimiter-1.2.0.post0/ratelimiter.egg-info/SOURCES.txt0000644000076500000240000000046413213621722023415 0ustar frazerstaff00000000000000LICENSE MANIFEST.in README.rst ratelimiter.py setup.py ratelimiter.egg-info/PKG-INFO ratelimiter.egg-info/SOURCES.txt ratelimiter.egg-info/dependency_links.txt ratelimiter.egg-info/requires.txt ratelimiter.egg-info/top_level.txt tests/__init__.py tests/conftest.py tests/test_aio.py tests/test_ratelimiter.pyratelimiter-1.2.0.post0/ratelimiter.egg-info/top_level.txt0000644000076500000240000000001413213621722024252 0ustar frazerstaff00000000000000ratelimiter ratelimiter-1.2.0.post0/ratelimiter.py0000644000076500000240000001125513213621443020411 0ustar frazerstaff00000000000000# 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. import collections import functools import threading import time import sys from textwrap import dedent try: import asyncio except ImportError: asyncio = None __author__ = 'Frazer McLean ' __version__ = '1.2.0.post0' __license__ = 'Apache' __description__ = 'Simple python rate limiting object' PY35 = sys.version_info >= (3, 5) class RateLimiter(object): """Provides rate limiting for an operation with a configurable number of requests for a time period. """ def __init__(self, max_calls, period=1.0, callback=None): """Initialize a RateLimiter object which enforces as much as max_calls operations on period (eventually floating) number of seconds. """ if period <= 0: raise ValueError('Rate limiting period should be > 0') if max_calls <= 0: raise ValueError('Rate limiting number of calls should be > 0') # We're using a deque to store the last execution timestamps, not for # its maxlen attribute, but to allow constant time front removal. self.calls = collections.deque() self.period = period self.max_calls = max_calls self.callback = callback self._lock = threading.Lock() self._alock = None # Lock to protect creation of self._alock self._init_lock = threading.Lock() def _init_async_lock(self): with self._init_lock: if self._alock is None: self._alock = asyncio.Lock() def __call__(self, f): """The __call__ function allows the RateLimiter object to be used as a regular function decorator. """ @functools.wraps(f) def wrapped(*args, **kwargs): with self: return f(*args, **kwargs) return wrapped def __enter__(self): with self._lock: # We want to ensure that no more than max_calls were run in the allowed # period. For this, we store the last timestamps of each call and run # the rate verification upon each __enter__ call. if len(self.calls) >= self.max_calls: until = time.time() + self.period - self._timespan if self.callback: t = threading.Thread(target=self.callback, args=(until,)) t.daemon = True t.start() sleeptime = until - time.time() if sleeptime > 0: time.sleep(sleeptime) return self def __exit__(self, exc_type, exc_val, exc_tb): with self._lock: # Store the last operation timestamp. self.calls.append(time.time()) # Pop the timestamp list front (ie: the older calls) until the sum goes # back below the period. This is our 'sliding period' window. while self._timespan >= self.period: self.calls.popleft() if PY35: # We have to exec this due to syntax errors on earlier versions. aenter_code = dedent(""" async def __aenter__(self): if self._alock is None: self._init_async_lock() with await self._alock: # We want to ensure that no more than max_calls were run in the allowed # period. For this, we store the last timestamps of each call and run # the rate verification upon each __enter__ call. if len(self.calls) >= self.max_calls: until = time.time() + self.period - self._timespan if self.callback: asyncio.ensure_future(self.callback(until)) sleeptime = until - time.time() if sleeptime > 0: await asyncio.sleep(sleeptime) return self """) exec(aenter_code) __aexit__ = asyncio.coroutine(__exit__) @property def _timespan(self): return self.calls[-1] - self.calls[0] ratelimiter-1.2.0.post0/README.rst0000644000076500000240000000657013213620564017214 0ustar frazerstaff00000000000000RateLimiter =========== |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 ~~~~~~~~~ .. code:: python from ratelimiter import RateLimiter @RateLimiter(max_calls=10, period=1) def do_something(): pass Context Manager ~~~~~~~~~~~~~~~ .. code:: python 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. .. code:: python 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. .. code:: python 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. .. |PyPI Version| image:: http://img.shields.io/pypi/v/ratelimiter.svg?style=flat-square :target: https://pypi.python.org/pypi/ratelimiter .. |Build Status| image:: http://img.shields.io/travis/RazerM/ratelimiter/master.svg?style=flat-square :target: https://travis-ci.org/RazerM/ratelimiter .. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square :target: https://www.python.org/downloads/ .. |License| image:: http://img.shields.io/badge/license-Apache-blue.svg?style=flat-square :target: https://github.com/RazerM/ratelimiter/blob/master/LICENSE ratelimiter-1.2.0.post0/setup.cfg0000644000076500000240000000007313213621722017333 0ustar frazerstaff00000000000000[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 ratelimiter-1.2.0.post0/setup.py0000644000076500000240000000306613213621015017224 0ustar frazerstaff00000000000000# 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. from setuptools import setup import re FILE = 'ratelimiter.py' init_data = open(FILE).read() metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", init_data)) AUTHOR_EMAIL = metadata['author'] VERSION = metadata['version'] LICENSE = metadata['license'] DESCRIPTION = metadata['description'] AUTHOR, EMAIL = re.match(r'(.*) <(.*)>', AUTHOR_EMAIL).groups() extras_require = dict() extras_require['test'] = { 'pytest>=3.0', } extras_require['test:python_version>="3.5"'] = {'pytest-asyncio'} setup( name='ratelimiter', version=VERSION, description=DESCRIPTION, long_description=open('README.rst').read(), author=AUTHOR, author_email=EMAIL, url='https://github.com/RazerM/ratelimiter', py_modules=['ratelimiter'], classifiers=[ 'Development Status :: 5 - Production/Stable', 'License :: OSI Approved :: Apache Software License', ], license=LICENSE, extras_require=extras_require) ratelimiter-1.2.0.post0/tests/0000755000076500000240000000000013213621722016654 5ustar frazerstaff00000000000000ratelimiter-1.2.0.post0/tests/__init__.py0000644000076500000240000000000013060603735020757 0ustar frazerstaff00000000000000ratelimiter-1.2.0.post0/tests/conftest.py0000644000076500000240000000067713121305572021065 0ustar frazerstaff00000000000000# coding: utf-8 from __future__ import absolute_import, division, print_function import sys import pytest class DummyCollector(pytest.collect.File): def collect(self): return [] def pytest_pycollect_makemodule(path, parent): # skip asyncio tests unless on Python 3.5+, because async/await # is a SyntaxError. if 'aio' in path.basename and sys.version_info < (3, 5): return DummyCollector(path, parent=parent) ratelimiter-1.2.0.post0/tests/test_aio.py0000644000076500000240000000047013121305572021036 0ustar frazerstaff00000000000000import pytest from ratelimiter import RateLimiter @pytest.mark.asyncio async def test_alock(): rl = RateLimiter(max_calls=10, period=0.01) assert rl._alock is None async with rl: pass alock = rl._alock assert alock async with rl: pass assert rl._alock is alock ratelimiter-1.2.0.post0/tests/test_ratelimiter.py0000644000076500000240000001223713121305572022613 0ustar frazerstaff00000000000000# Copyright 2013 Arnaud Porterie # # 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. import math import random import time import unittest import threading from ratelimiter import RateLimiter class Timer(object): def __enter__(self): self.start = time.time() return self def __exit__(self, exc_type, exc_value, exc_tb): self.stop = time.time() self.duration = self.stop - self.start class TestBasic(unittest.TestCase): period = 0.01 max_calls = 10 def setUp(self): random.seed() def validate_call_times(self, ts, max_calls, period): # Overall verification: total call duration should span over more than # the corresponding number of periods. timespan = math.ceil((ts[-1] - ts[0]) / period) self.assertGreaterEqual(max_calls, len(ts) / timespan) # Sliding verification: no group of 'max_calls' items should span over # less than a period. for i in range(len(ts) - max_calls): self.assertGreaterEqual(ts[i + max_calls] - ts[i], period) def test_bad_args(self): self.assertRaises(ValueError, RateLimiter, -1, self.period) self.assertRaises(ValueError, RateLimiter, +1, -self.period) def test_limit_1(self): with Timer() as timer: obj = RateLimiter(self.max_calls, self.period) for i in range(self.max_calls + 1): with obj: # After the 'self.max_calls' iteration the execution # inside the context manager should be blocked # for the 'self.period' seconds. pass # The sum of the time in the iterations without the rate limit blocking # is way lower than 'self.period'. If the duration of the all # iterations is greater or equal to the 'self.period' then blocking # and sleeping after the 'self.max_calls' iteration has been occured. self.assertGreaterEqual(timer.duration, self.period) def test_limit_2(self): calls = [] obj = RateLimiter(self.max_calls, self.period) for i in range(3 * self.max_calls): with obj: calls.append(time.time()) self.assertEqual(len(calls), 3 * self.max_calls) self.validate_call_times(calls, self.max_calls, self.period) def test_decorator_1(self): @RateLimiter(self.max_calls, self.period) def f(): # After the 'self.max_calls' iteration the execution # of the function should be blocked for the 'self.period' seconds. pass with Timer() as timer: [f() for i in range(self.max_calls + 1)] # The sum of the time in the iterations without the rate limit blocking # is way lower than 'self.period'. If the duration of the all # iterations is greater or equal to the 'self.period' then blocking # and sleeping after the 'self.max_calls' iteration has been occured. self.assertGreaterEqual(timer.duration, self.period) def test_decorator_2(self): @RateLimiter(self.max_calls, self.period) def f(): f.calls.append(time.time()) f.calls = [] [f() for i in range(3 * self.max_calls)] self.assertEqual(len(f.calls), 3 * self.max_calls) self.validate_call_times(f.calls, self.max_calls, self.period) def test_random(self): for _ in range(10): calls = [] obj = RateLimiter(self.max_calls, self.period) for i in range(random.randint(10, 50)): with obj: calls.append(time.time()) self.validate_call_times(calls, self.max_calls, self.period) def test_threading(self): @RateLimiter(self.max_calls, self.period) def f(): # After the 'self.max_calls' iteration the execution # of the function should be blocked for the 'self.period' seconds. pass with Timer() as timer: threads = [] for i in range(self.max_calls + 1): # Running each target in it's own thread should not affect # the rate limiting t = threading.Thread(target=f) threads.append(t) t.start() [t.join() for t in threads] # The sum of the time in the iterations without the rate limit blocking # is way lower than 'self.period'. If the duration of the all # iterations is greater or equal to the 'self.period' then blocking # and sleeping after the 'self.max_calls' iteration has been occured. self.assertGreaterEqual(timer.duration, self.period) if __name__ == "__main__": unittest.main()