limits 4.7.2__tar.gz → 5.0.0rc1__tar.gz

{limits-4.7.2 → limits-5.0.0rc1}/HISTORY.rst

@@ -3,6 +3,22 @@
 Changelog
 =========
 
+v5.0.0rc1
+---------
+Release Date: 2025-04-09
+
+* Backward incompatible changes
+
+  * Dropped support for Fixed Window with Elastic Expiry strategy
+  * Dropped support for etcd
+  * Replaced async support for memached from :pypi:`emcache` to :pypi`:memcachio`
+
+* Performance
+
+  * Improved performance of in-memory moving window ``test`` and ``get_window_stats`` operations.
+  * Improved performance of redis moving window ``test`` and ``get_window_stats`` operations.
+  * Improved performance of mongodb moving window ``test`` and ``get_window_stats`` operations.
+
 v4.7.2
 ------
 Release Date: 2025-04-09
@@ -793,85 +809,3 @@ Release Date: 2015-01-08
 
 * Initial import of common rate limiting code from `Flask-Limiter <https://github.com/alisaifee/flask-limiter>`_
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

{limits-4.7.2 → limits-5.0.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 4.7.2
+Version: 5.0.0rc1
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee
@@ -32,19 +32,14 @@ Provides-Extra: memcached
 Requires-Dist: pymemcache<5.0.0,>3; extra == "memcached"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<5,>4.1; extra == "mongodb"
-Provides-Extra: etcd
-Requires-Dist: etcd3; extra == "etcd"
 Provides-Extra: valkey
 Requires-Dist: valkey>=6; extra == "valkey"
 Provides-Extra: async-redis
 Requires-Dist: coredis<5,>=3.4.0; extra == "async-redis"
 Provides-Extra: async-memcached
-Requires-Dist: emcache>=0.6.1; python_version < "3.11" and extra == "async-memcached"
-Requires-Dist: emcache>=1; (python_version >= "3.11" and python_version < "3.13.0") and extra == "async-memcached"
+Requires-Dist: memcachio>=0.3; extra == "async-memcached"
 Provides-Extra: async-mongodb
 Requires-Dist: motor<4,>=3; extra == "async-mongodb"
-Provides-Extra: async-etcd
-Requires-Dist: aetcd; extra == "async-etcd"
 Provides-Extra: async-valkey
 Requires-Dist: valkey>=6; extra == "async-valkey"
 Provides-Extra: all
@@ -52,13 +47,10 @@ Requires-Dist: redis!=4.5.2,!=4.5.3,<6.0.0,>3; extra == "all"
 Requires-Dist: redis!=4.5.2,!=4.5.3,>=4.2.0; extra == "all"
 Requires-Dist: pymemcache<5.0.0,>3; extra == "all"
 Requires-Dist: pymongo<5,>4.1; extra == "all"
-Requires-Dist: etcd3; extra == "all"
 Requires-Dist: valkey>=6; extra == "all"
 Requires-Dist: coredis<5,>=3.4.0; extra == "all"
-Requires-Dist: emcache>=0.6.1; python_version < "3.11" and extra == "all"
-Requires-Dist: emcache>=1; (python_version >= "3.11" and python_version < "3.13.0") and extra == "all"
+Requires-Dist: memcachio>=0.3; extra == "all"
 Requires-Dist: motor<4,>=3; extra == "all"
-Requires-Dist: aetcd; extra == "all"
 Requires-Dist: valkey>=6; extra == "all"
 Dynamic: author
 Dynamic: author-email
@@ -86,13 +78,14 @@ Dynamic: summary
 .. |docs| image:: https://readthedocs.org/projects/limits/badge/?version=latest
    :target: https://limits.readthedocs.org
 
+######
 limits
-------
+######
 |docs| |ci| |codecov| |pypi| |pypi-versions| |license|
 
 
 **limits** is a python library for rate limiting via multiple strategies
-with commonly used storage backends (Redis, Memcached, MongoDB & Etcd).
+with commonly used storage backends (Redis, Memcached & MongoDB).
 
 The library provides identical APIs for use in sync and
 `async <https://limits.readthedocs.io/en/stable/async.html>`_ codebases.
@@ -188,13 +181,13 @@ Scenario 2:
 - ``weighted_count = floor(8 + (4 * 0.33)) = floor(8 + 1.32) = 9``.
 - Since the weighted count is below the limit, the request is allowed.
 
+
 Storage backends
 ================
 
 - `Redis <https://limits.readthedocs.io/en/latest/storage.html#redis-storage>`_
 - `Memcached <https://limits.readthedocs.io/en/latest/storage.html#memcached-storage>`_
 - `MongoDB <https://limits.readthedocs.io/en/latest/storage.html#mongodb-storage>`_
-- `Etcd <https://limits.readthedocs.io/en/latest/storage.html#etcd-storage>`_
 - `In-Memory <https://limits.readthedocs.io/en/latest/storage.html#in-memory-storage>`_
 
 Dive right in

{limits-4.7.2 → limits-5.0.0rc1}/README.rst

@@ -11,13 +11,14 @@
 .. |docs| image:: https://readthedocs.org/projects/limits/badge/?version=latest
    :target: https://limits.readthedocs.org
 
+######
 limits
-------
+######
 |docs| |ci| |codecov| |pypi| |pypi-versions| |license|
 
 
 **limits** is a python library for rate limiting via multiple strategies
-with commonly used storage backends (Redis, Memcached, MongoDB & Etcd).
+with commonly used storage backends (Redis, Memcached & MongoDB).
 
 The library provides identical APIs for use in sync and
 `async <https://limits.readthedocs.io/en/stable/async.html>`_ codebases.
@@ -113,13 +114,13 @@ Scenario 2:
 - ``weighted_count = floor(8 + (4 * 0.33)) = floor(8 + 1.32) = 9``.
 - Since the weighted count is below the limit, the request is allowed.
 
+
 Storage backends
 ================
 
 - `Redis <https://limits.readthedocs.io/en/latest/storage.html#redis-storage>`_
 - `Memcached <https://limits.readthedocs.io/en/latest/storage.html#memcached-storage>`_
 - `MongoDB <https://limits.readthedocs.io/en/latest/storage.html#mongodb-storage>`_
-- `Etcd <https://limits.readthedocs.io/en/latest/storage.html#etcd-storage>`_
 - `In-Memory <https://limits.readthedocs.io/en/latest/storage.html#in-memory-storage>`_
 
 Dive right in

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/_static/custom.css

@@ -1,7 +1,7 @@
 .badges {
   display: flex;
   padding: 5px;
-  flex-direction: rootow;
+  flex-direction: row;
   justify-content: center;
 }
 .header-badge {

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/api.rst

@@ -28,7 +28,6 @@ a single parameter: a subclass of :class:`~limits.storage.Storage`.
 Provided by :mod:`limits.strategies`
 
 .. autoclass:: FixedWindowRateLimiter
-.. autoclass:: FixedWindowElasticExpiryRateLimiter
 .. autoclass:: MovingWindowRateLimiter
 .. autoclass:: SlidingWindowCounterRateLimiter
 
@@ -47,7 +46,6 @@ expose async variants and expect a subclass of :class:`limits.aio.storage.Storag
 Provided by :mod:`limits.aio.strategies`
 
 .. autoclass:: FixedWindowRateLimiter
-.. autoclass:: FixedWindowElasticExpiryRateLimiter
 .. autoclass:: MovingWindowRateLimiter
 .. autoclass:: SlidingWindowCounterRateLimiter
 
@@ -101,11 +99,6 @@ MongoDB Storage
 
 .. autoclass:: MongoDBStorage
 
-Etcd Storage
-^^^^^^^^^^^^
-
-.. autoclass:: EtcdStorage
-
 
 Async Storage
 -------------
@@ -144,11 +137,6 @@ Async MongoDB Storage
 
 .. autoclass:: MongoDBStorage
 
-Async Etcd Storage
-^^^^^^^^^^^^^^^^^^
-
-.. autoclass:: EtcdStorage
-
 Abstract storage classes
 ------------------------
 

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/async.rst

@@ -2,10 +2,8 @@
 Async Support
 =============
 
-.. versionadded:: 2.1
-
-A new namespace ``limits.aio`` is available which mirrors the original
-``limits.storage`` and ``limits.strategies`` packages.
+The namespace ``limits.aio``  mirrors ``limits.storage`` and ``limits.strategies``
+with async variants.
 
 The following async storage backends are implemented:
 
@@ -14,9 +12,8 @@ The following async storage backends are implemented:
   or `redis-py <https://redis-py.readthedocs.io>`_. Refer to
   :paramref:`limits.aio.storage.RedisStorage.implementation` for
   details on selecting the dependency)
-- Memcached (via `emcache <https://emcache.readthedocs.org>`_)
+- Memcached (via `memcachio <https://memcachio.readthedocs.org>`_)
 - MongoDB (via `motor <https://motor.readthedocs.org>`_)
-- Etcd (via `aetcd <https://aetcd.readthedocs.org>`_)
 
 Quick start
 ===========

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/conf.py

@@ -1,17 +1,14 @@
 #
+from __future__ import annotations
 
 import os
 import sys
 from pathlib import Path
 
-from docutils import nodes
-from sphinx.application import Sphinx
-from sphinx.util.docutils import SphinxDirective
-
 sys.path.insert(0, os.path.abspath("../../"))
 sys.path.insert(0, os.path.abspath("./"))
 
-from theme_config import *
+from theme_config import *  # noqa
 
 import limits
 
@@ -28,16 +25,18 @@ release = version
 
 
 if branch_from_env := os.environ.get("READTHEDOCS_VERSION", None):
+    branch_from_env = "master" if branch_from_env == "latest" else branch_from_env
     benchmark_git_context = {
         "branch": branch_from_env,
-        "sha": os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", "")
+        "sha": os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", ""),
     }
 else:
     import limits._version
+
     git_info = limits._version.git_pieces_from_vcs("", os.path.abspath("../../"), False)
     benchmark_git_context = {
         "branch": git_info.get("branch", ""),
-        "sha": git_info.get("long", None)
+        "sha": git_info.get("long", None),
     }
 
 html_static_path = ["_static"]
@@ -48,18 +47,19 @@ html_css_files = [
 ]
 
 html_title = f"{project} <small><b style='color: var(--color-brand-primary)'>{{{release}}}</b></small>"
+
 try:
     ahead = int(ahead)
     if ahead > 0:
-        html_theme_options[
+        html_theme_options[  # noqa
             "announcement"
         ] = f"""
         This is a development version. The documentation for the latest version: <b>{release}</b> can be found <a href="/en/stable">here</a>
         """
         html_title = f"{project} <small><b style='color: var(--color-brand-primary)'>{{dev}}</b></small>"
-except:
+except ValueError:
     pass
-sys.path.append(str(Path('ext').resolve()))
+sys.path.append(str(Path("ext").resolve()))
 
 extensions = [
     "sphinx.ext.autodoc",
@@ -93,18 +93,16 @@ autosectionlabel_prefix_document = True
 
 extlinks = {"pypi": ("https://pypi.org/project/%s", "%s")}
 
-copybutton_exclude = '.gp, .go'
+copybutton_exclude = ".gp, .go"
 
 intersphinx_mapping = {
     "python": ("http://docs.python.org/", None),
     "coredis": ("https://coredis.readthedocs.io/en/latest/", None),
-    "emcache": ("https://emcache.readthedocs.io/en/latest/", None),
+    "memcachio": ("https://memcachio.readthedocs.io/en/latest/", None),
     "motor": ("https://motor.readthedocs.io/en/stable/", None),
     "redis-py-cluster": ("https://redis-py-cluster.readthedocs.io/en/latest/", None),
     "redis-py": ("https://redis-py.readthedocs.io/en/latest/", None),
     "pymemcache": ("https://pymemcache.readthedocs.io/en/latest/", None),
     "pymongo": ("https://pymongo.readthedocs.io/en/stable/", None),
-    "python-etcd3": ("https://python-etcd3.readthedocs.io/en/latest/", None),
-    "aetcd": ("https://aetcd.readthedocs.io/en/latest/", None),
     "valkey-py": ("https://valkey-py.readthedocs.io/en/latest/", None),
 }

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/index.rst

@@ -18,7 +18,7 @@
 ----
 
 **limits** is a python library for rate limiting via multiple strategies
-with commonly used storage backends (Redis, Memcached, MongoDB & Etcd).
+with commonly used storage backends (Redis, Memcached & MongoDB).
 
 The library provides identical APIs for use in sync and
 :ref:`async <async:async support>`  codebases.
@@ -92,4 +92,5 @@ References
    - `Redis: rate limiting pattern #2 <http://redis.io/commands/INCR>`_
    - `DomainTools: redis rate limiter <https://github.com/DomainTools/rate-limit>`_
    - `Cloudflare: How we built rate limiting capable of scaling to millions of domains <https://blog.cloudflare.com/counting-things-a-lot-of-different-things/>`_
+
 .. include:: ../../CONTRIBUTIONS.rst

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/installation.rst

@@ -48,16 +48,6 @@ Install the package with pip:
 
    .. literalinclude:: ../../requirements/storage/mongodb.txt
 
-.. tab:: Etcd
-
-   .. code:: console
-
-      $ pip install limits[etcd]
-
-   Includes:
-
-   .. literalinclude:: ../../requirements/storage/etcd.txt
-
 .. tab:: Valkey
 
    .. code:: console
@@ -115,16 +105,6 @@ along with the package using the following extras:
 
    .. literalinclude:: ../../requirements/storage/async-mongodb.txt
 
-.. tab:: Etcd
-
-   .. code:: console
-
-      $ pip install limits[async-etcd]
-
-   Includes:
-
-   .. literalinclude:: ../../requirements/storage/async-etcd.txt
-
 .. tab:: Valkey
 
    .. code:: console

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/quickstart.rst

@@ -92,49 +92,64 @@ Test the limits
 Consume the limits
 ------------------
 
-.. code::
-
-    assert True == limiter.hit(one_per_minute, "test_namespace", "foo")
-    assert False == limiter.hit(one_per_minute, "test_namespace", "foo")
-    assert True == limiter.hit(one_per_minute, "test_namespace", "bar")
-
-    assert True == limiter.hit(one_per_second, "test_namespace", "foo")
-    assert False == limiter.hit(one_per_second, "test_namespace", "foo")
-    time.sleep(1)
-    assert True == limiter.hit(one_per_second, "test_namespace", "foo")
+.. code-block:: python-console
+
+    >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+    True
+    >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+    False
+    >>> limiter.hit(one_per_minute, "test_namespace", "bar")
+    True
+
+    >>> limiter.hit(one_per_second, "test_namespace", "foo")
+    True
+    >>> limiter.hit(one_per_second, "test_namespace", "foo")
+    False
+    >>> time.sleep(1)
+    >>> limiter.hit(one_per_second, "test_namespace", "foo")
+    True
 
 Check without consuming
 -----------------------
 
-.. code::
+.. code-block:: python-console
 
-    assert True == limiter.hit(one_per_second, "test_namespace", "foo")
-    while not limiter.test(one_per_second, "test_namespace", "foo"):
-        time.sleep(0.01)
-    assert True == limiter.hit(one_per_second, "test_namespace", "foo")
+    >>> limiter.hit(one_per_second, "test_namespace", "foo")
+    True
+    >>> while not limiter.test(one_per_second, "test_namespace", "foo"):
+    ...     time.sleep(0.01)
+    >>> limiter.hit(one_per_second, "test_namespace", "foo")
+    True
 
 Query available capacity and reset time
 -----------------------------------------
 
-.. code::
+.. code-block:: python-console
 
-   assert True == limiter.hit(one_per_minute, "test_namespace", "foo")
-   window = limiter.get_window_stats(one_per_minute, "test_namespace", "foo")
-   assert window.remaining == 0
-   assert False == limiter.hit(one_per_minute, "test_namespace", "foo")
-   time.sleep(window.reset_time - time.time())
-   assert True == limiter.hit(one_per_minute, "test_namespace", "foo")
+   >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+   True
+   >>> window = limiter.get_window_stats(one_per_minute, "test_namespace", "foo")
+   >>> window.remaining
+   0
+   >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+   False
+   >>> time.sleep(window.reset_time - time.time())
+   >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+   True
 
 
 Clear a limit
 =============
 
-.. code::
+.. code-block:: python-console
 
-    assert True == limiter.hit(one_per_minute, "test_namespace", "foo")
-    assert False == limiter.hit(one_per_minute, "test_namespace", "foo")
-    limiter.clear(one_per_minute, "test_namespace", "foo")
-    assert True == limiter.hit(one_per_minute, "test_namespace", "foo")
+    >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+    True
+    >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+    False
+    >>> limiter.clear(one_per_minute, "test_namespace", "foo")
+    >>> limiter.hit(one_per_minute, "test_namespace", "foo")
+    True
 
 
 

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/storage.rst

@@ -36,18 +36,10 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
         :pypi:`redis` can be used instead of :pypi:`coredis` by setting
         :paramref:`limits.aio.storage.RedisStorage.implementation` to ``redispy``
 
-   `Redis <https://redis.io>`_
+   `Redis Server <https://redis.io>`_
 
    .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SERVER_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
 
-   Redis with SSL
-
-   .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SERVER_SSL_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
-
-   `Redis Sentinel <https://redis.io/topics/sentinel>`_
-
-   .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SENTINEL_SERVER_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
-
 .. tab:: Redis Cluster
 
    Dependency versions:
@@ -63,7 +55,7 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
          :pypi:`redis` can be used instead of :pypi:`coredis` by setting
          :paramref:`limits.aio.storage.RedisClusterStorage.implementation` to ``redispy``
 
-   `Redis cluster <https://redis.io/topics/cluster-tutorial>`_
+   `Redis Cluster <https://redis.io/topics/cluster-tutorial>`_
 
    .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SERVER_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
 
@@ -95,20 +87,6 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
 
    .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_MONGODB_SERVER_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
 
-.. tab:: Etcd
-
-   Dependency versions:
-
-   .. literalinclude:: ../../requirements/storage/etcd.txt
-
-   Dependency versions (async):
-
-   .. literalinclude:: ../../requirements/storage/async-etcd.txt
-
-   `Etcd <https://www.etcd.io/>`_
-
-   .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_ETCD_SERVER_VERSION=[\d\.]+' | cut -d = -f 2 | sort --version-sort | uniq"
-
 .. tab:: Valkey
 
    Dependency versions:
@@ -246,20 +224,9 @@ Examples:
 
 Depends on: :pypi:`pymongo`
 
-Etcd Storage
-------------
-
-Requires the location of an etcd node
-
-Example: ``etcd://localhost:2379``
-
-Depends on: :pypi:`etcd3`
-
 Async Storage
 =============
 
-.. versionadded:: 2.1
-
 When using limits in an async code base the same uri schema can be used
 to query for an async implementation of the storage by prefixing the
 scheme with ``async+``.
@@ -271,7 +238,7 @@ For example:
 - ``async+redis+cluster://localhost:7000,localhost:7001``
 - ``async+redis+sentinel://:sekret@localhost:26379/my-redis-service``
 - ``async+memcached://localhost:11211``
-- ``async+etcd://localhost:2379``
+- ``async+mongodb://localhost:27017``
 - ``async+memory://``
 
 For implementation details of currently supported async backends refer to :ref:`api:async storage`

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/strategies.rst

@@ -41,17 +41,6 @@ For example, with a rate limit of 10 requests per minute:
    (e.g., combine a 2 requests per second limit with a 10 requests per minute limit).
 
 
-
-Fixed Window with Elastic Expiry
-==================================
-.. deprecated:: 4.1
-
-This variant extends the window’s expiry with each hit by resetting the timer on
-every request. Although designed to impose larger penalties for breaches, it is now
-deprecated and should not be used.
-
-
-
 Moving Window
 =============
 

{limits-4.7.2 → limits-5.0.0rc1}/doc/source/theme_config.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 colors = {
     "bg0": " #fbf1c7",
     "bg1": " #ebdbb2",

{limits-4.7.2 → limits-5.0.0rc1}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-09T14:27:52-0700",
+ "date": "2025-04-09T18:20:47-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "451bd270b52aff6324de3ed6576a8fc87fbdaf9a",
- "version": "4.7.2"
+ "full-revisionid": "4a01f1090a5accfb05b7db6dc6469f7c51d4fa67",
+ "version": "5.0.0rc1"
 }
 '''  # END VERSION_JSON
 

{limits-4.7.2 → limits-5.0.0rc1}/limits/aio/storage/__init__.py

@@ -6,14 +6,12 @@ Implementations of storage backends to be used with
 from __future__ import annotations
 
 from .base import MovingWindowSupport, SlidingWindowCounterSupport, Storage
-from .etcd import EtcdStorage
 from .memcached import MemcachedStorage
 from .memory import MemoryStorage
 from .mongodb import MongoDBStorage
 from .redis import RedisClusterStorage, RedisSentinelStorage, RedisStorage
 
 __all__ = [
-    "EtcdStorage",
     "MemcachedStorage",
     "MemoryStorage",
     "MongoDBStorage",

{limits-4.7.2 → limits-5.0.0rc1}/limits/aio/storage/base.py

@@ -75,16 +75,12 @@ class Storage(LazyDependency, metaclass=StorageRegistry):
         raise NotImplementedError
 
     @abstractmethod
-    async def incr(
-        self, key: str, expiry: int, elastic_expiry: bool = False, amount: int = 1
-    ) -> int:
+    async def incr(self, key: str, expiry: int, amount: int = 1) -> int:
         """
         increments the counter for a given rate limit key
 
         :param key: the key to increment
         :param expiry: amount in seconds for the key to expire in
-        :param elastic_expiry: whether to keep extending the rate limit
-         window every hit.
         :param amount: the number to increment by
         """
         raise NotImplementedError