fix: Requests resulting in 503 Service Unavailable errors are now retried.

Author: daniel-jones-dev

CHANGELOG.md

@@ -7,15 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-* Add formality options `'prefer_less'` and `'prefer_more'`.
+* Add formality options `'PREFER_LESS'` and `'PREFER_MORE'`.
+### Changed
+* Requests resulting in `503 Service Unavailable` errors are now retried.
+  Attempting to download a document before translation is completed will now
+  wait and retry (up to 5 times by default), rather than raising an exception.
 
 
 ## [1.10.0] - 2022-09-09
 ### Added
 * New language available: Ukrainian (`'uk'`). Add language code constant and tests.
 
   Note: older library versions also support new languages, this update only adds new code constant.
-* Add new `Formality` options: `PREFER_MORE` and `PREFER_LESS`.
 ### Changed
 * Add note and workaround to README about Poetry error on Ubuntu 22.04.
   * Pull request [#48](https://github.com/DeepLcom/deepl-python/pull/48)

deepl/http_client.py

@@ -198,9 +198,7 @@ def _should_retry(self, response, exception, num_retries):
             return exception.should_retry
 
         status_code, _ = response
-        # Retry on Too-Many-Requests error and internal errors except
-        # Service-Unavailable errors
+        # Retry on Too-Many-Requests error and internal errors
         return status_code == http.HTTPStatus.TOO_MANY_REQUESTS or (
             status_code >= http.HTTPStatus.INTERNAL_SERVER_ERROR
-            and status_code != http.HTTPStatus.SERVICE_UNAVAILABLE
         )

tests/test_translate_document.py

@@ -181,13 +181,6 @@ def test_translate_document_low_level(
     status = translator.translate_document_get_status(handle)
     assert status.ok and not status.done
 
-    # Calling download() before document is ready will fail
-    with pytest.raises(
-        deepl.DocumentNotReadyException, match="Document not ready"
-    ):
-        with open(output_document_path, "wb") as output_file:
-            translator.translate_document_download(handle, output_file)
-
     # Test recreating a document handle from id & key
     doc_id, doc_key = handle.document_id, handle.document_key
     del handle