Merge pull request #50 from nidhaloff/feature/proxy

README.rst

@@ -81,6 +81,8 @@ Why you should use it
 - Easy to use and extend
 - Support for most famous universal translators
 - Stable and maintained regularly
+- The API is very easy to use
+- Proxy integration is supported
 
 ========
 Features
@@ -94,6 +96,7 @@ Features
 * Support for the `Yandex translator <https://yandex.com/>`_ (version >= 1.2.1)
 * Support for the `QCRI translator <https://mt.qcri.org/api/>`_ (version >= 1.2.4)
 * Support for the `DeepL translator <https://www.deepl.com/en/translator/>`_ (version >= 1.2.5)
+* Support for proxy usage
 * Automatic single language detection
 * Batch language detection
 * Translate directly from a text file
@@ -122,7 +125,20 @@ Quick Start
     from deep_translator import GoogleTranslator
     translated = GoogleTranslator(source='auto', target='de').translate("keep it up, you are awesome")  # output -> Weiter so, du bist großartig
 
-or from terminal
+or using proxies:
+
+.. code-block:: python
+
+    from deep_translator import GoogleTranslator
+
+    proxies_example = {
+        "https": "34.195.196.27:8080",
+        "http": "34.195.196.27:8080"
+    }
+    translated = GoogleTranslator(source='auto', target='de', proxies=proxies_example).translate("keep it up, you are awesome")  # output -> Weiter so, du bist großartig
+
+
+or even directly from terminal:
 
 .. code-block:: console
 
@@ -477,6 +493,26 @@ Microsoft Translator
 
     translated = MicrosoftTranslator(api_key='some-key', target='german').translate_file('path/to/file')
 
+Proxy usage
+-------------
+
+deep-translator provide out of the box usage of proxies. Just define your proxies config as a dictionary
+and pass it to the corresponding translator. Below is an example using the GoogleTranslator but this feature
+can be used with all supported translators.
+
+.. code-block:: python
+
+    from deep_translator import GoogleTranslator
+
+    # define your proxy configs:
+    proxies_example = {
+        "https": "your https proxy",  # example: 34.195.196.27:8080
+        "http": "your http proxy if available"
+    }
+    translated = GoogleTranslator(source='auto', target='de', proxies=proxies_example).translate("this package is awesome")
+
+
+
 
 Usage from Terminal
 --------------------

deep_translator/google_trans.py

@@ -19,12 +19,13 @@ class GoogleTranslator(BaseTranslator):
     _languages = GOOGLE_LANGUAGES_TO_CODES
     supported_languages = list(_languages.keys())
 
-    def __init__(self, source="auto", target="en"):
+    def __init__(self, source="auto", target="en", proxies=None, **kwargs):
         """
         @param source: source language to translate from
         @param target: target language to translate to
         """
         self.__base_url = BASE_URLS.get("GOOGLE_TRANSLATE")
+        self.proxies = proxies
 
         if self.is_language_supported(source, target):
             self._source, self._target = self._map_language_to_code(source.lower(), target.lower())
@@ -36,7 +37,8 @@ class GoogleTranslator(BaseTranslator):
                                                element_query={"class": "t0"},
                                                payload_key='q',  # key of text in the url
                                                hl=self._target,
-                                               sl=self._source)
+                                               sl=self._source,
+                                               **kwargs)
 
         self._alt_element_query = {"class": "result-container"}
 
@@ -89,8 +91,8 @@ class GoogleTranslator(BaseTranslator):
                 self._url_params[self.payload_key] = text
 
             response = requests.get(self.__base_url,
-                                    params=self._url_params, headers ={'User-agent': 'your bot 0.1'})
-
+                                    params=self._url_params,
+                                    proxies=self.proxies)
             if response.status_code == 429:
                 raise TooManyRequests()
 
@@ -180,7 +182,8 @@ class GoogleTranslator(BaseTranslator):
         return arr
 
 
-# if __name__ == '__main__':
-#     batch = ["tude", "fleck", "incongruous"]
-#     text = GoogleTranslator(source="en", target="de").translate_batch(batch)
-#     print(text)
+if __name__ == '__main__':
+    # test proxy config
+    proxies = None
+    text = GoogleTranslator(source="en", target="de", proxies=proxies).translate("you are good")
+    print(text)

deep_translator/linguee.py

@@ -22,12 +22,13 @@ class LingueeTranslator(BaseTranslator):
     _languages = LINGUEE_LANGUAGES_TO_CODES
     supported_languages = list(_languages.keys())
 
-    def __init__(self, source, target="en"):
+    def __init__(self, source, target="en", proxies=None):
         """
         @param source: source language to translate from
         @param target: target language to translate to
         """
         self.__base_url = BASE_URLS.get("LINGUEE")
+        self.proxies = proxies
 
         if self.is_language_supported(source, target):
             self._source, self._target = self._map_language_to_code(source.lower(), target.lower())
@@ -88,7 +89,7 @@ class LingueeTranslator(BaseTranslator):
             # %s-%s/translation/%s.html
             url = "{}{}-{}/translation/{}.html".format(self.__base_url, self._source, self._target, word)
             url = requote_uri(url)
-            response = requests.get(url)
+            response = requests.get(url, proxies=self.proxies)
 
             if response.status_code == 429:
                 raise TooManyRequests()

deep_translator/microsoft.py

@@ -17,7 +17,7 @@ class MicrosoftTranslator:
     _languages = MICROSOFT_CODES_TO_LANGUAGES
     supported_languages = list(_languages.values())
 
-    def __init__(self, api_key=None, region=None, source=None, target=None, **kwargs):
+    def __init__(self, api_key=None, region=None, source=None, target=None, proxies=None, **kwargs):
         """
         @params api_key and target are the required params
         @param api_key: your Microsoft API key
@@ -27,6 +27,8 @@ class MicrosoftTranslator:
             raise ServerException(401)
         else:
             self.api_key = api_key
+
+        self.proxies = proxies
         self.headers = {
             "Ocp-Apim-Subscription-Key": self.api_key,
             "Content-type": "application/json",
@@ -108,7 +110,8 @@ class MicrosoftTranslator:
             requested = requests.post(self.__base_url,
                                       params=self.url_params,
                                       headers=self.headers,
-                                      json=valid_microsoft_json)
+                                      json=valid_microsoft_json,
+                                      proxies=self.proxies)
         except requests.exceptions.RequestException:
             exc_type, value, traceback = sys.exc_info()
             logging.warning(f"Returned error: {exc_type.__name__}")

deep_translator/mymemory.py

@@ -22,12 +22,13 @@ class MyMemoryTranslator(BaseTranslator):
     _languages = GOOGLE_LANGUAGES_TO_CODES
     supported_languages = list(_languages.keys())
 
-    def __init__(self, source="auto", target="en", **kwargs):
+    def __init__(self, source="auto", target="en", proxies=None, **kwargs):
         """
         @param source: source language to translate from
         @param target: target language to translate to
         """
         self.__base_url = BASE_URLS.get("MYMEMORY")
+        self.proxies = proxies
         if self.is_language_supported(source, target):
             self._source, self._target = self._map_language_to_code(source.lower(), target.lower())
             self._source = self._source if self._source != 'auto' else 'Lao'
@@ -93,7 +94,8 @@ class MyMemoryTranslator(BaseTranslator):
 
             response = requests.get(self.__base_url,
                                     params=self._url_params,
-                                    headers=self.headers)
+                                    headers=self.headers,
+                                    proxies=self.proxies)
 
             if response.status_code == 429:
                 raise TooManyRequests()

deep_translator/pons.py

@@ -21,13 +21,13 @@ class PonsTranslator(BaseTranslator):
     _languages = PONS_LANGUAGES_TO_CODES
     supported_languages = list(_languages.keys())
 
-    def __init__(self, source, target="english"):
+    def __init__(self, source, target="en", proxies=None):
         """
         @param source: source language to translate from
         @param target: target language to translate to
         """
         self.__base_url = BASE_URLS.get("PONS")
-
+        self.proxies = proxies
         if self.is_language_supported(source, target):
             self._source, self._target = self._map_language_to_code(source, target)
 
@@ -86,7 +86,7 @@ class PonsTranslator(BaseTranslator):
         if self._validate_payload(word, max_chars=50):
             url = "{}{}-{}/{}".format(self.__base_url, self._source, self._target, word)
             url = requote_uri(url)
-            response = requests.get(url)
+            response = requests.get(url, proxies=self.proxies)
 
             if response.status_code == 429:
                 raise TooManyRequests()