tenacity 8.2.3__tar.gz → 8.4.0__tar.gz

tenacity-8.4.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    groups:
+      github-actions:
+        patterns:
+          - '*'

{tenacity-8.2.3 → tenacity-8.4.0}/.github/workflows/ci.yaml

@@ -18,8 +18,6 @@ jobs:
     strategy:
       matrix:
         include:
-          - python: "3.7"
-            tox: py37
           - python: "3.8"
             tox: py38
           - python: "3.9"
@@ -28,22 +26,23 @@ jobs:
             tox: py310
           - python: "3.11"
             tox: py311
-          - python: "3.11"
+          - python: "3.12"
+            tox: py312,py312-trio
+          - python: "3.12"
             tox: pep8
-          - python: "3.11"
-            tox: black-ci
           - python: "3.11"
             tox: mypy
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.6
         with:
           fetch-depth: 0
 
       - name: Setup Python 🔧
-        uses: actions/setup-python@v4.5.0
+        uses: actions/setup-python@v5.1.0
         with:
-          python-version: ${{ matrix.python }}
+          python-version: ${{ matrix.python }}
+          allow-prereleases: true
 
       - name: Build 🔧 & Test 🔍
         run: |

{tenacity-8.2.3 → tenacity-8.4.0}/.github/workflows/deploy.yaml

@@ -1,21 +1,22 @@
 name: Release deploy
 
 on:
-  push:
-    tags:
+  release:
+    types:
+      - published
 
 jobs:
-  test:
+  publish:
     timeout-minutes: 20
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.6
         with:
           fetch-depth: 0
 
       - name: Setup Python 🔧
-        uses: actions/setup-python@v4.5.0
+        uses: actions/setup-python@v5.1.0
         with:
           python-version: 3.11
 

tenacity-8.4.0/.mergify.yml

@@ -0,0 +1,41 @@
+queue_rules:
+  - name: default
+    merge_method: squash
+    queue_conditions:
+      - or:
+        - author = jd
+        - "#approved-reviews-by >= 1"
+        - author = dependabot[bot]
+      - or:
+        - files ~= ^releasenotes/notes/
+        - label = no-changelog
+        - author = dependabot[bot]
+      - "check-success=test (3.8, py38)"
+      - "check-success=test (3.9, py39)"
+      - "check-success=test (3.10, py310)"
+      - "check-success=test (3.11, py311)"
+      - "check-success=test (3.12, py312,py312-trio)"
+      - "check-success=test (3.12, pep8)"
+
+pull_request_rules:
+  - name: warn on no changelog
+    conditions:
+      - -files~=^releasenotes/notes/
+      - label!=no-changelog
+      - -closed
+    actions:
+      comment:
+        message: >
+          ⚠️ No release notes detected. Please make sure to use
+          [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add
+          a changelog entry.
+
+  - name: automatic queue
+    conditions: []
+    actions:
+      queue:
+
+  - name: dismiss reviews
+    conditions: []
+    actions:
+      dismiss_reviews: {}

{tenacity-8.2.3/tenacity.egg-info → tenacity-8.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tenacity
-Version: 8.2.3
+Version: 8.4.0
 Summary: Retry code until it succeeds
 Home-page: https://github.com/jd/tenacity
 Author: Julien Danjou
@@ -11,14 +11,15 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Provides-Extra: doc
+Provides-Extra: test
 License-File: LICENSE
 
 Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.

{tenacity-8.2.3 → tenacity-8.4.0}/README.rst

@@ -79,7 +79,7 @@ Examples
 Basic Retry
 ~~~~~~~~~~~
 
-.. testsetup:: *
+.. testsetup::
 
     import logging
     #
@@ -124,6 +124,16 @@ retrying stuff.
         print("Stopping after 10 seconds")
         raise Exception
 
+If you're on a tight deadline, and exceeding your delay time isn't ok, 
+then you can give up on retries one attempt before you would exceed the delay. 
+
+.. testcode::
+
+    @retry(stop=stop_before_delay(10))
+    def stop_before_10_s():
+        print("Stopping 1 attempt before 10 seconds")
+        raise Exception
+
 You can combine several stop conditions by using the `|` operator:
 
 .. testcode::
@@ -402,43 +412,7 @@ without raising an exception (or you can re-raise or do anything really)
 RetryCallState
 ~~~~~~~~~~~~~~
 
-``retry_state`` argument is an object of `RetryCallState` class:
-
-.. autoclass:: tenacity.RetryCallState
-
-   Constant attributes:
-
-   .. autoattribute:: start_time(float)
-      :annotation:
-
-   .. autoattribute:: retry_object(BaseRetrying)
-      :annotation:
-
-   .. autoattribute:: fn(callable)
-      :annotation:
-
-   .. autoattribute:: args(tuple)
-      :annotation:
-
-   .. autoattribute:: kwargs(dict)
-      :annotation:
-
-   Variable attributes:
-
-   .. autoattribute:: attempt_number(int)
-      :annotation:
-
-   .. autoattribute:: outcome(tenacity.Future or None)
-      :annotation:
-
-   .. autoattribute:: outcome_timestamp(float or None)
-      :annotation:
-
-   .. autoattribute:: idle_for(float)
-      :annotation:
-
-   .. autoattribute:: next_action(tenacity.RetryAction or None)
-      :annotation:
+``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.
 
 Other Custom Callbacks
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -447,33 +421,33 @@ It's also possible to define custom callbacks for other keyword arguments.
 
 .. function:: my_stop(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: whether or not retrying should stop
    :rtype: bool
 
 .. function:: my_wait(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: number of seconds to wait before next retry
    :rtype: float
 
 .. function:: my_retry(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: whether or not retrying should continue
    :rtype: bool
 
 .. function:: my_before(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 .. function:: my_after(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 .. function:: my_before_sleep(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 Here's an example with a custom ``before_sleep`` function:
 
@@ -594,28 +568,34 @@ in retry strategies like ``retry_if_result``. This can be done accessing the
 Async and retry
 ~~~~~~~~~~~~~~~
 
-Finally, ``retry`` works also on asyncio and Tornado (>= 4.5) coroutines.
+Finally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.
 Sleeps are done asynchronously too.
 
 .. code-block:: python
 
     @retry
-    async def my_async_function(loop):
+    async def my_asyncio_function(loop):
         await loop.getaddrinfo('8.8.8.8', 53)
 
+.. code-block:: python
+
+    @retry
+    async def my_async_trio_function():
+        await trio.socket.getaddrinfo('8.8.8.8', 53)
+
 .. code-block:: python
 
     @retry
     @tornado.gen.coroutine
-    def my_async_function(http_client, url):
+    def my_async_tornado_function(http_client, url):
         yield http_client.fetch(url)
 
-You can even use alternative event loops such as `curio` or `Trio` by passing the correct sleep function:
+You can even use alternative event loops such as `curio` by passing the correct sleep function:
 
 .. code-block:: python
 
-    @retry(sleep=trio.sleep)
-    async def my_async_function(loop):
+    @retry(sleep=curio.sleep)
+    async def my_async_curio_function():
         await asks.get('https://example.org')
 
 Contribute

{tenacity-8.2.3 → tenacity-8.4.0}/doc/source/api.rst

@@ -17,6 +17,9 @@ Retry Main API
 .. autoclass:: tenacity.tornadoweb.TornadoRetrying
    :members:
 
+.. autoclass:: tenacity.RetryCallState
+   :members:
+
 After Functions
 ---------------
 

{tenacity-8.2.3 → tenacity-8.4.0}/doc/source/index.rst

@@ -79,7 +79,7 @@ Examples
 Basic Retry
 ~~~~~~~~~~~
 
-.. testsetup:: *
+.. testsetup::
 
     import logging
     #
@@ -124,6 +124,16 @@ retrying stuff.
         print("Stopping after 10 seconds")
         raise Exception
 
+If you're on a tight deadline, and exceeding your delay time isn't ok, 
+then you can give up on retries one attempt before you would exceed the delay. 
+
+.. testcode::
+
+    @retry(stop=stop_before_delay(10))
+    def stop_before_10_s():
+        print("Stopping 1 attempt before 10 seconds")
+        raise Exception
+
 You can combine several stop conditions by using the `|` operator:
 
 .. testcode::
@@ -402,43 +412,7 @@ without raising an exception (or you can re-raise or do anything really)
 RetryCallState
 ~~~~~~~~~~~~~~
 
-``retry_state`` argument is an object of `RetryCallState` class:
-
-.. autoclass:: tenacity.RetryCallState
-
-   Constant attributes:
-
-   .. autoattribute:: start_time(float)
-      :annotation:
-
-   .. autoattribute:: retry_object(BaseRetrying)
-      :annotation:
-
-   .. autoattribute:: fn(callable)
-      :annotation:
-
-   .. autoattribute:: args(tuple)
-      :annotation:
-
-   .. autoattribute:: kwargs(dict)
-      :annotation:
-
-   Variable attributes:
-
-   .. autoattribute:: attempt_number(int)
-      :annotation:
-
-   .. autoattribute:: outcome(tenacity.Future or None)
-      :annotation:
-
-   .. autoattribute:: outcome_timestamp(float or None)
-      :annotation:
-
-   .. autoattribute:: idle_for(float)
-      :annotation:
-
-   .. autoattribute:: next_action(tenacity.RetryAction or None)
-      :annotation:
+``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.
 
 Other Custom Callbacks
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -447,33 +421,33 @@ It's also possible to define custom callbacks for other keyword arguments.
 
 .. function:: my_stop(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: whether or not retrying should stop
    :rtype: bool
 
 .. function:: my_wait(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: number of seconds to wait before next retry
    :rtype: float
 
 .. function:: my_retry(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
    :return: whether or not retrying should continue
    :rtype: bool
 
 .. function:: my_before(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 .. function:: my_after(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 .. function:: my_before_sleep(retry_state)
 
-   :param RetryState retry_state: info about current retry invocation
+   :param RetryCallState retry_state: info about current retry invocation
 
 Here's an example with a custom ``before_sleep`` function:
 
@@ -594,28 +568,34 @@ in retry strategies like ``retry_if_result``. This can be done accessing the
 Async and retry
 ~~~~~~~~~~~~~~~
 
-Finally, ``retry`` works also on asyncio and Tornado (>= 4.5) coroutines.
+Finally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.
 Sleeps are done asynchronously too.
 
 .. code-block:: python
 
     @retry
-    async def my_async_function(loop):
+    async def my_asyncio_function(loop):
         await loop.getaddrinfo('8.8.8.8', 53)
 
+.. code-block:: python
+
+    @retry
+    async def my_async_trio_function():
+        await trio.socket.getaddrinfo('8.8.8.8', 53)
+
 .. code-block:: python
 
     @retry
     @tornado.gen.coroutine
-    def my_async_function(http_client, url):
+    def my_async_tornado_function(http_client, url):
         yield http_client.fetch(url)
 
-You can even use alternative event loops such as `curio` or `Trio` by passing the correct sleep function:
+You can even use alternative event loops such as `curio` by passing the correct sleep function:
 
 .. code-block:: python
 
-    @retry(sleep=trio.sleep)
-    async def my_async_function(loop):
+    @retry(sleep=curio.sleep)
+    async def my_async_curio_function():
         await asks.get('https://example.org')
 
 Contribute

{tenacity-8.2.3 → tenacity-8.4.0}/pyproject.toml

@@ -8,14 +8,14 @@ requires = [
 ]
 build-backend="setuptools.build_meta"
 
-[tool.black]
-line-length = 120
-safe = true
-target-version = ["py37", "py38", "py39", "py310", "py311"]
+[tool.ruff]
+line-length = 88
+indent-width = 4
+target-version = "py38"
 
 [tool.mypy]
 strict = true
-files = ["tenacity"]
+files = ["tenacity", "tests"]
 show_error_codes = true
 
 [[tool.mypy.overrides]]

tenacity-8.4.0/releasenotes/notes/add-async-actions-b249c527d99723bb.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Added the ability to use async functions for retries. This way, you can now use
+    asyncio coroutines for retry strategy predicates.

tenacity-8.4.0/releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Added a new stop function: stop_before_delay, which will stop execution
+    if the next sleep time would cause overall delay to exceed the specified delay. 
+    Useful for use cases where you have some upper bound on retry times that you must
+    not exceed, so returning before that timeout is preferable than returning after that timeout.

tenacity-8.4.0/releasenotes/notes/add-test-extra-55e869261b03e56d.yaml

@@ -0,0 +1,3 @@
+---
+other:
+  - Add a \"test\" extra

tenacity-8.4.0/releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml

@@ -0,0 +1,5 @@
+---
+other:
+  - |
+    Add a Dependabot configuration submit PRs monthly (as needed)
+    to keep GitHub action versions updated.

tenacity-8.4.0/releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Preserve __defaults__ and __kwdefaults__ through retry decorator

tenacity-8.4.0/releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    If you're using `Trio <https://trio.readthedocs.io>`__, then
+    ``@retry`` now works automatically. It's no longer necessary to
+    pass ``sleep=trio.sleep``.

{tenacity-8.2.3 → tenacity-8.4.0}/setup.cfg

@@ -13,16 +13,16 @@ classifier =
 	Programming Language :: Python
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.7
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 	Topic :: Utilities
 
 [options]
 install_requires = 
-python_requires = >=3.7
+python_requires = >=3.8
 packages = tenacity
 
 [options.packages.find]
@@ -35,7 +35,10 @@ tenacity = py.typed
 doc = 
 	reno
 	sphinx
+test = 
+	pytest
 	tornado>=4.5
+	typeguard
 
 [tool:pytest]
 filterwarnings =