Add optional filename argument to translate_document_upload() to fix uploading file content as string or bytes

Author: daniel-jones-dev

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Deprecated
 ### Removed
 ### Fixed
+* Add optional filename argument to `translate_document_upload()` to fix uploading file content as string or bytes.
 ### Security
 
 

deepl/translator.py

@@ -847,6 +847,7 @@ def translate_document_upload(
         target_lang: str,
         formality: Union[str, Formality] = Formality.DEFAULT,
         glossary: Union[str, GlossaryInfo, None] = None,
+        filename: Optional[str] = None,
     ) -> DocumentHandle:
         """Upload document to be translated and return handle associated with
         request.
@@ -862,14 +863,24 @@ def translate_document_upload(
             Formality enum, "less" or "more".
         :param glossary: (Optional) glossary or glossary ID to use for
             translation. Must match specified source_lang and target_lang.
+        :param filename: (Optional) Filename including extension, only required
+            if uploading string or bytes containing file content.
         :return: DocumentHandle with ID and key identifying document.
         """
 
         request_data = self._check_language_and_formality(
             source_lang, target_lang, formality, glossary
         )
 
-        files = {"file": input_document}
+        if isinstance(input_document, (str, bytes)):
+            if filename is None:
+                raise ValueError(
+                    "filename is required if uploading file content as string "
+                    "or bytes"
+                )
+            files = {"file": (filename, input_document)}
+        else:
+            files = {"file": input_document}
         status, content, json = self._api_call(
             "v2/document", data=request_data, files=files
         )

tests/test_translate_document.py

@@ -180,6 +180,32 @@ def test_translate_document_low_level(
     assert output_document_path.read_text() == example_document_translation
 
 
+def test_translate_document_string(translator, server):
+    input_string = example_text["EN"]
+    handle = translator.translate_document_upload(
+        input_string,
+        source_lang="EN",
+        target_lang="DE",
+        filename="test.txt",
+    )
+
+    status = translator.translate_document_get_status(handle)
+    while status.ok and not status.done:
+        status = translator.translate_document_get_status(handle)
+        time.sleep(status.seconds_remaining or 1)
+
+    assert status.ok
+    response = translator.translate_document_download(handle)
+    try:
+        output = bytes()
+        for chunk in response.iter_content(chunk_size=128):
+            output += chunk
+        output_string = output.decode()
+        assert output_string == example_text["DE"]
+    finally:
+        response.close()
+
+
 @needs_mock_server
 def test_translate_document_request_fields(
     translator, example_document_path, server, output_document_path