Fix HTTP request retries for document uploads

Author: daniel-jones-dev

CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+* Fix HTTP request retries for document uploads.
+### Security
+
+
 ## [1.1.3] - 2021-09-27
 ### Changed
 * Loosen requirement for requests to 2.0 or higher.
@@ -71,6 +81,7 @@ Version increased to avoid conflicts with old packages on PyPI.
 Initial version.
 
 
+[Unreleased]: https://github.com/DeepLcom/deepl-python/compare/v1.1.3...HEAD 
 [1.1.3]: https://github.com/DeepLcom/deepl-python/compare/v1.1.2...v1.1.3
 [1.1.2]: https://github.com/DeepLcom/deepl-python/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/DeepLcom/deepl-python/compare/v1.1.0...v1.1.1

deepl/http_client.py

@@ -3,7 +3,7 @@
 # license that can be found in the LICENSE file.
 
 from . import version
-from .exceptions import ConnectionException
+from .exceptions import ConnectionException, DeepLException
 import http
 import random
 import requests
@@ -67,17 +67,32 @@ def close(self):
         self._session.close()
 
     def request_with_backoff(
-        self, method: str, url: str, data: Optional[dict], **kwargs
+        self,
+        method: str,
+        url: str,
+        data: Optional[dict],
+        stream: bool = False,
+        **kwargs,
     ) -> Tuple[int, Union[str, requests.Response]]:
         """Makes API request, retrying if necessary, and returns response.
 
         Return and exceptions are the same as function request()."""
         backoff = _BackoffTimer()
+
+        try:
+            request = requests.Request(
+                method, url, data=data, **kwargs
+            ).prepare()
+        except Exception as e:
+            raise DeepLException(
+                f"Error occurred while preparing request: {e}"
+            ) from e
+
         while True:
             response: Optional[Tuple[int, Union[str, requests.Response]]]
             try:
-                response = self.request(
-                    method, url, data, timeout=backoff.get_timeout(), **kwargs
+                response = self._internal_request(
+                    request, stream=stream, timeout=backoff.get_timeout()
                 )
                 exception = None
             except Exception as e:
@@ -108,7 +123,6 @@ def request(
         method: str,
         url: str,
         data: Optional[dict],
-        timeout: float,
         stream: bool = False,
         **kwargs,
     ) -> Tuple[int, Union[str, requests.Response]]:
@@ -118,22 +132,31 @@ def request(
         stream is False) or response (if stream is True).
 
         If no response is received will raise ConnectionException."""
+
         try:
+            request = requests.Request(
+                method, url, data=data, **kwargs
+            ).prepare()
+        except Exception as e:
+            raise DeepLException(
+                f"Error occurred while preparing request: {e}"
+            ) from e
+        return self._internal_request(request, stream, stream=stream)
+
+    def _internal_request(
+        self,
+        request: requests.PreparedRequest,
+        stream: bool,
+        timeout: float = min_connection_timeout,
+        **kwargs,
+    ) -> Tuple[int, Union[str, requests.Response]]:
+        try:
+            response = self._session.send(
+                request, stream=stream, timeout=timeout, **kwargs
+            )
             if stream:
-                response = self._session.request(
-                    method,
-                    url,
-                    data=data,
-                    timeout=timeout,
-                    stream=True,
-                    **kwargs,
-                )
                 return response.status_code, response
-
             else:
-                response = self._session.request(
-                    method, url, data=data, timeout=timeout, **kwargs
-                )
                 try:
                     response.encoding = "UTF-8"
                     return response.status_code, response.text

tests/test_general.py

@@ -36,7 +36,7 @@ def test_invalid_authkey(server):
 
 def test_invalid_server_url(server):
     translator = deepl.Translator("invalid", server_url="http:/api.deepl.com")
-    with pytest.raises(deepl.exceptions.ConnectionException):
+    with pytest.raises(deepl.exceptions.DeepLException):
         translator.get_usage()