added support for qcri

README.rst

@@ -99,6 +99,8 @@ Features
 * Support for the `Linguee translator <https://www.linguee.com//>`_
 * Support for the `Mymemory translator <https://mymemory.translated.net//>`_
 * 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)
+
 * Automatic single language detection
 * Batch language detection
 * Translate directly from a text file
@@ -272,6 +274,38 @@ Mymemory Translator
 
     translated = MyMemoryTranslator(source='en', target='fr').translate_file(path)
 
+QCRI Translator
+--------------------
+
+.. note::
+
+    In order to use the QCRI translator, you need to generate a free api key. Visit https://mt.qcri.org/api/
+    for more information
+
+- Check languages
+
+.. code-block:: python
+
+    # as a property
+    print("language pairs: ", QCRI("your_api_key").languages)
+
+- Check domains
+
+.. code-block:: python
+
+    # as a property
+    print("domains: ", QCRI("your_api_key").domains)
+
+- Text translation
+
+.. code-block:: python
+
+    text = 'Education is great'
+
+    translated = QCRI("your_api_key").translate(source='en', target='ar', domain="news", text=text)
+    # output -> التعليم هو عظيم
+
+    # see docs for batch translation and more.
 
 Linguee Translator
 -------------------

deep_translator/constants.py

@@ -178,3 +178,5 @@ LINGUEE_LANGUAGES_TO_CODES = {
 }
 
 LINGUEE_CODE_TO_LANGUAGE = {v: k for k, v in LINGUEE_LANGUAGES_TO_CODES.items()}
+
+# "72e9e2cc7c992db4dcbdd6fb9f91a0d1"

deep_translator/exceptions.py

@@ -93,7 +93,7 @@ class TooManyRequests(Exception):
         return self.message
 
 
-class YandexDefaultException(Exception):
+class ServerException(Exception):
     """
     Default YandexTranslate exception from the official website
     """
@@ -109,5 +109,5 @@ class YandexDefaultException(Exception):
     }
 
     def __init__(self, status_code, *args):
-        message = self.errors.get(status_code)
-        super(YandexDefaultException, self).__init__(message, *args)
+        message = self.errors.get(status_code, "API server error")
+        super(ServerException, self).__init__(message, *args)

deep_translator/qcri.py

@@ -1,11 +1,12 @@
 
 import requests
+from requests.utils import requote_uri
 from deep_translator.constants import BASE_URLS
 from deep_translator.exceptions import (RequestError,
-                                        YandexDefaultException, TranslationNotFound, TooManyRequests)
+                                        ServerException, TranslationNotFound, TooManyRequests)
 
 
-class YandexTranslator(object):
+class QCRI(object):
     """
     class that wraps functions, which use the yandex translator under the hood to translate word(s)
     """
@@ -15,125 +16,71 @@ class YandexTranslator(object):
         @param api_key: your qrci api key. Get one for free here https://mt.qcri.org/api/v1/ref
         """
 
-        # key: "72e9e2cc7c992db4dcbdd6fb9f91a0d1"
         if not api_key:
-            raise YandexDefaultException(401)
-        self.__base_url = BASE_URLS.get("QRCI")
+            raise ServerException(401)
+        self.__base_url = BASE_URLS.get("QCRI")
 
         self.api_key = api_key
-        self.api_version = "v1.5"
         self.api_endpoints = {
-            "langs": "getLangs",
-            "detect": "detect",
-            "translate": "translate",
-        }
-        endpoints = {
             "get_languages": "getLanguagePairs",
             "get_domains": "getDomains",
             "translate": "translate",
-
         }
 
-        params = {
-            "key": api_key
+        self.params = {
+            "key": self.api_key
         }
-        pairs = requests.get(self.__base_url.format(endpoint=endpoints["get_languages"]), params=params)
 
-        print(pairs.url, pairs.text)
+    def _get(self, endpoint, params=None, return_text=True):
+        if not params:
+            params = self.params
+        try:
+            res = requests.get(self.__base_url.format(endpoint=self.api_endpoints[endpoint]), params=params)
+            return res.text if return_text else res
+        except Exception as e:
+            raise e
 
     def get_supported_languages(self):
-        return set(x.split("-")[0] for x in self.dirs)
+
+        pairs = self._get("get_languages")
+        return pairs
 
     @property
     def languages(self):
         return self.get_supported_languages()
 
-    @property
-    def dirs(self, proxies=None):
+    def get_domains(self):
+        domains = self._get("get_domains")
+        return domains
 
-        try:
-            url = self.__base_url.format(version=self.api_version, endpoint="getLangs")
-            print("url: ", url)
-            response = requests.get(url, params={"key": self.api_key}, proxies=proxies)
-        except requests.exceptions.ConnectionError:
-            raise YandexDefaultException(503)
-        else:
-            data = response.json()
-
-        if response.status_code != 200:
-            raise YandexDefaultException(response.status_code)
-        return data.get("dirs")
+    @property
+    def domains(self):
+        return self.get_domains()
 
-    def detect(self, text, proxies=None):
-        response = None
+    def translate(self, source, target, domain, text):
         params = {
-            "text": text,
-            "format": "plain",
             "key": self.api_key,
+            "langpair": "{}-{}".format(source, target),
+            "domain": domain,
+            "text": text
         }
+        print("params: ", params)
         try:
-            url = self.__base_url.format(version=self.api_version, endpoint="detect")
-            response = requests.post(url, data=params, proxies=proxies)
-
-        except RequestError:
-            raise
-        except ConnectionError:
-            raise YandexDefaultException(503)
-        except ValueError:
-            raise YandexDefaultException(response.status_code)
-        else:
-            response = response.json()
-        language = response['lang']
-        status_code = response['code']
-        if status_code != 200:
-            raise RequestError()
-        elif not language:
-            raise YandexDefaultException(501)
-        return language
-
-    def translate(self, source, target, text, proxies=None):
-        params = {
-            "text": text,
-            "format": "plain",
-            "lang": target if source == "auto" else "{}-{}".format(source, target),
-            "key": self.api_key
-        }
-        try:
-            url = self.__base_url.format(version=self.api_version, endpoint="translate")
-            response = requests.post(url, data=params, proxies=proxies)
+            response = self._get("translate", params=params, return_text=False)
         except ConnectionError:
-            raise YandexDefaultException(503)
-        else:
-            response = response.json()
-
-        if response['code'] == 429:
-            raise TooManyRequests()
-
-        if response['code'] != 200:
-            raise YandexDefaultException(response['code'])
-
-        if not response['text']:
-            raise TranslationNotFound()
-
-        return response['text']
-
-    def translate_file(self, source, target, path):
-        """
-        translate from a file
-        @param source: source language
-        @param target: target language
-        @param path: path to file
-        @return: translated text
-        """
-        try:
-            with open(path) as f:
-                text = f.read()
+            raise ServerException(503)
 
-            return self.translate(source, target, text)
-        except Exception as e:
-            raise e
-
-    def translate_batch(self, source, target, batch):
+        else:
+            if response.status_code != 200:
+                ServerException(response.status_code)
+            else:
+                res = response.json()
+                translation = res["translatedText"]
+                if not translation:
+                    raise TranslationNotFound(text)
+                return translation
+
+    def translate_batch(self, source, target, domain, batch):
         """
         translate a batch of texts
         @param source: source language
@@ -141,5 +88,5 @@ class YandexTranslator(object):
         @param batch: list of texts to translate
         @return: list of translations
         """
-        return [self.translate(source, target, text) for text in batch]
+        return [self.translate(source, target, domain, text) for text in batch]
 

deep_translator/yandex.py

@@ -5,7 +5,7 @@ import requests
 from requests import exceptions
 from deep_translator.constants import BASE_URLS
 from deep_translator.exceptions import (RequestError,
-                                        YandexDefaultException, TranslationNotFound, TooManyRequests)
+                                        ServerException, TranslationNotFound, TooManyRequests)
 
 
 class YandexTranslator(object):
@@ -18,7 +18,7 @@ class YandexTranslator(object):
         @param api_key: your yandex api key
         """
         if not api_key:
-            raise YandexDefaultException(401)
+            raise ServerException(401)
         self.__base_url = BASE_URLS.get("YANDEX")
 
         self.api_key = api_key
@@ -44,12 +44,12 @@ class YandexTranslator(object):
             print("url: ", url)
             response = requests.get(url, params={"key": self.api_key}, proxies=proxies)
         except requests.exceptions.ConnectionError:
-            raise YandexDefaultException(503)
+            raise ServerException(503)
         else:
             data = response.json()
 
         if response.status_code != 200:
-            raise YandexDefaultException(response.status_code)
+            raise ServerException(response.status_code)
         return data.get("dirs")
 
     def detect(self, text, proxies=None):
@@ -66,9 +66,9 @@ class YandexTranslator(object):
         except RequestError:
             raise
         except ConnectionError:
-            raise YandexDefaultException(503)
+            raise ServerException(503)
         except ValueError:
-            raise YandexDefaultException(response.status_code)
+            raise ServerException(response.status_code)
         else:
             response = response.json()
         language = response['lang']
@@ -76,7 +76,7 @@ class YandexTranslator(object):
         if status_code != 200:
             raise RequestError()
         elif not language:
-            raise YandexDefaultException(501)
+            raise ServerException(501)
         return language
 
     def translate(self, source, target, text, proxies=None):
@@ -90,7 +90,7 @@ class YandexTranslator(object):
             url = self.__base_url.format(version=self.api_version, endpoint="translate")
             response = requests.post(url, data=params, proxies=proxies)
         except ConnectionError:
-            raise YandexDefaultException(503)
+            raise ServerException(503)
         else:
             response = response.json()
 
@@ -98,7 +98,7 @@ class YandexTranslator(object):
             raise TooManyRequests()
 
         if response['code'] != 200:
-            raise YandexDefaultException(response['code'])
+            raise ServerException(response['code'])
 
         if not response['text']:
             raise TranslationNotFound()

docs/usage.rst

@@ -138,6 +138,39 @@ Mymemory Translator
     translated = MyMemoryTranslator(source='en', target='fr').translate_file(path)
 
 
+QCRI Translator
+--------------------
+
+.. note::
+
+    In order to use the QCRI translator, you need to generate a free api key. Visit https://mt.qcri.org/api/
+    for more information
+
+- Check languages
+
+.. code-block:: python
+
+    # as a property
+    print("language pairs: ", QCRI("your_api_key").languages)
+
+- Check domains
+
+.. code-block:: python
+
+    # as a property
+    print("domains: ", QCRI("your_api_key").domains)
+
+- Text translation
+
+.. code-block:: python
+
+    text = 'Education is great'
+
+    translated = QCRI("your_api_key").translate(source='en', target='ar', domain="news", text=text)
+    # output -> التعليم هو عظيم
+
+    # see docs for batch translation and more.
+
 Linguee Translator
 -------------------