add tencent translator

deep_translator/__init__.py

@@ -13,6 +13,7 @@ from deep_translator.mymemory import MyMemoryTranslator
 from deep_translator.papago import PapagoTranslator
 from deep_translator.pons import PonsTranslator
 from deep_translator.qcri import QcriTranslator
+from deep_translator.tencent import TencentTranslator
 from deep_translator.yandex import YandexTranslator
 
 __author__ = """Nidhal Baccouri"""
@@ -31,6 +32,7 @@ __all__ = [
     "LibreTranslator",
     "PapagoTranslator",
     "ChatGptTranslator",
+    "TencentTranslator",
     "single_detection",
     "batch_detection",
 ]

deep_translator/constants.py

@@ -7,6 +7,8 @@ LIBRE_ENV_VAR = "LIBRE_API_KEY"
 MSFT_ENV_VAR = "MICROSOFT_API_KEY"
 QCRI_ENV_VAR = "QCRI_API_KEY"
 YANDEX_ENV_VAR = "YANDEX_API_KEY"
+TENCENT_ID_VAR = "TENCENT_ID"
+TENCENT_KEY_VAR = "TENCENT_KEY"
 
 
 BASE_URLS = {
@@ -23,6 +25,7 @@ BASE_URLS = {
     "PAPAGO_API": "https://openapi.naver.com/v1/papago/n2mt",
     "LIBRE": "https://libretranslate.com/",
     "LIBRE_FREE": "https://libretranslate.de/",
+    "TENENT": "https://tmt.tencentcloudapi.com",
 }
 
 GOOGLE_LANGUAGES_TO_CODES = {
@@ -280,3 +283,23 @@ LIBRE_LANGUAGES_TO_CODES = {
     "Turkish": "tr",
     "Vietnamese": "vi",
 }
+
+TENCENT_LANGUAGE_TO_CODE = {
+    "arabic": "ar",
+    "chinese (simplified)": "zh",
+    "chinese (traditional)": "zh-TW",
+    "english": "en",
+    "french": "fr",
+    "german": "de",
+    "hindi": "hi",
+    "indonesian": "id",
+    "japanese": "ja",
+    "korean": "ko",
+    "malay": "ms",
+    "portuguese": "pt",
+    "russian": "ru",
+    "spanish": "es",
+    "thai": "th",
+    "turkish": "tr",
+    "vietnamese": "vi",
+}

deep_translator/exceptions.py

@@ -180,3 +180,16 @@ class AuthorizationException(Exception):
     def __init__(self, api_key, *args):
         msg = "Unauthorized access with the api key " + api_key
         super().__init__(msg, *args)
+
+
+class TencentAPIerror(Exception):
+    """
+    exception thrown if Tencent API returns one of its errors
+    """
+
+    def __init__(self, api_message):
+        self.api_message = str(api_message)
+        self.message = "Tencent API returned the following error"
+
+    def __str__(self):
+        return "{}: {}".format(self.message, self.api_message)

deep_translator/tencent.py

@@ -0,0 +1,140 @@
+"""
+tencent translator API
+"""
+
+__copyright__ = "Copyright (C) 2020 Nidhal Baccouri"
+
+import base64
+import hashlib
+import hmac
+import os
+import time
+from typing import List, Optional
+
+import requests
+
+from deep_translator.base import BaseTranslator
+from deep_translator.constants import (
+    BASE_URLS,
+    TENCENT_ID_VAR,
+    TENCENT_KEY_VAR,
+    TENCENT_LANGUAGE_TO_CODE,
+)
+from deep_translator.exceptions import (
+    ApiKeyException,
+    AuthorizationException,
+    ServerException,
+    TencentAPIerror,
+    TranslationNotFound,
+)
+from deep_translator.validate import is_empty, is_input_valid
+
+
+class TencentTranslator(BaseTranslator):
+    """
+    class that wraps functions, which use the TentCentTranslator translator
+    under the hood to translate word(s)
+    """
+
+    def __init__(
+        self,
+        source: str = "en",
+        target: str = "zh",
+        secret_id: Optional[str] = os.getenv(TENCENT_ID_VAR, None),
+        secret_key: Optional[str] = os.getenv(TENCENT_KEY_VAR, None),
+        **kwargs
+    ):
+        """
+        @param secret_id: your tencent cloud api secret id.
+        Get one here: https://console.cloud.tencent.com/capi
+        @param secret_key: your tencent cloud api secret key.
+        @param source: source language
+        @param target: target language
+        """
+        if not secret_id:
+            raise ApiKeyException(env_var=TENCENT_ID_VAR)
+
+        if not secret_key:
+            raise ApiKeyException(env_var=TENCENT_KEY_VAR)
+
+        self.secret_id = secret_id
+        self.secret_key = secret_key
+        url = BASE_URLS.get("TENENT")
+        super().__init__(
+            base_url=url,
+            source=source,
+            target=target,
+            languages=TENCENT_LANGUAGE_TO_CODE,
+            **kwargs
+        )
+
+    def translate(self, text: str, **kwargs) -> str:
+        """
+        @param text: text to translate
+        @return: translated text
+        """
+        if is_input_valid(text):
+            if self._same_source_target() or is_empty(text):
+                return text
+
+            # Create the request parameters.
+            translate_endpoint = "tmt.tencentcloudapi.com"
+            params = {
+                "Action": "TextTranslate",
+                "Nonce": 11886,
+                "ProjectId": 0,
+                "Region": "ap-guangzhou",
+                "SecretId": self.secret_id,
+                "Source": self.source,
+                "SourceText": text,
+                "Target": self.target,
+                "Timestamp": int(time.time()),  # int(time.time())
+                "Version": "2018-03-21",
+            }
+            s = "GET" + translate_endpoint + "/?"
+            query_str = "&".join(
+                "%s=%s" % (k, params[k]) for k in sorted(params)
+            )
+            hmac_str = hmac.new(
+                self.secret_key.encode("utf8"),
+                (s + query_str).encode("utf8"),
+                hashlib.sha1,
+            ).digest()
+            params["Signature"] = base64.b64encode(hmac_str)
+
+            # Do the request and check the connection.
+            try:
+                response = requests.get(self._base_url, params=params)
+            except ConnectionError:
+                raise ServerException(503)
+            # If the answer is not success, raise server exception.
+            if response.status_code == 403:
+                raise AuthorizationException(self.secret_id)
+            elif response.status_code != 200:
+                raise ServerException(response.status_code)
+            # Get the response and check is not empty.
+            res = response.json()
+            if not res:
+                raise TranslationNotFound(text)
+            # Process and return the response.
+            if "Error" in res["Response"]:
+                raise TencentAPIerror(res["Response"]["Error"]["Code"])
+            return res["Response"]["TargetText"]
+
+    def translate_file(self, path: str, **kwargs) -> str:
+        return self._translate_file(path, **kwargs)
+
+    def translate_batch(self, batch: List[str], **kwargs) -> List[str]:
+        """
+        @param batch: list of texts to translate
+        @return: list of translations
+        """
+        return self._translate_batch(batch, **kwargs)
+
+
+if __name__ == "__main__":
+    d = TencentTranslator(
+        target="zh", secret_id="some-id", secret_key="some-key"
+    )
+    t = d.translate("Ich habe keine ahnung")
+    print("text: ", t)

tests/test_tencent.py

@@ -0,0 +1,37 @@
+from unittest.mock import Mock, patch
+
+import pytest
+
+from deep_translator import TencentTranslator
+from deep_translator.exceptions import AuthorizationException
+
+
+@patch("deep_translator.tencent.requests")
+def test_simple_translation(mock_requests):
+    translator = TencentTranslator(
+        secret_id="this-is-an-valid-api-id",
+        source="en",
+        target="zh",
+        secret_key="this-is-an-valid-api-key",
+    )
+    # Set the request response mock.
+    mock_response = Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {"translations": [{"text": "hola"}]}
+    mock_requests.get.return_value = mock_response
+    translation = translator.translate("hello")
+    assert translation == "你好"
+
+
+@patch("deep_translator.tencent.requests.get")
+def test_wrong_api_key(mock_requests):
+    translator = TencentTranslator(
+        secret_id="this-is-a-wrong-api-id",
+        source="en",
+        target="zh",
+        secret_key="this-is-a-wrong-api-key",
+    )
+    # Set the response status_code only.
+    mock_requests.return_value = Mock(status_code=403)
+    with pytest.raises(AuthorizationException):
+        translator.translate("Hello")