Merge branch 'main' into monotonic

Author: edgarrmondragon

.github/workflows/ci.yaml

@@ -35,6 +35,7 @@ jobs:
         - "3.12"
         - "3.13"
         - "3.14"
+        - "3.15"
         include:
         - os: ubuntu-22.04
           python-version: "3.7"
@@ -49,7 +50,7 @@ jobs:
           allow-prereleases: true
 
       - name: Install uv
-        uses: astral-sh/setup-uv@4959332f0f014c5280e7eac8b70c90cb574c9f9b # v6.6.0
+        uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6 # v6.6.1
 
       - name: Run tests
         run: uvx --with tox-gh --with tox-uv tox
@@ -79,7 +80,7 @@ jobs:
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
 
       - name: Install uv
-        uses: astral-sh/setup-uv@4959332f0f014c5280e7eac8b70c90cb574c9f9b # v6.6.0
+        uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6 # v6.6.1
 
       - name: Combine coverage data and generate report
         run: uvx --with tox-uv tox -e coverage

.github/workflows/codeql-analysis.yml

@@ -14,6 +14,11 @@ on:
   schedule:
     - cron: '0 5 * * 6'
 
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
 jobs:
   analyze:
     name: Analyze
@@ -43,7 +48,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.11
+      uses: github/codeql-action/init@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d # v3.30.0
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +59,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.11
+      uses: github/codeql-action/autobuild@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d # v3.30.0
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -68,4 +73,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.11
+      uses: github/codeql-action/analyze@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d # v3.30.0

.gitignore

@@ -8,6 +8,5 @@ dist/
 .cache/
 *.egg-info
 .vscode
-.python-version
 .tox/
 coverage.xml

.python-version

@@ -0,0 +1 @@
+3.14

CHANGELOG.md

@@ -2,12 +2,20 @@
 
 ## Unreleased
 
-- Adapt test cases to pytest-asyncio 1.0 compatibility https://github.com/python-backoff/backoff/pull/1 (from @pastalian)
+### Fixed
+
 - Use `inspect.iscoroutinefunction` instead of `asyncio.iscoroutinefunction` to avoid Python 3.14 deprecation warning https://github.com/python-backoff/backoff/pull/3 (from @edgarrmondragon)
-- Use uv for dependencies and packaging https://github.com/python-backoff/backoff/pull/7 (from @edgarrmondragon)
+- Adapt test cases to pytest-asyncio 1.0 compatibility https://github.com/python-backoff/backoff/pull/1 (from @pastalian)
 - Include tests in source distribution https://github.com/python-backoff/backoff/pull/13 (from @edgarrmondragon)
+- Added `logging.LoggerAdapter` to `_MaybeLogger` union https://github.com/python-backoff/backoff/pull/34 (from @jcbertin)
+- Add `exception` to the typing-only `Details` dictionary for cases when `on_exception` is used https://github.com/python-backoff/backoff/pull/35
 - Use `time.monotonic` instead of `datetime.datetime.now` https://github.com/python-backoff/backoff/pull/23 (from @luccabb)
 
+### Packaging
+
+- Use uv for dependencies and packaging https://github.com/python-backoff/backoff/pull/7 (from @edgarrmondragon)
+- Remove duplicate classifier https://github.com/python-backoff/backoff/pull/37 (from @edgarrmondragon)
+
 ## [v2.2.1] - 2022-10-05
 
 - Fix type hint for wait generators https://github.com/litl/backoff/issues/177

backoff/_typing.py

@@ -27,6 +27,7 @@ class _Details(TypedDict):
 class Details(_Details, total=False):
     wait: float  # present in the on_backoff handler case for either decorator
     value: Any  # present in the on_predicate decorator case
+    exception: Exception  # present in the on_exception decorator case
 
 
 T = TypeVar("T")
@@ -38,7 +39,7 @@ class Details(_Details, total=False):
 ]
 _Jitterer = Callable[[float], float]
 _MaybeCallable = Union[T, Callable[[], T]]
-_MaybeLogger = Union[str, logging.Logger, None]
+_MaybeLogger = Union[str, logging.Logger, logging.LoggerAdapter, None]
 _MaybeSequence = Union[T, Sequence[T]]
 _Predicate = Callable[[T], bool]
 _WaitGenerator = Callable[..., Generator[float, None, None]]

pyproject.toml

@@ -15,7 +15,6 @@ keywords = [
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "Programming Language :: Python",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
@@ -29,6 +28,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
@@ -78,6 +78,7 @@ env_list = [
   "3.12",
   "3.13",
   "3.14",
+  "3.15",
   "coverage",
   "lint",
   "typing",
@@ -101,6 +102,7 @@ depends = [
   "3.12",
   "3.13",
   "3.14",
+  "3.15",
 ]
 dependency_groups = [ "test" ]
 commands = [
@@ -138,6 +140,7 @@ commands = [
 ]
 
 [tool.tox.gh.python]
+"3.15" = ["3.15"]
 "3.14" = ["3.14", "lint", "typing"]
 "3.13" = ["3.13"]
 "3.12" = ["3.12"]

tests/test_backoff.py

@@ -10,6 +10,7 @@
 import pytest
 
 import backoff
+from backoff._typing import Details
 from tests.common import _save_target
 
 
@@ -189,13 +190,35 @@ def test_on_exception_constant_iterable(monkeypatch):
     giveups = []
     successes = []
 
+    def on_backoff(details: Details):
+        nonlocal backoffs
+        assert details["tries"] == len(backoffs) + 1
+        assert "exception" in details
+        assert isinstance(details["exception"], KeyError)
+
+        backoffs.append(details)
+
+    def on_giveup(details: Details):
+        nonlocal giveups
+        assert details["tries"] == 4
+        assert "exception" in details
+        assert isinstance(details["exception"], KeyError)
+
+        giveups.append(details)
+
+    def on_success(details: Details):
+        nonlocal successes
+
+        successes.append(details)
+
+
     @backoff.on_exception(
         backoff.constant,
         KeyError,
         interval=(1, 2, 3),
-        on_backoff=backoffs.append,
-        on_giveup=giveups.append,
-        on_success=successes.append,
+        on_backoff=on_backoff,
+        on_giveup=on_giveup,
+        on_success=on_success,
     )
     def endless_exceptions():
         raise KeyError('foo')