Expose the number of the current attempt

Author: hynek

docs/api.rst

@@ -6,6 +6,7 @@ API Reference
 .. autofunction:: retry
 .. autofunction:: retry_context
 .. autoclass:: Attempt
+   :members: num
 
 
 Configuration

src/stamina/_core.py

@@ -81,6 +81,13 @@ class Attempt:
 
     _t_attempt: _t.AttemptManager
 
+    @property
+    def num(self) -> int:
+        """
+        The number of the current attempt.
+        """
+        return self._t_attempt.retry_state.attempt_number  # type: ignore[no-any-return]
+
     def __enter__(self) -> None:
         return self._t_attempt.__enter__()  # type: ignore[no-any-return]
 

tests/test_async.py

@@ -151,6 +151,9 @@ async def test_retry_block():
     async for attempt in stamina.retry_context(on=ValueError, wait_max=0):
         with attempt:
             num_called += 1
+
+            assert num_called == attempt.num
+
             if num_called < 2:
                 raise ValueError
 

tests/test_sync.py

@@ -124,6 +124,9 @@ def test_retry_block():
     for attempt in stamina.retry_context(on=ValueError, wait_max=0):
         with attempt:
             i += 1
+
+            assert i == attempt.num
+
             if i < 2:
                 raise ValueError
 

tests/typing/api.py

@@ -98,7 +98,7 @@ def hook(
 
 for attempt in retry_context(on=ValueError, timeout=13):
     with attempt:
-        ...
+        x: int = attempt.num
 
 for attempt in retry_context(
     on=ValueError, timeout=dt.timedelta(seconds=13.0)
@@ -116,4 +116,4 @@ async def f() -> None:
         wait_jitter=one_sec,
     ):
         with attempt:
-            ...
+            pass