Restore and deprecate removed RetryFactory methods (#84)

Author: Gallaecio

tests/test_retry.py

@@ -4,7 +4,7 @@
 
 import pytest
 from aiohttp.client_exceptions import ServerConnectionError
-from tenacity import AsyncRetrying
+from tenacity import AsyncRetrying, RetryCallState
 
 from zyte_api import (
     AggressiveRetryFactory,
@@ -430,3 +430,33 @@ async def run():
         assert outcome is last_outcome  # noqa: PT017
     else:
         assert not exhausted
+
+
+@pytest.mark.asyncio
+async def test_deprecated_temporary_download_error():
+    class CustomRetryFactory(RetryFactory):
+        def wait(self, retry_state: RetryCallState) -> float:
+            self.temporary_download_error_wait(retry_state=retry_state)
+            return 0.0
+
+        def stop(self, retry_state: RetryCallState) -> bool:
+            self.temporary_download_error_stop(retry_state)
+            return super().stop(retry_state)
+
+    retrying = CustomRetryFactory().build()
+
+    outcomes = deque((mock_request_error(status=520), None))
+
+    async def run():
+        outcome = outcomes.popleft()
+        if isinstance(outcome, Exception):
+            raise outcome
+        return outcome
+
+    run = retrying.wraps(run)
+    with (
+        pytest.warns(DeprecationWarning, match="temporary_download_error_stop"),
+        pytest.warns(DeprecationWarning, match="temporary_download_error_wait"),
+    ):
+        await run()
+    assert not outcomes

zyte_api/_retry.py

@@ -5,7 +5,8 @@
 from collections import Counter
 from datetime import timedelta
 from itertools import count
-from typing import Union
+from typing import Callable, Union
+from warnings import warn
 
 from aiohttp import client_exceptions
 from tenacity import (
@@ -158,6 +159,14 @@ def _undocumented_error(exc: BaseException) -> bool:
     )
 
 
+def _deprecated(message: str, callable: Callable) -> Callable:
+    def wrapper(factory, retry_state: RetryCallState):
+        warn(message, DeprecationWarning, stacklevel=3)
+        return callable(retry_state=retry_state)
+
+    return wrapper
+
+
 class RetryFactory:
     """Factory class that builds the :class:`tenacity.AsyncRetrying` object
     that defines the :ref:`default retry policy <default-retry-policy>`.
@@ -204,14 +213,33 @@ class CustomRetryFactory(RetryFactory):
     )
 
     # connection errors, other client and server failures
+    network_error_stop = stop_after_uninterrupted_delay(15 * 60)
     network_error_wait = (
         # wait from 3s to ~1m
         wait_random(3, 7) + wait_random_exponential(multiplier=1, max=55)
     )
+
+    download_error_stop = stop_on_download_error(max_total=4, max_permanent=2)
     download_error_wait = network_error_wait
+
+    temporary_download_error_stop = _deprecated(
+        (
+            "The zyte_api.RetryFactory.temporary_download_error_stop() method "
+            "is deprecated and will be removed in a future version. Use "
+            "download_error_stop() instead."
+        ),
+        download_error_stop,
+    )
+    temporary_download_error_wait = _deprecated(
+        (
+            "The zyte_api.RetryFactory.temporary_download_error_wait() method "
+            "is deprecated and will be removed in a future version. Use "
+            "download_error_wait() instead."
+        ),
+        download_error_wait,
+    )
+
     throttling_stop = stop_never
-    network_error_stop = stop_after_uninterrupted_delay(15 * 60)
-    download_error_stop = stop_on_download_error(max_total=4, max_permanent=2)
 
     undocumented_error_stop = stop_on_count(2)
     undocumented_error_wait = network_error_wait