eric6/Plugins/UiExtensionPlugins/Translator/TranslatorEngines/DeepLEngine.py

Sat, 27 Feb 2021 12:08:23 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 27 Feb 2021 12:08:23 +0100
changeset 8138
169e65a6787c
parent 7923
91e843545d9a
child 8218
7c09585bd960
permissions
-rw-r--r--

Shell: added functionality to show a prompt when the main client process has exited (e.g. a script ended).

6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
7923
91e843545d9a Updated copyright for 2021.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7780
diff changeset
3 # Copyright (c) 2017 - 2021 Detlev Offenbach <detlev@die-offenbachs.de>
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 #
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 Module implementing the DeepL translation engine.
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 import json
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
6412
d71b094845e7 Translator: improved the translator by making the loading of available translations an asynchroneous operation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6227
diff changeset
12 from PyQt5.QtCore import QUrl, QByteArray, QTimer
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
14 import Utilities
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
15
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 from .TranslationEngine import TranslationEngine
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 class DeepLEngine(TranslationEngine):
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 Class implementing the translation engine for the DeepL
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 translation service.
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 """
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
24 TranslatorUrl = "https://api.deepl.com/v1/translate"
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
25 MaxTranslationTextLen = 30 * 1024
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 def __init__(self, plugin, parent=None):
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 Constructor
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 @param plugin reference to the plugin object
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 @type TranslatorPlugin
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 @param parent reference to the parent object
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 @type QObject
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 super(DeepLEngine, self).__init__(plugin, parent)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37
6412
d71b094845e7 Translator: improved the translator by making the loading of available translations an asynchroneous operation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6227
diff changeset
38 QTimer.singleShot(0, self.availableTranslationsLoaded.emit)
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 def engineName(self):
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 Public method to return the name of the engine.
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 @return engine name
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 @rtype str
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 return "deepl"
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 def supportedLanguages(self):
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 Public method to get the supported languages.
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 @return list of supported language codes
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 @rtype list of str
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 """
6026
4773c9469880 Fixed some code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6018
diff changeset
56 return ["de", "en", "es", "fr", "it", "nl", "pl", ]
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 def getTranslation(self, requestObject, text, originalLanguage,
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 translationLanguage):
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 Public method to translate the given text.
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 @param requestObject reference to the request object
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 (TranslatorRequest)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 @param text text to be translated (string)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 @param originalLanguage language code of the original (string)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 @param translationLanguage language code of the translation (string)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 @return tuple of translated text (string) and flag indicating
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 success (boolean)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 """
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 if len(text) > self.MaxTranslationTextLen:
7748
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
72 return (
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
73 self.tr("DeepL: Text to be translated exceeds the translation"
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
74 " limit of {0} characters.")
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
75 .format(self.MaxTranslationTextLen),
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
76 False
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
77 )
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
79 apiKey = self.plugin.getPreferences("DeeplKey")
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
80 if not apiKey:
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
81 return self.tr("A valid DeepL Pro key is required."), False
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
82
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
83 params = QByteArray(
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
84 "auth_key={0}&source_lang={1}&target_lang={2}&text=".format(
6545
f669c4c0d39b Fixed some code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6539
diff changeset
85 apiKey, originalLanguage.upper(), translationLanguage.upper())
f669c4c0d39b Fixed some code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6539
diff changeset
86 .encode("utf-8"))
7256
4ef3b78ebb4e Continued to resolve code style issue M841.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7229
diff changeset
87 encodedText = (
4ef3b78ebb4e Continued to resolve code style issue M841.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7229
diff changeset
88 QByteArray(Utilities.html_encode(text).encode("utf-8"))
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
89 .toPercentEncoding()
7256
4ef3b78ebb4e Continued to resolve code style issue M841.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7229
diff changeset
90 )
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
91 request = params + encodedText
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
92 response, ok = requestObject.post(QUrl(self.TranslatorUrl), request)
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 if ok:
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 try:
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 responseDict = json.loads(response)
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 except ValueError:
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 return self.tr("Invalid response received from DeepL"), False
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
99 if "translations" not in responseDict:
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 return self.tr("DeepL call returned an unknown result"), False
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
102 translations = responseDict["translations"]
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 if len(translations) == 0:
7748
23e98236a4c4 Translator Engines: changes the user messages to contain an engine prefix.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7360
diff changeset
104 return self.tr("<p>DeepL: No translation found</p>"), True
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 # show sentence by sentence separated by a line
6539
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
107 result = (
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
108 "<p>" +
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
109 "<hr/>".join([t["text"] for t in translations]) +
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
110 "</p>"
0de153b92d53 Translator: changed DeepL support to DeepL Pro.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6412
diff changeset
111 )
6018
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 else:
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 result = response
1c858879d3d0 Added the translator plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 return result, ok

eric ide

mercurial