pax_global_header00006660000000000000000000000064134055375300014517gustar00rootroot0000000000000052 comment=1cddcbd9708cdab583551f0bc5a0d40d7ed2eaa3 ratelimit-2.2.1/000077500000000000000000000000001340553753000135135ustar00rootroot00000000000000ratelimit-2.2.1/.gitignore000066400000000000000000000022271340553753000155060ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover .hypothesis/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # pyenv .python-version # celery beat schedule file celerybeat-schedule # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ ratelimit-2.2.1/.pylintrc000066400000000000000000000346311340553753000153670ustar00rootroot00000000000000[MASTER] # A comma-separated list of package or module names from where C extensions may # be loaded. Extensions are loading into the active Python interpreter and may # run arbitrary code extension-pkg-whitelist= # Add files or directories to the blacklist. They should be base names, not # paths. ignore=CVS # Add files or directories matching the regex patterns to the blacklist. The # regex matches against base names, not paths. ignore-patterns= # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). #init-hook= # Use multiple processes to speed up Pylint. jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. load-plugins= # Pickle collected data for later comparisons. persistent=yes # Specify a configuration file. #rcfile= # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no [MESSAGES CONTROL] # Only show warnings with the listed confidence levels. Leave empty to show # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED confidence= # Disable the message, report, category or checker with the given id(s). You # can either give multiple identifiers separated by comma (,) or put this # option multiple times (only on the command line, not in the configuration # file where it should appear only once).You can also use "--disable=all" to # disable everything first and then reenable specific checks. For example, if # you want to run only the similarities checker, you can use "--disable=all # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option # multiple time (only on the command line, not in the configuration file where # it should appear only once). See also the "--disable" option for examples. enable= [REPORTS] # Python expression which should return a note less than 10 (10 is the highest # note). You have access to the variables errors warning, statement which # respectively contain the number of errors / warnings messages and the total # number of statements analyzed. This is used by the global evaluation report # (RP0004). evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) # Template used to display messages. This is a python new-style format string # used to format the message information. See doc for all details #msg-template= # Set the output format. Available formats are text, parseable, colorized, json # and msvs (visual studio).You can also give a reporter class, eg # mypackage.mymodule.MyReporterClass. output-format=text # Tells whether to display a full report or only the messages reports=no # Activate the evaluation score. score=yes [REFACTORING] # Maximum number of nested blocks for function / method body max-nested-blocks=5 [BASIC] # Naming hint for argument names argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Naming hint for attribute names attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata # Naming hint for class attribute names class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ # Naming hint for class names class-name-hint=[A-Z_][a-zA-Z0-9]+$ # Regular expression matching correct class names class-rgx=[A-Z_][a-zA-Z0-9]+$ # Naming hint for constant names const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # Minimum line length for functions/classes that require docstrings, shorter # ones are exempt. docstring-min-length=-1 # Naming hint for function names function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Good variable names which should always be accepted, separated by a comma good-names=i,j,k,ex,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no # Naming hint for inline iteration names inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ # Naming hint for method names method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Naming hint for module names module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ # Colon-delimited sets of names that determine each other's naming style when # the name regexes allow several styles. name-group= # Regular expression which should only match function or class names that do # not require a docstring. no-docstring-rgx=^_ # List of decorators that produce properties, such as abc.abstractproperty. Add # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty # Naming hint for variable names variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ [FORMAT] # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. expected-line-ending-format= # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ # Number of spaces of indent required inside a hanging or continued line. indent-after-paren=4 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 # tab). indent-string=' ' # Maximum number of characters on a single line. max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 # List of optional constructs for which whitespace checking is disabled. `dict- # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. # `trailing-comma` allows a space between comma and closing bracket: (a, ). # `empty-line` allows space-only lines. no-space-check=trailing-comma,dict-separator # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no # Allow the body of an if to be on the same line as the test if there is no # else. single-line-if-stmt=no [LOGGING] # Logging modules to check that the string format arguments are in logging # function parameter format logging-modules=logging [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. notes=FIXME,XXX,TODO [SIMILARITIES] # Ignore comments when computing similarities. ignore-comments=yes # Ignore docstrings when computing similarities. ignore-docstrings=yes # Ignore imports when computing similarities. ignore-imports=no # Minimum lines number of a similarity. min-similarity-lines=4 [SPELLING] # Spelling dictionary name. Available dictionaries: none. To make it working # install python-enchant package. spelling-dict= # List of comma separated words that should not be checked. spelling-ignore-words= # A path to a file that contains private dictionary; one word per line. spelling-private-dict-file= # Tells whether to store unknown words to indicated private dictionary in # --spelling-private-dict-file option instead of raising a message. spelling-store-unknown-words=no [TYPECHECK] # List of decorators that produce context managers, such as # contextlib.contextmanager. Add to this list to register other decorators that # produce valid context managers. contextmanager-decorators=contextlib.contextmanager # List of members which are set dynamically and missed by pylint inference # system, and so shouldn't trigger E1101 when accessed. Python regular # expressions are accepted. generated-members= # Tells whether missing members accessed in mixin class should be ignored. A # mixin class is detected if its name ends with "mixin" (case insensitive). ignore-mixin-members=yes # This flag controls whether pylint should warn about no-member and similar # checks whenever an opaque object is returned when inferring. The inference # can return multiple potential results while evaluating a Python object, but # some branches might not be evaluated, which results in partial inference. In # that case, it might be useful to still emit no-member and other checks for # the rest of the inferred objects. ignore-on-opaque-inference=yes # List of class names for which member attributes should not be checked (useful # for classes with dynamically set attributes). This supports the use of # qualified names. ignored-classes=optparse.Values,thread._local,_thread._local # List of module names for which member attributes should not be checked # (useful for modules/projects where namespaces are manipulated during runtime # and thus existing member attributes cannot be deduced by static analysis. It # supports qualified module names, as well as Unix pattern matching. ignored-modules= # Show a hint with possible names when a member name was not found. The aspect # of finding the hint is based on edit distance. missing-member-hint=yes # The minimum edit distance a name should have in order to be considered a # similar match for a missing member name. missing-member-hint-distance=1 # The total number of similar names that should be taken in consideration when # showing a hint for a missing member. missing-member-max-choices=1 [VARIABLES] # List of additional names supposed to be defined in builtins. Remember that # you should avoid to define new builtins when possible. additional-builtins= # Tells whether unused global variables should be treated as a violation. allow-global-unused-variables=yes # List of strings which can identify a callback function by name. A callback # name must start or end with one of those strings. callbacks=cb_,_cb # A regular expression matching the name of dummy variables (i.e. expectedly # not used). dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ # Argument names that match this expression will be ignored. Default to name # with leading underscore ignored-argument-names=_.*|^ignored_|^unused_ # Tells whether we should check for unused import in __init__ files. init-import=no # List of qualified module names which can have objects that can redefine # builtins. redefining-builtins-modules=six.moves,future.builtins [CLASSES] # List of method names used to declare (i.e. assign) instance attributes. defining-attr-methods=__init__,__new__,setUp # List of member names, which should be excluded from the protected access # warning. exclude-protected=_asdict,_fields,_replace,_source,_make # List of valid names for the first argument in a class method. valid-classmethod-first-arg=cls # List of valid names for the first argument in a metaclass class method. valid-metaclass-classmethod-first-arg=mcs [DESIGN] # Maximum number of arguments for function / method max-args=5 # Maximum number of attributes for a class (see R0902). max-attributes=7 # Maximum number of boolean expressions in a if statement max-bool-expr=5 # Maximum number of branch for function / method body max-branches=12 # Maximum number of locals for function / method body max-locals=15 # Maximum number of parents for a class (see R0901). max-parents=7 # Maximum number of public methods for a class (see R0904). max-public-methods=20 # Maximum number of return / yield for function / method body max-returns=6 # Maximum number of statements in function / method body max-statements=50 # Minimum number of public methods for a class (see R0903). min-public-methods=2 [IMPORTS] # Allow wildcard imports from modules that define __all__. allow-wildcard-with-all=no # Analyse import fallback blocks. This can be used to support both Python 2 and # 3 compatible code, which means that the block might have code that exists # only in one or another interpreter, leading to false positives when analysed. analyse-fallback-blocks=no # Deprecated modules which should not be used, separated by a comma deprecated-modules=regsub,TERMIOS,Bastion,rexec # Create a graph of external dependencies in the given file (report RP0402 must # not be disabled) ext-import-graph= # Create a graph of every (i.e. internal and external) dependencies in the # given file (report RP0402 must not be disabled) import-graph= # Create a graph of internal dependencies in the given file (report RP0402 must # not be disabled) int-import-graph= # Force import order to recognize a module as part of the standard # compatibility libraries. known-standard-library= # Force import order to recognize a module as part of a third party library. known-third-party=enchant [EXCEPTIONS] # Exceptions that will emit a warning when being caught. Defaults to # "Exception" overgeneral-exceptions=Exception ratelimit-2.2.1/.travis.yml000066400000000000000000000032431340553753000156260ustar00rootroot00000000000000--- language: python python: - "2.7" - "3.2" sudo: false matrix: fast_finish: true allow_failures: - python: "3.2" script: - py.test notifications: email: false slack: secure: "FBQgSpZpjeEtfciTab0cxvezkD1PPxdPQ94fHmjqV44iaDY47ZyfODZBpjO6g2Bhhjq26YiFZjlzFjykh4H+YoWCTRzL7+ZBqomUSzLbeR75heyjAfK7+DM3t5PdET2ND5WnMSr/I2GeoKubC2lAAj35lCAWKQAp3EjW+5GDww90m0i+GOSa+btTYIkIQZcDxmcO8rJCe8+/LibEVRcQT7Xv7y/gMfIJOXceW/5DC62CdV4mas14raZn4ZVVCypbqOvv1kxQS4epfe0diYOxOprH6txJKb3MpJw0AHF5rFaZKU7NGb2+BI40OYl7tCE8V+7d3m5Cj+NdhTNeoMhGypT5IFvkQ8vRq4HYbR6NCbZcKw8K+ziY8Hog1PCB5YJGzMjHHtAGXqSp18nsBbiuwZ19+bq5X9Fzkpkzh7th13MEjhM1JUVU8K7U7sOkG3iVVmbMi7oN26sQnGShZ/pyGRQyW1ArvjLGVIII051oJgrWU1oSOXDQM8lcasPD7/+iHHiU8WBz5RaJM9Prh6HmIfpKkxL3llygwDmS0IMZDavVmvDmDq4SxxjkKergyPmTXyCAS6J30pO4aTPspOQU4bkgdv1XJ49euOtHjjXywyuPQZnq3+gtzTf2ewIhcecUkfUq1WXObfzd8rLiRvWIMDY/i0/hNdpsvNo/SYDyc2c=" deploy: provider: pypi user: tomasbasham password: secure: "LINWjh/St+8DuIIk3DPFvmt6+v4Y4fY+BgsE10vAc7xdsEEBkdizEksrfF6FyGPdfmasJT2y3ceutcUhqnZVfcSxY6dWO9BteQ5dY9Bgk8395G/sf1ta8vF9NjemvFWRFaqyowrEWPdPVKofIjoz28+HJvuPf7kNIffCjnikoLMHvdfCPp2VWe65e2J9SkPgbp+KR2xRneIRbh4IIPITZv0O3BnjVf04eJLHzTztUn+o3+Emzna23EFNUK9i6hixodMI6O1cDkMq3Cj2/hH+RXmTftpLnI8/38cB008rgSF/sW8aDGK1yOAprNAXnRGbSKOQN4NV74T/9vhZxV3rRzmgTpYejq9uqwuH+ial3xVV/e3j4UgK4OQAgykIwfLj3oWAq0TcAFdD8q0zfmM2ET2nXuP+m1NMRZEAhdnlU5KeDFt828/n+Qvy7nC51xwPO1Ka6rlWLcIrcj6S0A0IVdn+FbNbHy8IVYHAHNziXxySn4QV5jPTk5vRNcs9brBEzI6AjYU6qrJppOjZCxCYQV0fbg5++DPITbYyTJd6nbdfqPU4khmX2g2KPnLaSDXNEVF4UqntKkuqUpEsajOUbSwhRyeZ0IwNYdvs7Vp4QdNxPoHH5iuZHGMszfUj1vBUyljALUi1WxDBD+Ggjes44f/m8OEr87ZrvU9VIW+zGjE=" on: tags: true repo: tomasbasham/ratelimit ratelimit-2.2.1/LICENSE.txt000066400000000000000000000020671340553753000153430ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015 Tomas Basham Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ratelimit-2.2.1/MANIFEST.in000066400000000000000000000000471340553753000152520ustar00rootroot00000000000000include LICENSE.txt include README.rst ratelimit-2.2.1/README.rst000066400000000000000000000073321340553753000152070ustar00rootroot00000000000000ratelimit |build| |maintainability| =================================== .. |build| image:: https://travis-ci.org/tomasbasham/ratelimit.svg?branch=master :target: https://travis-ci.org/tomasbasham/ratelimit .. |maintainability| image:: https://api.codeclimate.com/v1/badges/21dc7c529c35cd7ef732/maintainability :target: https://codeclimate.com/github/tomasbasham/ratelimit/maintainability :alt: Maintainability APIs are a very common way to interact with web services. As the need to consume data grows, so does the number of API calls necessary to remain up to date with data sources. However many API providers constrain developers from making too many API calls. This is know as rate limiting and in a worst case scenario your application can be banned from making further API calls if it abuses these limits. This packages introduces a function decorator preventing a function from being called more often than that allowed by the API provider. This should prevent API providers from banning your applications by conforming to their rate limits. Installation ------------ PyPi ~~~~ To install ratelimit, simply: .. code:: bash $ pip install ratelimit GitHub ~~~~~~ Installing the latest version from Github: .. code:: bash $ git clone https://github.com/tomasbasham/ratelimit $ cd ratelimit $ python setup.py install Usage ----- To use this package simply decorate any function that makes an API call: .. code:: python from ratelimit import limits import requests FIFTEEN_MINUTES = 900 @limits(calls=15, period=FIFTEEN_MINUTES) def call_api(url): response = requests.get(url) if response.status_code != 200: raise Exception('API response: {}'.format(response.status_code)) return response This function will not be able to make more then 15 API call within a 15 minute time period. The arguments passed into the decorator describe the number of function invocation allowed over a specified time period (in seconds). If no time period is specified then it defaults to 15 minutes (the time window imposed by Twitter). If a decorated function is called more times than that allowed within the specified time period then a ``ratelimit.RateLimitException`` is raised. This may be used to implement a retry strategy such as an `expoential backoff `_ .. code:: python from ratelimit import limits, RateLimitException from backoff import on_exception, expo import requests FIFTEEN_MINUTES = 900 @on_exception(expo, RateLimitException, max_tries=8) @limits(calls=15, period=FIFTEEN_MINUTES) def call_api(url): response = requests.get(url) if response.status_code != 200: raise Exception('API response: {}'.format(response.status_code)) return response Alternatively to cause the current thread to sleep until the specified time period has ellapsed and then retry the function use the ``sleep_and_retry`` decorator. This ensures that every function invocation is successful at the cost of halting the thread. .. code:: python from ratelimit import limits, sleep_and_retry import requests FIFTEEN_MINUTES = 900 @sleep_and_retry @limits(calls=15, period=FIFTEEN_MINUTES) def call_api(url): response = requests.get(url) if response.status_code != 200: raise Exception('API response: {}'.format(response.status_code)) return response Contributing ------------ 1. Fork it (https://github.com/tomasbasham/ratelimit/fork) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request ratelimit-2.2.1/pytest.ini000066400000000000000000000002511340553753000155420ustar00rootroot00000000000000[pytest] norecursedirs = venv* .* addopts = -r fEsxXw -vvv --doctest-modules --ignore setup.py --cov-report=term-missing --cov-report=html --cov=ratelimit ratelimit-2.2.1/ratelimit/000077500000000000000000000000001340553753000155055ustar00rootroot00000000000000ratelimit-2.2.1/ratelimit/__init__.py000066400000000000000000000012461340553753000176210ustar00rootroot00000000000000''' Function decorator for rate limiting This module provides a functon decorator that can be used to wrap a function such that it will raise an exception if the number of calls to that function exceeds a maximum within a specified time window. For examples and full documentation see the README at https://github.com/tomasbasham/ratelimt ''' from ratelimit.decorators import RateLimitDecorator, sleep_and_retry from ratelimit.exception import RateLimitException limits = RateLimitDecorator rate_limited = RateLimitDecorator # For backwards compatibility __all__ = [ 'RateLimitException', 'limits', 'rate_limited', 'sleep_and_retry' ] __version__ = '2.2.1' ratelimit-2.2.1/ratelimit/decorators.py000066400000000000000000000104471340553753000202320ustar00rootroot00000000000000from functools import wraps from math import floor import time import sys import threading from ratelimit.exception import RateLimitException # Use monotonic time if available, otherwise fall back to the system clock. now = time.monotonic if hasattr(time, 'monotonic') else time.time class RateLimitDecorator(object): ''' Rate limit decorator class. ''' def __init__(self, calls=15, period=900, clock=now, raise_on_limit=True): ''' Instantiate a RateLimitDecorator with some sensible defaults. By default the Twitter rate limiting window is respected (15 calls every 15 minutes). :param int calls: Maximum function invocations allowed within a time period. Must be a number greater than 0. :param float period: An upper bound time period (in seconds) before the rate limit resets. Must be a number greater than 0. :param function clock: An optional function retuning the current time. This is used primarily for testing. :param bool raise_on_limit: A boolean allowing the caller to avoiding rasing an exception. ''' self.clamped_calls = max(1, min(sys.maxsize, floor(calls))) self.period = period self.clock = clock self.raise_on_limit = raise_on_limit # Initialise the decorator state. self.last_reset = clock() self.num_calls = 0 # Add thread safety. self.lock = threading.RLock() def __call__(self, func): ''' Return a wrapped function that prevents further function invocations if previously called within a specified period of time. :param function func: The function to decorate. :return: Decorated function. :rtype: function ''' @wraps(func) def wrapper(*args, **kargs): ''' Extend the behaviour of the decoated function, forwarding function invocations previously called no sooner than a specified period of time. The decorator will raise an exception if the function cannot be called so the caller may implement a retry strategy such as an exponential backoff. :param args: non-keyword variable length argument list to the decorated function. :param kargs: keyworded variable length argument list to the decorated function. :raises: RateLimitException ''' with self.lock: period_remaining = self.__period_remaining() # If the time window has elapsed then reset. if period_remaining <= 0: self.num_calls = 0 self.last_reset = self.clock() # Increase the number of attempts to call the function. self.num_calls += 1 # If the number of attempts to call the function exceeds the # maximum then raise an exception. if self.num_calls > self.clamped_calls: if self.raise_on_limit: raise RateLimitException('too many calls', period_remaining) return return func(*args, **kargs) return wrapper def __period_remaining(self): ''' Return the period remaining for the current rate limit window. :return: The remaing period. :rtype: float ''' elapsed = self.clock() - self.last_reset return self.period - elapsed def sleep_and_retry(func): ''' Return a wrapped function that rescues rate limit exceptions, sleeping the current thread until rate limit resets. :param function func: The function to decorate. :return: Decorated function. :rtype: function ''' @wraps(func) def wrapper(*args, **kargs): ''' Call the rate limited function. If the function raises a rate limit exception sleep for the remaing time period and retry the function. :param args: non-keyword variable length argument list to the decorated function. :param kargs: keyworded variable length argument list to the decorated function. ''' while True: try: return func(*args, **kargs) except RateLimitException as exception: time.sleep(exception.period_remaining) return wrapper ratelimit-2.2.1/ratelimit/exception.py000066400000000000000000000012011340553753000200470ustar00rootroot00000000000000class RateLimitException(Exception): ''' Rate limit exception class. ''' def __init__(self, message, period_remaining): ''' Custom exception raise when the number of function invocations exceeds that imposed by a rate limit. Additionally the exception is aware of the remaining time period after which the rate limit is reset. :param string message: Custom exception message. :param float period_remaining: The time remaining until the rate limit is reset. ''' super(RateLimitException, self).__init__(message) self.period_remaining = period_remaining ratelimit-2.2.1/requirements.txt000066400000000000000000000000561340553753000170000ustar00rootroot00000000000000pytest==2.6.4 pytest-cov==2.5.1 pylint==1.7.2 ratelimit-2.2.1/setup.py000066400000000000000000000016311340553753000152260ustar00rootroot00000000000000from setuptools import setup import ratelimit def readme(): '''Read README file''' with open('README.rst') as infile: return infile.read() setup( name='ratelimit', version=ratelimit.__version__, description='API rate limit decorator', long_description=readme().strip(), author='Tomas Basham', author_email='me@tomasbasham.co.uk', url='https://github.com/tomasbasham/ratelimit', license='MIT', packages=['ratelimit'], install_requires=[], keywords=[ 'ratelimit', 'api', 'decorator' ], classifiers=[ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Natural Language :: English', 'Programming Language :: Python', 'Topic :: Software Development' ], include_package_data=True, zip_safe=False ) ratelimit-2.2.1/tests/000077500000000000000000000000001340553753000146555ustar00rootroot00000000000000ratelimit-2.2.1/tests/__init__.py000066400000000000000000000004441340553753000167700ustar00rootroot00000000000000import unittest class Clock(object): def __init__(self): self.reset() def __call__(self): return self.now def reset(self): self.now = 0 def increment(self, num=1): self.now += num clock = Clock() __all__ = [ 'unittest', 'clock' ] ratelimit-2.2.1/tests/unit/000077500000000000000000000000001340553753000156345ustar00rootroot00000000000000ratelimit-2.2.1/tests/unit/__init__.py000066400000000000000000000000001340553753000177330ustar00rootroot00000000000000ratelimit-2.2.1/tests/unit/decorator_test.py000066400000000000000000000022101340553753000212220ustar00rootroot00000000000000from ratelimit import limits, RateLimitException from tests import unittest, clock class TestDecorator(unittest.TestCase): @limits(calls=1, period=10, clock=clock) def increment(self): ''' Increment the counter at most once every 10 seconds. ''' self.count += 1 @limits(calls=1, period=10, clock=clock, raise_on_limit=False) def increment_no_exception(self): ''' Increment the counter at most once every 10 seconds, but w/o rasing an exception when reaching limit. ''' self.count += 1 def setUp(self): self.count = 0 clock.increment(10) def test_increment(self): self.increment() self.assertEqual(self.count, 1) def test_exception(self): self.increment() self.assertRaises(RateLimitException, self.increment) def test_reset(self): self.increment() clock.increment(10) self.increment() self.assertEqual(self.count, 2) def test_no_exception(self): self.increment_no_exception() self.increment_no_exception() self.assertEqual(self.count, 1)