Merge pull request #73 from nidhaloff/nothead31/issue66

AUTHORS.rst

@@ -12,3 +12,4 @@ Contributors
 
 @prataffel
 @senk8
+@nothead31

deep_translator/__init__.py

@@ -13,18 +13,17 @@ from .microsoft import MicrosoftTranslator
 from .papago import PapagoTranslator
 
 # TODO: Discussion: These should be declared in setup.cfg, setting them here is redundant
-# __author__ = """Nidhal Baccouri"""
-# __email__ = '[email protected]'
-# __version__ = '1.4.4'
+__author__ = """Nidhal Baccouri"""
+__email__ = '[email protected]'
+__version__ = '1.5.0'
 
-# __all__ = [GoogleTranslator,
-#            PonsTranslator,
-#            LingueeTranslator,
-#            MyMemoryTranslator,
-#            YandexTranslator,
-#            MicrosoftTranslator,
-#            QCRI,
-#            DeepL,
-#            main,
-#            single_detection,
-#            batch_detection]
+__all__ = [GoogleTranslator,
+           PonsTranslator,
+           LingueeTranslator,
+           MyMemoryTranslator,
+           YandexTranslator,
+           MicrosoftTranslator,
+           QCRI,
+           DeepL,
+           single_detection,
+           batch_detection]

deep_translator/configs.py

@@ -1,11 +0,0 @@
-"""
-configuration object that holds data about the language detection api
-"""
-
-config = {
-    "url": 'https://ws.detectlanguage.com/0.2/detect',
-    "headers": {
-        'User-Agent': 'Detect Language API Python Client 1.4.0',
-        'Authorization': 'Bearer {}',
-    }
-}

deep_translator/detection.py

@@ -2,9 +2,10 @@
 language detection API
 """
 import requests
-from .configs import config # TODO: Discussion: Could this be moved here and remove configs.py entirely?
 from requests.exceptions import HTTPError
 
+# Module global config
+config = {"url": 'https://ws.detectlanguage.com/0.2/detect',"headers": {'User-Agent': 'Detect Language API Python Client 1.4.0','Authorization': 'Bearer {}',}}
 
 def get_request_body(text, api_key, *args, **kwargs):
     """

deep_translator/{__main__.py → main.py}

@@ -12,70 +12,31 @@ from .microsoft import MicrosoftTranslator
 from .papago import PapagoTranslator
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+@click.group()
+def cli():
+    pass
 
-@click.command(name='Deep Translator', context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
-@click.argument(
-    'translator', 
-    required=True, 
-    default='google', 
-    type=str)
-@click.option(
-    "--source", 
-    "-src", 
-    required=True, 
-    type=str, 
-    help="source language to translate from")
-@click.option(
-    "--target", 
-    "-tgt", 
-    required=True, 
-    type=str, 
-    help="target language to translate to")
-@click.option(
-    "--text", 
-    "-txt", 
-    type=str,
-    required = True,
-    prompt="Enter the text you want to translate",
-    help="text you want to translate")
-@click.option(
-    "--api-key",
-    type=str,
-    help="required for DeepL, QCRI, Yandex, Microsoft and Papago translators")
-@click.option(
-    "--languages",
-    "-lang",
-    is_flag=True,
-    help="list all the languages available with the translator."
-    " Run with deep_translator <translator service> -lang",)
-def main(translator, source, target, text, api_key, languages):
+@cli.command(context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
+@click.argument('translator', required=True, default='google', type=str)
+@click.option("--source", "-src", required=True, type=str, help="source language to translate from")
+@click.option("--target", "-tgt", required=True, type=str, help="target language to translate to")
+@click.option("--text", "-txt", type=str,required = True,prompt="Enter the text you want to translate",help="text you want to translate")
+@click.option("--api-key",type=str,help="required for DeepL, QCRI, Yandex, Microsoft and Papago translators")
+def translate(translator, source, target, text, api_key, languages):
     """
     Use TRANSLATOR to translate source material into another language.
-    Available translators include: Google, MyMemory, QCRI, Linguee, Pons, Yandex, Microsoft (Bing), and Papago.\n
     \f
-    function responsible for parsing terminal arguments and provide them for
-    further use in the translation process
+    Directory function to send arguments to the correct translator.
+    @param translator: translator name parsed from terminal arguments
+    @return: None
     """
     api_key_required = ["deepl", "qcri", "yandex", "microsoft", "papago"]
     if translator in api_key_required and not api_key:
         click.echo(
-            "This translator requires an api key provided through --api-key"
-        )
-    elif languages:
-        print_supported_languages(translator, api_key)
+            "This translator requires an api key provided through --api-key")
     else:
-        translate(translator, source, target, text, api_key)
+        pass
 
-def translate(translator, source, target, text, api_key):
-    """
-    function used to provide translations from the parsed terminal arguments
-    @param translator: translator name parsed from terminal arguments
-    @param source: source language parsed from terminal arguments
-    @param target: target language parsed from terminal arguments
-    @param text: text that will be translated parsed from terminal arguments
-    @param api_key: api key for translators that requires them
-    @return: None
-    """
     if translator == "google":
         translator = GoogleTranslator(source=source, target=target)
     elif translator == "mymemory":
@@ -92,66 +53,72 @@ def translate(translator, source, target, text, api_key):
         translator = YandexTranslator(
             source=source,
             target=target,
-            api_key=api_key
-        )
+            api_key=api_key)
     elif translator == "microsoft":
         translator = MicrosoftTranslator(
             source=source,
             target=target,
-            api_key=api_key
-        )
+            api_key=api_key)
     elif translator == "papago":
         translator = PapagoTranslator(
             source=source,
             target=target,
-            api_key=api_key
-        )
+            api_key=api_key)
     else:
-        click.echo(
-            "The given translator is not supported."
-            " Please use a translator supported by the deep_translator tool"
-        )
-        return
+        raise AttributeError("The given translator is not supported.")
 
     res = translator.translate(text)
     click.echo(f" | Translation from {source} to {target} |")
     click.echo(f"Translated text: \n {res}")
+    return 0
 
-def print_supported_languages(requested_translator, api_key):
+@cli.command(context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
+@click.argument('translator')
+@click.argument('api_key', required=False)
+def languages(translator, api_key):
     """
-    function used to print the languages supported by the translator service
-    from the parsed terminal arguments
-    @param args: parsed terminal arguments
+    Retrieve the list of available languages from the given translator.
+    @param translator: Translator given by the user.
+    @param api_key: Optional API key given by the user. Required for some translators.
     @return: None
     """
-    translator = None
-    if requested_translator == "google":
+    translator = translator.lower()
+    api_key_required = ["deepl", "qcri", "yandex", "microsoft", "papago"]
+    if translator in api_key_required and not api_key:
+        click.echo("This translator requires an api key provided through --api-key")
+    else:
+        pass
+
+    if translator == "google":
         translator = GoogleTranslator
-    elif requested_translator == "mymemory":
+    elif translator == "mymemory":
         translator = MyMemoryTranslator
-    elif requested_translator == "qcri":
+    elif translator == "qcri":
         translator = QCRI(api_key=api_key)
-    elif requested_translator == "linguee":
+    elif translator == "linguee":
         translator = LingueeTranslator
-    elif requested_translator == "pons":
+    elif translator == "pons":
         translator = PonsTranslator
-    elif requested_translator == "yandex":
+    elif translator == "yandex":
         translator = YandexTranslator(api_key=api_key)
-    elif requested_translator == "microsoft":
+    elif translator == "microsoft":
         translator = MicrosoftTranslator(api_key=api_key)
-    elif requested_translator == "papago":
+    elif translator == "papago":
         translator = PapagoTranslator(api_key=api_key)
     else:
-        click.echo(
-            "The given translator is not supported."
-            " Please use a translator supported by the deep_translator tool"
-        )
-        return
+        raise AttributeError("The given translator is not supported.")
 
     supported_languages = translator.get_supported_languages(as_dict=True)
-    click.echo(f"Languages supported by '{requested_translator}' are :")
+    click.echo(f"Languages supported by '{translator}' are :")
     for k, v in supported_languages.items():
         click.echo(f"|- {k}: {v}")
+    return 0
+
+@cli.command()
+def list():
+    """Lists available translators."""
+    click.echo("Available translators include: Google, MyMemory, QCRI, Linguee, Pons, Yandex, Microsoft (Bing), and Papago.")
+    return 0
 
 if __name__ == "__main__":
-    main()
+    cli()

deep_translator/tests/test_cli.py

@@ -3,14 +3,20 @@
 """Tests for the CLI interface."""
 
 from click.testing import CliRunner
-from deep_translator import __main__
+from deep_translator import main
 
 def results_test():
     runner = CliRunner()
-    result = runner.invoke(__main__.main, [ 'google', 'auto', 'en', '좋은'])
+    result = runner.invoke(main.translate, [ 'google', 'auto', 'en', '좋은'])
     assert result.exit_code == 0
     assert result == 'good'
     
-    api_error = runner.invoke(__main__.main, ['microsoft','auto','en','Zwei minimale Dellchen auf der Rückseite.'])
+    api_error = runner.invoke(main.translate, ['microsoft','auto','en','Zwei minimale Dellchen auf der Rückseite.'])
     assert api_error.exit_code == 0
-    assert api_error == "This translator requires an api key provided through --api-key"
+    assert api_error == "This translator requires an api key provided through --api-key"
+
+    language_list_test = runner.invoke(main.languages, ['google'])
+    assert language_list_test.exit_code == 0
+
+    language_list_invalid_test = runner.invoke(main.languages, ['notValidTranslator'])
+    assert language_list_invalid_test.exception == AttributeError

deep_translator/utils.py

@@ -1,4 +0,0 @@
-"""
-utilities
-"""
-# TODO: Discussion: Whats the purpsoe of this module?

setup.cfg

@@ -1,7 +1,7 @@
 #main config
 [metadata]
 name = Deep Translator
-version = 1.4.4
+version = 1.5.0
 url = https://github.com/nidhaloff/deep_translator
 author = Nidhal Baccouri
 author_email = [email protected]
@@ -36,8 +36,8 @@ keywords = deep_translator, deepL, DeepL, translator, translation, automation,
     detect language, free translation, unlimited translation, translate for free
 
 [build_sphinx]
-version = 1.4.4
-release = 1.4.4
+version = 1.5.0
+release = 1.5.0
 
 # TODO: These can be switched back on if the CI platform changes from Travis. Travis still requires setup.py to function properly.
 # [options]
@@ -72,6 +72,7 @@ release = 1.4.4
 # search = __version__ = '{current_version}'
 # replace = __version__ = '{new_version}'
 
+
 # TODO: These are all optional settings, turned on for now since they exist already.
 [bdist_wheel]
 universal = 1
@@ -84,4 +85,4 @@ exclude = docs
 test = pytest
 
 [tool:pytest]
-collect_ignore = [setup.py]
+collect_ignore = [setup.py]

setup.py

@@ -11,7 +11,7 @@ setup(
     include_package_data=True,
     packages=find_packages(include=['deep_translator'],),
     entry_points={'console_scripts':[
-        'deep-translator=deep_translator.__main__:main',
-        'dt=deep_translator.__main__:main',
+        'deep-translator=deep_translator.main:cli',
+        'dt=deep_translator.main:cli',
     ],},
 )