resolved issue66 and modified cli tests to compensate

deep_translator/__main__.py

@@ -12,36 +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)
+@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")
-# TODO: This is the option that needs to change to a subcommand.
-# @click.option("--languages","-lang",is_flag=True,help="list all the languages available with the translator.\nRun with deep_translator <translator service> -lang",)
-def main(translator, source, target, text, api_key, languages):
+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.
+    \f
+    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:   #TODO: This needs to be moved to its own sub-command. I have to figure out how sub-commands work in Click.
-    #     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):
-    """
-    Directory function to send arguments to the correct translator.
-    @param translator: translator name parsed from terminal arguments
-    @return: None
-    """
     if translator == "google":
         translator = GoogleTranslator(source=source, target=target)
     elif translator == "mymemory":
@@ -70,51 +65,60 @@ def translate(translator, source, target, text, api_key):
             target=target,
             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
 
-# TODO: This is the actual function that needs to be converted to a subcommand.
-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):
     """
     Retrieve the list of available languages from the given translator.
-    @param requested_translator: Translator given by the user.
+    @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

@@ -7,10 +7,16 @@ 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

setup.cfg

@@ -66,15 +66,15 @@ replace = version='{new_version}'
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 
-# [bdist_wheel]
-# universal = 1
+[bdist_wheel]
+universal = 1
 
-# [flake8]
-# exclude = docs
+[flake8]
+exclude = docs
 
-# [aliases]
-# # Define setup.py command aliases here
-# test = pytest
+[aliases]
+# Define setup.py command aliases here
+test = pytest
 
-# [tool:pytest]
-# collect_ignore = [setup.py]
+[tool:pytest]
+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',
     ],},
 )