-
Notifications
You must be signed in to change notification settings - Fork 80
/
test_translate_document.py
287 lines (239 loc) · 9.11 KB
/
test_translate_document.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# Copyright 2022 DeepL SE (https://www.deepl.com)
# Use of this source code is governed by an MIT
# license that can be found in the LICENSE file.
import re
from .conftest import example_text, needs_mock_server, needs_real_server
import deepl
import io
import pathlib
import pytest
import time
default_lang_args = {"target_lang": "DE", "source_lang": "EN"}
def test_translate_document_from_filepath(
translator,
example_document_path,
example_document_translation,
output_document_path,
):
status = translator.translate_document_from_filepath(
example_document_path,
output_path=output_document_path,
**default_lang_args,
)
assert example_document_translation == output_document_path.read_text()
assert status.billed_characters == len(example_text["EN"])
assert status.status == deepl.DocumentStatus.Status.DONE
assert status.done
# Note: cases with invalid file paths are not tested, because standard
# library functions are used.
@needs_mock_server
def test_translate_document_with_retry(
translator,
server,
example_document_path,
example_document_translation,
output_document_path,
monkeypatch,
):
server.no_response(1)
# Lower the timeout for this test, and restore after test
monkeypatch.setattr(deepl.http_client, "min_connection_timeout", 1.0)
translator.translate_document_from_filepath(
example_document_path,
output_path=output_document_path,
**default_lang_args,
)
assert example_document_translation == output_document_path.read_text()
@needs_mock_server
def test_translate_document_with_waiting(
translator,
server,
example_document_path,
example_document_translation,
output_document_path,
):
server.set_doc_queue_time(2000)
server.set_doc_translate_time(2000)
translator.translate_document_from_filepath(
example_document_path,
output_path=output_document_path,
**default_lang_args,
)
assert example_document_translation == output_document_path.read_text()
@needs_mock_server
def test_translate_large_document(
translator, example_large_document_path, example_large_document_translation
):
with io.BytesIO() as output_file:
with open(example_large_document_path, "rb") as input_file:
translator.translate_document(
input_file, output_file, **default_lang_args
)
assert (
example_large_document_translation
== output_file.getvalue().decode()
)
@needs_real_server
def test_translate_document_formality(
translator, example_document_path, output_document_path
):
example_document_path.write_text("How are you?")
translator.translate_document_from_filepath(
example_document_path,
output_document_path,
formality=deepl.Formality.MORE,
**default_lang_args,
)
assert "Wie geht es Ihnen?" == output_document_path.read_text()
translator.translate_document_from_filepath(
example_document_path,
output_document_path,
formality=deepl.Formality.LESS,
**default_lang_args,
)
assert "Wie geht es dir?" == output_document_path.read_text()
def test_document_failure_during_translation(
translator, example_document_path, output_document_path
):
# Translating text from DE to DE will trigger error
example_document_path.write_text(example_text["DE"])
with pytest.raises(
deepl.exceptions.DocumentTranslationException,
) as exc_info:
translator.translate_document_from_filepath(
example_document_path, output_document_path, target_lang="DE"
)
# Ensure that document translation error contains document handle
exception = exc_info.value
assert "Source and target language" in str(exception)
assert exception.document_handle is not None
match = re.compile("ID: [0-9A-F]{32}, key: [0-9A-F]{64}")
assert match.search(str(exception)) is not None
# document_request is a deprecated alias for document_handle
assert exception.document_request is not None
def test_invalid_document(translator, tmpdir):
tmpdir = pathlib.Path(tmpdir)
output_dir = tmpdir / "output"
output_dir.mkdir()
input_document = tmpdir / "document.invalid"
input_document.write_text(example_text["EN"])
output_document = output_dir / "document.invalid"
with pytest.raises(
deepl.DeepLException, match="(Invalid file)|(file extension)"
):
translator.translate_document_from_filepath(
input_document, output_path=output_document, **default_lang_args
)
@needs_mock_server
def test_translate_document_low_level(
translator,
example_document_path,
example_document_translation,
output_document_path,
server,
):
# Set a small document queue time to attempt downloading a queued document
server.set_doc_queue_time(100)
with open(example_document_path, "rb") as infile:
handle = translator.translate_document_upload(
infile, **default_lang_args
)
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
handle = deepl.DocumentHandle(doc_id, doc_key)
status = translator.translate_document_get_status(handle)
assert status.ok
while status.ok and not status.done:
status = translator.translate_document_get_status(handle)
time.sleep(0.2)
assert status.ok and status.done
with open(output_document_path, "wb") as outfile:
translator.translate_document_download(handle, outfile)
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
):
server.set_doc_queue_time(2000)
server.set_doc_translate_time(2000)
time_before = time.time()
with open(example_document_path, "rb") as infile:
handle = translator.translate_document_upload(
infile, **default_lang_args
)
status = translator.translate_document_get_status(handle)
assert status.ok
while status.ok and not status.done:
status = translator.translate_document_get_status(handle)
assert (
status.status == deepl.DocumentStatus.Status.QUEUED
or status.seconds_remaining >= 0
)
time.sleep(0.2)
with open(output_document_path, "wb") as outfile:
translator.translate_document_download(handle, outfile)
time_after = time.time()
assert status.billed_characters == len(example_document_path.read_text())
assert time_after - time_before > 4.0
assert example_text["DE"] == output_document_path.read_text()
@needs_mock_server
def test_translate_document_download_generator(
translator,
example_large_document_path,
output_document_path,
example_large_document_translation,
):
with open(example_large_document_path, "rb") as infile:
handle = translator.translate_document_upload(
infile, **default_lang_args
)
status = translator.translate_document_get_status(handle)
while status.ok and not status.done:
status = translator.translate_document_get_status(handle)
time.sleep(0.2)
assert status.ok and status.done
response = translator.translate_document_download(handle)
with open(output_document_path, "wb") as outfile:
for chunk in response.iter_content(chunk_size=128):
outfile.write(chunk)
assert (
output_document_path.read_text() == example_large_document_translation
)
@needs_mock_server
def test_recreate_document_handle_invalid(translator):
doc_id = "12AB" * 8 # IDs are 32 hex characters
doc_key = "CD34" * 16 # Keys are 64 hex characters
handle = deepl.DocumentHandle(doc_id, doc_key)
with pytest.raises(deepl.DeepLException, match="Not found"):
translator.translate_document_get_status(handle)