refactor(providers/soup): Cleanup request API

- Thet get method doesn't need a `form` arg
- Make the `json` arg more clear renaming it to `return_json`

Author: rafaelmardojai

dialect/providers/modules/bing.py

@@ -53,7 +53,7 @@ def translate_url(self):
         return self.format_url("www.bing.com", "/ttranslatev3", params)
 
     async def init_trans(self):
-        response = await self.get(self.html_url, self._headers, check_common=False, json=False)
+        response = await self.get(self.html_url, self._headers, check_common=False, return_json=False)
 
         if response:
             try:
@@ -125,11 +125,13 @@ async def translate(self, request):
                     detected=detected,
                     pronunciation=TranslationPronunciation(None, pronunciation),
                 )
+            else:
+                raise UnexpectedError("Unexpected translation response")
 
         except Exception as exc:
             raise UnexpectedError from exc
 
-    def check_known_errors(self, _status, data):
+    def check_known_errors(self, status, data):
         if not data:
             raise UnexpectedError("Response is empty!")
 

dialect/providers/modules/deepl.py

@@ -65,8 +65,8 @@ def headers(self):
 
     async def init_trans(self):
         # Get languages
-        src_langs = await self.get(self.source_lang_url, headers=self.headers)
-        dest_langs = await self.get(self.target_lang_url, headers=self.headers)
+        src_langs = await self.get(self.source_lang_url, self.headers)
+        dest_langs = await self.get(self.target_lang_url, self.headers)
 
         if src_langs and dest_langs and isinstance(src_langs, list) and isinstance(dest_langs, list):
             for lang in src_langs:
@@ -80,7 +80,7 @@ async def validate_api_key(self, key):
         headers = {"Authorization": f"DeepL-Auth-Key {key}"}
 
         try:
-            await self.get(url, headers=headers)
+            await self.get(url, headers)
             return True
         except (APIKeyInvalid, APIKeyRequired):
             return False
@@ -111,7 +111,7 @@ async def translate(self, request):
         raise UnexpectedError
 
     async def api_char_usage(self):
-        response = await self.get(self.usage_url, headers=self.headers)
+        response = await self.get(self.usage_url, self.headers)
 
         try:
             usage = response.get("character_count")

dialect/providers/modules/google.py

@@ -253,7 +253,7 @@ async def init_trans(self):
         langs_url = self.format_url(
             self._get_translate_host(".com"), "/translate_a/l", {"client": "t", "alpha": "true"}
         )
-        response = await self.get(langs_url, self._headers, check_common=False)
+        response = await self.get(langs_url, self._headers, False)
 
         try:
             for code, name in response["tl"].items():
@@ -447,9 +447,3 @@ def __init__(self, text: str, candidates: list[str]):
 
     def __str__(self):
         return self.text
-
-    def __dict__(self):
-        return {
-            "text": self.text,
-            "candidates": self.candidates,
-        }

dialect/providers/modules/libretrans.py

@@ -143,7 +143,7 @@ async def suggest(self, text, src, dest, suggestion):
         except:  # noqa
             return False
 
-    def check_known_errors(self, _status, data):
+    def check_known_errors(self, status, data):
         if not data:
             raise UnexpectedError("Response is empty!")
 

dialect/providers/modules/lingva.py

@@ -121,7 +121,7 @@ async def speech(self, text, language):
             file.close()
             raise UnexpectedError from exc
 
-    def check_known_errors(self, _status, data):
+    def check_known_errors(self, status, data):
         """Raises a proper Exception if an error is found in the data."""
         if not data:
             raise UnexpectedError("Response is empty!")

dialect/providers/modules/yandex.py

@@ -50,7 +50,7 @@ async def init_trans(self):
         # Get Yandex Translate web HTML to parse languages
         # Using `/api/v1/tr.json/getLangs` doesn't provide all the languages that Yandex supports
         html_url = self.format_url("translate.yandex.com")
-        response = await self.get(html_url, check_common=False, json=False)
+        response = await self.get(html_url, check_common=False, return_json=False)
 
         if response:
             try:

dialect/providers/soup.py

@@ -115,7 +115,7 @@ async def send_and_read_and_process(
         self,
         message: Soup.Message,
         check_common: bool = True,
-        json: bool = True,
+        return_json: bool = True,
     ) -> Any:
         """
         Helper mixing ``SoupProvider.send_and_read``, ``SoupProvider.send_and_read_json``
@@ -126,14 +126,14 @@ async def send_and_read_and_process(
         Args:
             message: Message to send.
             check_common: If response data should be checked for errors using check_known_errors.
-            json: If data should be processed as JSON.
+            return_json: If the response should be parsed as JSON.
 
         Returns:
             The JSON deserialized to a python object or bytes if ``json`` is ``False``.
         """
 
         try:
-            if json:
+            if return_json:
                 response = await self.send_and_read_json(message)
             else:
                 response = await self.send_and_read(message)
@@ -153,7 +153,7 @@ async def request(
         headers: dict = {},
         form: bool = False,
         check_common: bool = True,
-        json: bool = True,
+        return_json: bool = True,
     ) -> Any:
         """
         Helper for regular HTTP request.
@@ -165,36 +165,34 @@ async def request(
             headers: HTTP headers of the message.
             form: If the data should be encoded as a form.
             check_common: If response data should be checked for errors using check_known_errors.
-            json: If data should be processed as JSON.
+            return_json: If the response should be parsed as JSON.
 
         Returns:
             The JSON deserialized to a python object or bytes if ``json`` is ``False``.
         """
         message = self.create_message(method, url, data, headers, form)
-        return await self.send_and_read_and_process(message, check_common, json)
+        return await self.send_and_read_and_process(message, check_common, return_json)
 
     async def get(
         self,
         url: str,
         headers: dict = {},
-        form: bool = False,
         check_common: bool = True,
-        json: bool = True,
+        return_json: bool = True,
     ) -> Any:
         """
         Helper for GET HTTP request.
 
         Args:
             url: Url of the request.
             headers: HTTP headers of the message.
-            form: If the data should be encoded as a form.
             check_common: If response data should be checked for errors using check_known_errors.
-            json: If data should be processed as JSON.
+            return_json: If the response should be parsed as JSON.
 
         Returns:
             The JSON deserialized to a python object or bytes if ``json`` is ``False``.
         """
-        return await self.request("GET", url, headers=headers, form=form, check_common=check_common, json=json)
+        return await self.request("GET", url, headers=headers, check_common=check_common, return_json=return_json)
 
     async def post(
         self,
@@ -203,7 +201,7 @@ async def post(
         headers: dict = {},
         form: bool = False,
         check_common: bool = True,
-        json: bool = True,
+        return_json: bool = True,
     ) -> Any:
         """
         Helper for POST HTTP request.
@@ -214,9 +212,9 @@ async def post(
             headers: HTTP headers of the message.
             form: If the data should be encoded as a form.
             check_common: If response data should be checked for errors using check_known_errors.
-            json: If data should be processed as JSON.
+            return_json: If the response should be parsed as JSON.
 
         Returns:
             The JSON deserialized to a python object or bytes if ``json`` is ``False``.
         """
-        return await self.request("POST", url, data, headers, form, check_common, json)
+        return await self.request("POST", url, data, headers, form, check_common, return_json)