updated readme and format

deep_translator/base.py

@@ -4,7 +4,10 @@ from abc import ABC, abstractmethod
 from typing import List, Optional, Union
 
 from deep_translator.constants import GOOGLE_LANGUAGES_TO_CODES
-from deep_translator.exceptions import InvalidSourceOrTargetLanguage, LanguageNotSupportedException
+from deep_translator.exceptions import (
+    InvalidSourceOrTargetLanguage,
+    LanguageNotSupportedException,
+)
 
 
 class BaseTranslator(ABC):
@@ -21,7 +24,7 @@ class BaseTranslator(ABC):
         payload_key: Optional[str] = None,
         element_tag: Optional[str] = None,
         element_query: Optional[dict] = None,
-        **url_params
+        **url_params,
     ):
         """
         @param source: source language to translate from
@@ -76,8 +79,9 @@ class BaseTranslator(ABC):
                 raise LanguageNotSupportedException(
                     language,
                     message=f"No support for the provided language.\n"
-                            f"Please select on of the supported languages:\n"
-                            f"{self._languages}")
+                    f"Please select on of the supported languages:\n"
+                    f"{self._languages}",
+                )
 
     def _same_source_target(self) -> bool:
         return self._source == self._target

deep_translator/google.py

@@ -118,6 +118,6 @@ class GoogleTranslator(BaseTranslator):
 
 
 if __name__ == "__main__":
-    trans = GoogleTranslator(source='auto', target='zh-CN')
+    trans = GoogleTranslator(source="auto", target="zh-CN")
     res = trans.translate("good")
     print("translation: ", res)

deep_translator/libre.py

@@ -27,7 +27,7 @@ class LibreTranslator(BaseTranslator):
         source: str = "en",
         target: str = "es",
         use_free_api: bool = True,
-        custom_url:  Optional[str] = None,
+        custom_url: Optional[str] = None,
         **kwargs
     ):
         """
@@ -40,7 +40,9 @@ class LibreTranslator(BaseTranslator):
         @param custom_url: you can use a custom endpoint
         """
         self.api_key = api_key
-        url = BASE_URLS.get("LIBRE") if not use_free_api else BASE_URLS.get('LIBRE_FREE')
+        url = (
+            BASE_URLS.get("LIBRE") if not use_free_api else BASE_URLS.get("LIBRE_FREE")
+        )
         super().__init__(
             base_url=url if not custom_url else custom_url,
             source=source,
@@ -107,7 +109,7 @@ class LibreTranslator(BaseTranslator):
         return self._translate_batch(batch, **kwargs)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     l = LibreTranslator(source="en", target="de")
     res = l.translate("good")
     print("res: ", res)

deep_translator/microsoft.py

@@ -58,12 +58,17 @@ class MicrosoftTranslator(BaseTranslator):
     # a common variable used in the other translators would be: MICROSOFT_CODES_TO_LANGUAGES
     def _get_supported_languages(self):
 
-        microsoft_languages_api_url = "https://api.cognitive.microsofttranslator.com/languages?api-version=3.0&scope" \
-                                      "=translation "
+        microsoft_languages_api_url = (
+            "https://api.cognitive.microsofttranslator.com/languages?api-version=3.0&scope"
+            "=translation "
+        )
         microsoft_languages_response = requests.get(microsoft_languages_api_url)
         translation_dict = microsoft_languages_response.json()["translation"]
 
-        return {translation_dict[k]["name"].lower(): k.lower() for k in translation_dict.keys()}
+        return {
+            translation_dict[k]["name"].lower(): k.lower()
+            for k in translation_dict.keys()
+        }
 
     def translate(self, text: str, **kwargs) -> str:
         """

docs/README.rst

@@ -199,15 +199,16 @@ Check Supported Languages
 .. note::
 
     You can check the supported languages of each translator by calling the
-    get_supported_languages function as a static method.
+    get_supported_languages function.
 
 .. code-block:: python
 
     # default return type is a list
-    langs_list = GoogleTranslator.get_supported_languages()  # output: [arabic, french, english etc...]
+    langs_list = GoogleTranslator().get_supported_languages()  # output: [arabic, french, english etc...]
 
     # alternatively, you can the dictionary containing languages mapped to their abbreviation
-    langs_dict = GoogleTranslator.get_supported_languages(as_dict=True)  # output: {arabic: ar, french: fr, english:en etc...}
+    langs_dict = GoogleTranslator().get_supported_languages(as_dict=True)  # output: {arabic: ar, french: fr, english:en etc...}
+
 
 Language Detection
 ------------------

docs/conf.py

@@ -20,7 +20,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 # import deep_translator
 
@@ -30,26 +30,26 @@ sys.path.insert(0, os.path.abspath('..'))
 #
 # needs_sphinx = '1.0'
 
-html_logo = '../assets/icon.jpg'
+html_logo = "../assets/icon.jpg"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'deep_translator'
+project = "deep_translator"
 copyright = "2020, Nidhal Baccouri"
 author = "Nidhal Baccouri"
 
@@ -62,7 +62,7 @@ import toml
 
 with open("../pyproject.toml", "r") as f:
     tom = toml.load(f)
-version = tom['tool']['poetry']['version']
+version = tom["tool"]["poetry"]["version"]
 # The full version, including alpha/beta/rc tags.
 # release = deep_translator.__version__
 
@@ -76,10 +76,10 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -90,7 +90,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -101,13 +101,13 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'deep_translatordoc'
+htmlhelp_basename = "deep_translatordoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -116,15 +116,12 @@ latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -134,9 +131,13 @@ latex_elements = {
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'deep_translator.tex',
-     'deep_translator Documentation',
-     'Nidhal Baccouri', 'manual'),
+    (
+        master_doc,
+        "deep_translator.tex",
+        "deep_translator Documentation",
+        "Nidhal Baccouri",
+        "manual",
+    ),
 ]
 
 
@@ -145,9 +146,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'deep_translator',
-     'deep_translator Documentation',
-     [author], 1)
+    (master_doc, "deep_translator", "deep_translator Documentation", [author], 1)
 ]
 
 
@@ -157,13 +156,13 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'deep_translator',
-     'deep_translator Documentation',
-     author,
-     'deep_translator',
-     'A flexible free and unlimited python tool to translate between different languages in a simple way using multiple translators.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "deep_translator",
+        "deep_translator Documentation",
+        author,
+        "deep_translator",
+        "A flexible free and unlimited python tool to translate between different languages in a simple way using multiple translators.",
+        "Miscellaneous",
+    ),
 ]
-
-
-

examples/libre.py

@@ -1,5 +1,5 @@
 from deep_translator import LibreTranslator
 
-res = LibreTranslator(source='de', target='en').translate('laufen')
+res = LibreTranslator(source="de", target="en").translate("laufen")
 
 print(res)

examples/linguee.py

@@ -1,6 +1,5 @@
-
 from deep_translator import LingueeTranslator
 
-res = LingueeTranslator(source='de', target='en').translate('laufen', return_all=False)
+res = LingueeTranslator(source="de", target="en").translate("laufen", return_all=False)
 
 print(res)

examples/mymemory.py

@@ -1,6 +1,5 @@
-
 from deep_translator import MyMemoryTranslator
 
-res = MyMemoryTranslator(source='ar', target='en').translate('آخُذ اَلْباص.')
+res = MyMemoryTranslator(source="ar", target="en").translate("آخُذ اَلْباص.")
 
 print(res)

examples/pons.py

@@ -1,6 +1,5 @@
-
 from deep_translator import PonsTranslator
 
-res = PonsTranslator(source='en', target='de').translate('good', return_all=False)
+res = PonsTranslator(source="en", target="de").translate("good", return_all=False)
 
 print(res)

examples/trans.py

@@ -2,9 +2,9 @@ from deep_translator import GoogleTranslator, LingueeTranslator, PonsTranslator
 
 # examples using google translate
 
-english_text = 'happy coding'
-chinese_text = '這很好'
-translator = GoogleTranslator(source='auto', target='german')
+english_text = "happy coding"
+chinese_text = "這很好"
+translator = GoogleTranslator(source="auto", target="german")
 result1 = translator.translate(text=english_text)
 result2 = translator.translate(text=chinese_text)
 
@@ -12,16 +12,15 @@ print(f"original english text: {english_text} | translated text: {result1}")
 print(f"original chinese text: {chinese_text} | translated text: {result2}")
 
 # file translation
-result_file = translator.translate_file('./test.txt')
+result_file = translator.translate_file("./test.txt")
 print("file translation: ", result_file)
 
 # examples using linguee:
-text = 'cute'
-translated = LingueeTranslator(source='english', target='german').translate(word=text)
+text = "cute"
+translated = LingueeTranslator(source="english", target="german").translate(word=text)
 print("Using Linguee ==> the translated text: ", translated)
 
 # examples using pons:
-text = 'good'
-translated = PonsTranslator(source='en', target='ar').translate(word=text)
+text = "good"
+translated = PonsTranslator(source="en", target="ar").translate(word=text)
 print("using Pons ==> the translated text: ", translated)
-