Merge pull request #6 from community-of-python/fix-wo-redis

fix using without redis

Author: lesnik512

.github/workflows/workflow.yml

@@ -16,4 +16,4 @@ jobs:
     uses: community-of-python/community-workflow/.github/workflows/preset.yml@main
     with:
       python-version: '["3.10","3.11","3.12","3.13"]'
-    secrets: inherit
+    secrets: inherit

README.md

@@ -70,55 +70,57 @@ if __name__ == "__main__":
 ```
 
 ### Retrier
+
 ```python
 import asyncio
 import logging
 
 import httpx
 import tenacity
 
-from circuit_breaker_box.retryer import Retrier
-
+from circuit_breaker_box.retrier import Retrier
 
 MAX_RETRIES = 4
 SOME_HOST = "http://example.com/"
 
 
 async def main() -> None:
-    """
-    Use Retrier with tenacity adjustments to automatically retry failed operations raising specific exceptions like:
-     stop_rule
-     retry_cause
-     wait_strategy
+  """
+  Use Retrier with tenacity adjustments to automatically retry failed operations raising specific exceptions like:
+   stop_rule
+   retry_cause
+   wait_strategy
 
-    `foo` as example function will be retried immediately (no wait) when it raises ZeroDivisionError up to MAX_RETRIES
-        After exceeding MAX_RETRIES attempts, the exception will propagate.
-    """
-    logging.basicConfig(level=logging.DEBUG)
-    retryer = Retrier[httpx.Response](
-        stop_rule=tenacity.stop.stop_after_attempt(MAX_RETRIES),
-        retry_cause=tenacity.retry_if_exception_type(ZeroDivisionError),
-        wait_strategy=tenacity.wait_none(),
-    )
-    example_request = httpx.Request("GET", httpx.URL(SOME_HOST))
+  `foo` as example function will be retried immediately (no wait) when it raises ZeroDivisionError up to MAX_RETRIES
+      After exceeding MAX_RETRIES attempts, the exception will propagate.
+  """
+  logging.basicConfig(level=logging.DEBUG)
+  retryer = Retrier[httpx.Response](
+    stop_rule=tenacity.stop.stop_after_attempt(MAX_RETRIES),
+    retry_cause=tenacity.retry_if_exception_type(ZeroDivisionError),
+    wait_strategy=tenacity.wait_none(),
+  )
+  example_request = httpx.Request("GET", httpx.URL(SOME_HOST))
 
-    async def foo(request: httpx.Request) -> httpx.Response:
-        raise ZeroDivisionError(request)
+  async def foo(request: httpx.Request) -> httpx.Response:
+    raise ZeroDivisionError(request)
 
-    await retryer.retry(foo, request=example_request)
+  await retryer.retry(foo, request=example_request)
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
-
-
->>> INFO:circuit_breaker_box.retryer:Attempt: attempt_number: 1, outcome_timestamp: None
->>> INFO:circuit_breaker_box.retryer:Attempt: attempt_number: 2, outcome_timestamp: None
->>> INFO:circuit_breaker_box.retryer:Attempt: attempt_number: 3, outcome_timestamp: None
->>> INFO:circuit_breaker_box.retryer:Attempt: attempt_number: 4, outcome_timestamp: None
->>> Traceback (most recent call last):
->>>     ...
->>> ZeroDivisionError: <Request('GET', 'http://example.com/')>
+  asyncio.run(main())
+
+>> > INFO: circuit_breaker_box.retryer:Attempt: attempt_number: 1, outcome_timestamp: None
+>> > INFO: circuit_breaker_box.retryer:Attempt: attempt_number: 2, outcome_timestamp: None
+>> > INFO: circuit_breaker_box.retryer:Attempt: attempt_number: 3, outcome_timestamp: None
+>> > INFO: circuit_breaker_box.retryer:Attempt: attempt_number: 4, outcome_timestamp: None
+>> > Traceback(most
+recent
+call
+last):
+>> > ...
+>> > ZeroDivisionError: < Request('GET', 'http://example.com/') >
 ```
 
 ### Retrier with CircuitBreaker

circuit_breaker_box/__init__.py

@@ -3,7 +3,7 @@
 from circuit_breaker_box.circuit_breaker_redis import CircuitBreakerRedis
 from circuit_breaker_box.common_types import ResponseType
 from circuit_breaker_box.errors import BaseCircuitBreakerError, HostUnavailableError
-from circuit_breaker_box.retryer import Retrier
+from circuit_breaker_box.retrier import Retrier
 
 
 __all__ = [

circuit_breaker_box/circuit_breaker_redis.py

@@ -1,15 +1,19 @@
+import contextlib
 import dataclasses
 import logging
 import typing
 
 import tenacity
-from redis import asyncio as aioredis
-from redis.exceptions import ConnectionError as RedisConnectionError
-from redis.exceptions import WatchError
 
 from circuit_breaker_box import BaseCircuitBreaker, errors
 
 
+with contextlib.suppress(ImportError):
+    from redis import asyncio as aioredis
+    from redis.exceptions import ConnectionError as RedisConnectionError
+    from redis.exceptions import WatchError
+
+
 logger = logging.getLogger(__name__)
 
 

circuit_breaker_box/retryer.py renamed to circuit_breaker_box/retrier.py

@@ -22,7 +22,7 @@ class Retrier(abc.ABC, typing.Generic[ResponseType]):
     retry_cause: retry_clause_types
     circuit_breaker: BaseCircuitBreaker | None = None
 
-    async def retry(  # type: ignore[return]
+    async def retry(
         self,
         coroutine: typing.Callable[P, typing.Awaitable[ResponseType]],
         /,
@@ -34,7 +34,7 @@ async def retry(  # type: ignore[return]
             msg = "'host' argument should be defined"
             raise ValueError(msg)
 
-        for attempt in tenacity.Retrying(  # noqa: RET503
+        for attempt in tenacity.Retrying(
             stop=self.stop_rule,
             wait=self.wait_strategy,
             retry=self.retry_cause,
@@ -51,6 +51,8 @@ async def retry(  # type: ignore[return]
                         await self.circuit_breaker.increment_failures_count(host)
 
                 return await coroutine(*args, **kwargs)
+        msg = "Unreachable section"  # pragma: no cover
+        raise RuntimeError(msg)  # pragma: no cover
 
     @staticmethod
     def do_before_attempts(retry_state: tenacity.RetryCallState) -> None:

examples/example_retry.py

@@ -4,7 +4,7 @@
 import httpx
 import tenacity
 
-from circuit_breaker_box.retryer import Retrier
+from circuit_breaker_box.retrier import Retrier
 
 
 MAX_RETRIES = 4