update baidu translator api

deep_translator/baidu.py

@@ -13,8 +13,8 @@ import requests
 
 from deep_translator.base import BaseTranslator
 from deep_translator.constants import (
-    BAIDU_ID_VAR,
-    BAIDU_KEY_VAR,
+    BAIDU_APPID_VAR,
+    BAIDU_APPKEY_VAR,
     BAIDU_LANGUAGE_TO_CODE,
     BASE_URLS,
 )
@@ -29,7 +29,7 @@ from deep_translator.validate import is_empty, is_input_valid
 
 class BaiduTranslator(BaseTranslator):
     """
-    class that wraps functions, which use the TentCentTranslator translator
+    class that wraps functions, which use the BaiduTranslator translator
     under the hood to translate word(s)
     """
 
@@ -37,25 +37,25 @@ class BaiduTranslator(BaseTranslator):
         self,
         source: str = "en",
         target: str = "zh",
-        secret_id: Optional[str] = os.getenv(BAIDU_ID_VAR, None),
-        secret_key: Optional[str] = os.getenv(BAIDU_KEY_VAR, None),
+        appid: Optional[str] = os.getenv(BAIDU_APPID_VAR, None),
+        appkey: Optional[str] = os.getenv(BAIDU_APPKEY_VAR, None),
         **kwargs
     ):
         """
-        @param secret_id: your baidu cloud api secret id.
+        @param appid: your baidu cloud api appid.
         Get one here: https://fanyi-api.baidu.com/choose
-        @param secret_key: your baidu cloud api secret key.
+        @param appkey: your baidu cloud api appkey.
         @param source: source language
         @param target: target language
         """
-        if not secret_id:
-            raise ApiKeyException(env_var=BAIDU_ID_VAR)
+        if not appid:
+            raise ApiKeyException(env_var=BAIDU_APPID_VAR)
 
-        if not secret_key:
-            raise ApiKeyException(env_var=BAIDU_KEY_VAR)
+        if not appkey:
+            raise ApiKeyException(env_var=BAIDU_APPKEY_VAR)
 
-        self.secret_id = secret_id
-        self.secret_key = secret_key
+        self.appid = appid
+        self.appkey = appkey
         super().__init__(
             base_url=BASE_URLS.get("BAIDU"),
             source=source,
@@ -76,13 +76,11 @@ class BaiduTranslator(BaseTranslator):
             # Create the request parameters.
             salt = random.randint(32768, 65536)
             sign = hashlib.md5(
-                (self.secret_id + text + str(salt) + self.secret_key).encode(
-                    "utf-8"
-                )
+                (self.appid + text + str(salt) + self.appkey).encode("utf-8")
             ).hexdigest()
             headers = {"Content-Type": "application/x-www-form-urlencoded"}
             payload = {
-                "appid": self.secret_id,
+                "appid": self.appid,
                 "q": text,
                 "from": self.source,
                 "to": self.target,
@@ -125,7 +123,7 @@ class BaiduTranslator(BaseTranslator):
 
 if __name__ == "__main__":
     d = BaiduTranslator(
-        target="zh", secret_id="some-id", secret_key="some-key"
+        target="zh", appid="some-appid", appkey="some-appkey"
     )
     t = d.translate("Hello\nHow are you?")
     print("text: ", t)

deep_translator/constants.py

@@ -7,8 +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"
-BAIDU_ID_VAR = "BAIDU_ID"
-BAIDU_KEY_VAR = "BAIDU_KEY"
+BAIDU_APPID_VAR = "BAIDU_APPID"
+BAIDU_APPKEY_VAR = "BAIDU_APPKEY"
 
 
 BASE_URLS = {

docs/README.rst

@@ -665,6 +665,36 @@ Libre Translator
     translated = LibreTranslator(source='auto', target='en').translate_file('path/to/file')
 
 
+BaiduTranslator
+-----------------
+
+.. note::
+
+    In order to use the BaiduTranslator translator, you need to generate a secret_id and a secret_key.
+    deep-translator supports both Pro and free APIs. Just check the examples below.
+    Visit http://api.fanyi.baidu.com/product/113 for more information on how to generate your Baidu appid
+    and appkey.
+
+- Simple translation
+
+.. code-block:: python
+
+    text = 'Hello world'
+    translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate(text)
+
+- Translate batch of texts
+
+.. code-block:: python
+=
+    texts = ["Hello world", "How are you?"]
+    translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_batch(texts)
+
+- Translate from a file:
+
+.. code-block:: python
+
+    translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_file('path/to/file')
+
 
 Proxy usage
 -------------

tests/test_baidu.py

@@ -9,8 +9,8 @@ from deep_translator.exceptions import BaiduAPIerror
 @patch("deep_translator.baidu.requests")
 def test_simple_translation(mock_requests):
     translator = BaiduTranslator(
-        secret_id="this-is-an-valid-api-id",
-        secret_key="this-is-an-valid-api-key",
+        appid="this-is-an-valid-appid",
+        appkey="this-is-an-valid-appkey",
         source="en",
         target="zh",
     )
@@ -30,8 +30,8 @@ def test_simple_translation(mock_requests):
 @patch("deep_translator.baidu.requests.get")
 def test_wrong_api_key(mock_requests):
     translator = BaiduTranslator(
-        secret_id="this-is-a-wrong-api-id",
-        secret_key="this-is-a-wrong-api-key",
+        appid="this-is-a-wrong-appid",
+        appkey="this-is-a-wrong-appkey",
         source="en",
         target="zh",
     )
@@ -45,3 +45,21 @@ def test_wrong_api_key(mock_requests):
     mock_requests.post.return_value = mock_response
     with pytest.raises(BaiduAPIerror):
         translator.translate("Hello")
+
+
+# the remaining tests are actual requests to Baidu translator API and use appid and appkey
+# if appid and appkey variable is None, they are skipped
+
+appid = None
+appkey = None
+
+
+@pytest.mark.skipif(
+    appid is None or appkey is None,
+    reason="appid or appkey is not provided",
+)
+def test_baidu_successful_post_onetarget():
+    posted = BaiduTranslator(
+        appid=appid, appkey=appkey, source="en", target="zh"
+    ).translate("Hello! How are you?")
+    assert isinstance(posted, str)