feat: change internal functions to send API requests as JSON

Author: daniel-jones-dev

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## Unreleased
+### Changed
+* DeepL API calls now send requests with JSON-encoded bodies where possible.
 ### Fixed
 * Catch failures while constructing the user agent string.
 

deepl/http_client.py

@@ -97,6 +97,7 @@ def request_with_backoff(
         method: str,
         url: str,
         data: Optional[dict],
+        json: Optional[dict],
         headers: dict,
         stream: bool = False,
         **kwargs,
@@ -117,7 +118,7 @@ def request_with_backoff(
                 ),
             )
             request = requests.Request(
-                method, url, data=data, headers=headers, **kwargs
+                method, url, data=data, json=json, headers=headers, **kwargs
             ).prepare()
         except Exception as e:
             raise DeepLException(
@@ -160,6 +161,7 @@ def request(
         method: str,
         url: str,
         data: Optional[dict],
+        json: Optional[dict],
         headers: dict,
         stream: bool = False,
         **kwargs,
@@ -182,7 +184,7 @@ def request(
                 ),
             )
             request = requests.Request(
-                method, url, data=data, headers=headers, **kwargs
+                method, url, data=data, json=json, headers=headers, **kwargs
             ).prepare()
         except Exception as e:
             raise DeepLException(

deepl/translator.py

@@ -511,6 +511,7 @@ def _api_call(
         *,
         method: str = "POST",
         data: Optional[dict] = None,
+        json: Optional[dict] = None,
         stream: bool = False,
         headers: Optional[dict] = None,
         **kwargs,
@@ -519,12 +520,15 @@ def _api_call(
         Makes a request to the API, and returns response as status code,
         content and JSON object.
         """
+        if data is not None and json is not None:
+            raise ValueError("cannot accept both json and data")
+
         if data is None:
             data = {}
         url = urllib.parse.urljoin(self._server_url, url)
 
         util.log_info("Request to DeepL API", method=method, url=url)
-        util.log_debug("Request details", data=data)
+        util.log_debug("Request details", data=data, json=json)
 
         if headers is None:
             headers = dict()
@@ -536,6 +540,7 @@ def _api_call(
             method,
             url,
             data=data,
+            json=json,
             stream=stream,
             headers=headers,
             **kwargs,
@@ -703,7 +708,7 @@ def _create_glossary(
         }
 
         status, content, json = self._api_call(
-            "v2/glossaries", data=request_data
+            "v2/glossaries", json=request_data
         )
         self._raise_for_status(status, content, json, glossary=True)
         return GlossaryInfo.from_json(json)
@@ -777,9 +782,11 @@ def translate_text(
         if isinstance(text, str):
             if len(text) == 0:
                 raise ValueError("text must not be empty")
+            text = [text]
             multi_input = False
         elif hasattr(text, "__iter__"):
             multi_input = True
+            text = list(text)
         else:
             raise TypeError(
                 "text parameter must be a string or an iterable of strings"
@@ -796,22 +803,20 @@ def translate_text(
         if split_sentences is not None:
             request_data["split_sentences"] = str(split_sentences)
         if preserve_formatting is not None:
-            request_data["preserve_formatting"] = (
-                "1" if preserve_formatting else "0"
-            )
+            request_data["preserve_formatting"] = bool(preserve_formatting)
         if tag_handling is not None:
             request_data["tag_handling"] = tag_handling
         if outline_detection is not None:
-            request_data["outline_detection"] = (
-                "1" if outline_detection else "0"
-            )
+            request_data["outline_detection"] = bool(outline_detection)
 
-        def join_tags(tag_argument: Union[str, Iterable[str]]) -> str:
-            return (
-                tag_argument
-                if isinstance(tag_argument, str)
-                else ",".join(tag_argument)
-            )
+        def join_tags(tag_argument: Union[str, Iterable[str]]) -> List[str]:
+            if isinstance(tag_argument, str):
+                tag_argument = [tag_argument]
+            return [
+                tag
+                for arg_string in tag_argument
+                for tag in arg_string.split(",")
+            ]
 
         if non_splitting_tags is not None:
             request_data["non_splitting_tags"] = join_tags(non_splitting_tags)
@@ -821,7 +826,7 @@ def join_tags(tag_argument: Union[str, Iterable[str]]) -> str:
             request_data["ignore_tags"] = join_tags(ignore_tags)
 
         status, content, json = self._api_call(
-            "v2/translate", data=request_data
+            "v2/translate", json=request_data
         )
 
         self._raise_for_status(status, content, json)
@@ -1051,7 +1056,7 @@ def translate_document_get_status(
         data = {"document_key": handle.document_key}
         url = f"v2/document/{handle.document_id}"
 
-        status, content, json = self._api_call(url, data=data)
+        status, content, json = self._api_call(url, json=data)
 
         self._raise_for_status(status, content, json)
 
@@ -1113,7 +1118,7 @@ def translate_document_download(
         url = f"v2/document/{handle.document_id}/result"
 
         status_code, response, json = self._api_call(
-            url, data=data, stream=True
+            url, json=data, stream=True
         )
 
         self._raise_for_status(

tests/test_cli.py

@@ -140,17 +140,20 @@ def test_text(runner):
         ("--formality more", "'formality': 'more'"),
         ("--formality prefer_less", "'formality': 'prefer_less'"),
         ("--split-sentences 0", "'split_sentences': '0'"),
-        ("--preserve-formatting", "'preserve_formatting': '1'"),
+        ("--preserve-formatting", "'preserve_formatting': True"),
         ("--tag-handling xml", "'tag_handling': 'xml'"),
-        ("--outline-detection-off", "'outline_detection': '0'"),
-        ("--ignore-tags a,b --ignore-tags c", "'ignore_tags': 'a,b,c'"),
+        ("--outline-detection-off", "'outline_detection': False"),
+        (
+            "--ignore-tags a,b --ignore-tags c",
+            "'ignore_tags': ['a', 'b', 'c']",
+        ),
         (
             "--splitting-tags a,b --splitting-tags c",
-            "'splitting_tags': 'a,b,c'",
+            "'splitting_tags': ['a', 'b', 'c']",
         ),
         (
             "--non-splitting-tags a,b --non-splitting-tags c",
-            "'non_splitting_tags': 'a,b,c'",
+            "'non_splitting_tags': ['a', 'b', 'c']",
         ),
     ]
     for args, search_str in extra_options:
@@ -209,12 +212,14 @@ def test_text_tags(runner):
     )
     assert result.exit_code == 0, f"exit: {result.exit_code}\n {result.output}"
     # Check ignore_tags parameter is sent in HTTP request
-    regex = re.compile("Request details.*'ignore_tags': 'a,b,c,d'")
+    regex = re.compile(
+        "Request details.*'ignore_tags': \\['a', 'b', 'c', 'd']"
+    )
     assert any(
         regex.match(line) is not None for line in result.output.split("\n")
     ), f"output:\n{result.output}"
     # Check splitting_tags parameter is sent in HTTP request
-    regex = re.compile("Request details.*'splitting_tags': 'split'")
+    regex = re.compile("Request details.*'splitting_tags': \\['split']")
     assert any(
         regex.match(line) is not None for line in result.output.split("\n")
     ), f"output:\n{result.output}"