Refactor CLI. (#33)

Author: tobiasraabe

docs/changes.rst

@@ -11,6 +11,7 @@ all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>
 
 - :gh:`31` adds ``pytask collect`` to show information on collected tasks.
 - :gh:`32` fixes ``pytask clean``.
+- :gh:`33` adds a module to apply common parameters to the command line interface.
 
 
 0.0.8 - 2020-10-04

src/_pytask/build.py

@@ -12,7 +12,6 @@
 from _pytask.exceptions import ResolvingDependenciesError
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
-from _pytask.shared import falsy_to_none_callback
 
 
 @hookimpl(tryfirst=True)
@@ -85,28 +84,12 @@ def main(config_from_cli):
 
 
 @click.command()
-@click.argument(
-    "paths", nargs=-1, type=click.Path(exists=True), callback=falsy_to_none_callback
-)
-@click.option(
-    "--ignore",
-    type=str,
-    multiple=True,
-    help=(
-        "A pattern to ignore files or directories. For example, ``task_example.py`` or "
-        "``src/*``."
-    ),
-    callback=falsy_to_none_callback,
-)
 @click.option(
     "--debug-pytask",
     is_flag=True,
     default=None,
     help="Trace all function calls in the plugin framework.  [default: False]",
 )
-@click.option(
-    "-c", "--config", type=click.Path(exists=True), help="Path to configuration file."
-)
 def build(**config_from_cli):
     """Collect and execute tasks and report the results.
 

src/_pytask/clean.py

@@ -14,7 +14,6 @@
 from _pytask.exceptions import CollectionError
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
-from _pytask.shared import falsy_to_none_callback
 from _pytask.shared import get_first_non_none_value
 
 
@@ -55,9 +54,6 @@ def pytask_post_parse(config):
 
 
 @click.command()
-@click.argument(
-    "paths", nargs=-1, type=click.Path(exists=True), callback=falsy_to_none_callback
-)
 @click.option(
     "-m",
     "--mode",
@@ -68,19 +64,6 @@ def pytask_post_parse(config):
 @click.option(
     "-q", "--quiet", is_flag=True, help="Do not print the names of the removed paths."
 )
-@click.option(
-    "--ignore",
-    type=str,
-    multiple=True,
-    help=(
-        "A pattern to ignore files or directories. For example, ``task_example.py`` or "
-        "``src/*``."
-    ),
-    callback=falsy_to_none_callback,
-)
-@click.option(
-    "-c", "--config", type=click.Path(exists=True), help="Path to configuration file."
-)
 def clean(**config_from_cli):
     """Clean provided paths by removing files unknown to pytask."""
     config_from_cli["command"] = "clean"

src/_pytask/cli.py

@@ -10,12 +10,12 @@
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 
 
-def _extend_command_line_interface(cli):
+def _extend_command_line_interface(command_line_interface):
     """Add parameters from plugins to the commandline interface."""
     pm = _prepare_plugin_manager()
-    pm.hook.pytask_extend_command_line_interface(cli=cli)
-    _sort_options_for_each_command_alphabetically(cli)
-    return cli
+    pm.hook.pytask_extend_command_line_interface(cli=command_line_interface)
+    _sort_options_for_each_command_alphabetically(command_line_interface)
+    return command_line_interface
 
 
 def _prepare_plugin_manager():
@@ -46,6 +46,7 @@ def pytask_add_hooks(pm):
     from _pytask import execute
     from _pytask import logging
     from _pytask import mark
+    from _pytask import parameters
     from _pytask import parametrize
     from _pytask import persist
     from _pytask import resolve_dependencies
@@ -61,6 +62,7 @@ def pytask_add_hooks(pm):
     pm.register(execute)
     pm.register(logging)
     pm.register(mark)
+    pm.register(parameters)
     pm.register(parametrize)
     pm.register(persist)
     pm.register(resolve_dependencies)

src/_pytask/collect_command.py

@@ -8,7 +8,6 @@
 from _pytask.exceptions import CollectionError
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
-from _pytask.shared import falsy_to_none_callback
 
 
 @hookimpl(tryfirst=True)
@@ -23,23 +22,7 @@ def pytask_parse_config(config, config_from_cli):
 
 
 @click.command()
-@click.argument(
-    "paths", nargs=-1, type=click.Path(exists=True), callback=falsy_to_none_callback
-)
 @click.option("--nodes", is_flag=True, help="Show a task's dependencies and products.")
-@click.option(
-    "--ignore",
-    type=str,
-    multiple=True,
-    help=(
-        "A pattern to ignore files or directories. For example, ``task_example.py`` or "
-        "``src/*``."
-    ),
-    callback=falsy_to_none_callback,
-)
-@click.option(
-    "-c", "--config", type=click.Path(exists=True), help="Path to configuration file."
-)
 def collect(**config_from_cli):
     """Collect tasks from paths."""
     config_from_cli["command"] = "collect"

src/_pytask/mark/__init__.py

@@ -37,9 +37,6 @@
 
 
 @click.command()
-@click.option(
-    "-c", "--config", type=click.Path(exists=True), help="Path to configuration file."
-)
 def markers(**config_from_cli):
     """Show all registered markers."""
     config_from_cli["command"] = "markers"

src/_pytask/mark/expression.py

@@ -202,7 +202,11 @@ def __init__(self, code: types.CodeType) -> None:
     def compile_(cls, input_: str) -> "Expression":
         """Compile a match expression.
 
-        :param input: The input expression - one line.
+        Parameters
+        ----------
+        input_: str
+            The input expression - one line.
+
         """
         astexpr = expression(Scanner(input_))
         code = compile(

src/_pytask/parameters.py

@@ -0,0 +1,34 @@
+"""Contains common parameters for the commands of the command line interface."""
+import click
+from _pytask.config import hookimpl
+from _pytask.shared import falsy_to_none_callback
+
+
+_CONFIG_OPTION = click.Option(
+    ["-c", "--config"], type=click.Path(exists=True), help="Path to configuration file."
+)
+
+_IGNORE_OPTION = click.Option(
+    ["--ignore"],
+    type=str,
+    multiple=True,
+    help=(
+        "A pattern to ignore files or directories. For example, ``task_example.py`` or "
+        "``src/*``."
+    ),
+    callback=falsy_to_none_callback,
+)
+
+_PATH_ARGUMENT = click.Argument(
+    ["paths"], nargs=-1, type=click.Path(exists=True), callback=falsy_to_none_callback
+)
+
+
+@hookimpl(trylast=True)
+def pytask_extend_command_line_interface(cli):
+    for command in ["build", "clean", "collect", "markers"]:
+        cli.commands[command].params.append(_CONFIG_OPTION)
+    for command in ["build", "clean", "collect"]:
+        cli.commands[command].params.append(_IGNORE_OPTION)
+    for command in ["build", "clean", "collect"]:
+        cli.commands[command].params.append(_PATH_ARGUMENT)

src/_pytask/parametrize.py

@@ -75,6 +75,9 @@ def pytask_parametrize_task(session, name, obj):
     :func:`zip`, multiple ``@pytask.mark.parametrize`` decorators form a Cartesian
     product.
 
+    We cannot raise an error if the function does not use parametrized arguments since
+    some plugins will replace functions with their own implementation like pytask-r.
+
     """
     if callable(obj):
         obj, markers = _remove_parametrize_markers_from_func(obj)
@@ -125,11 +128,11 @@ def pytask_parametrize_task(session, name, obj):
 
 def _remove_parametrize_markers_from_func(obj):
     """Remove parametrize markers from the object."""
-    parametrize = [i for i in obj.pytaskmark if i.name == "parametrize"]
+    parametrize_markers = [i for i in obj.pytaskmark if i.name == "parametrize"]
     others = [i for i in obj.pytaskmark if i.name != "parametrize"]
     obj.pytaskmark = others
 
-    return obj, parametrize
+    return obj, parametrize_markers
 
 
 def _parse_parametrize_marker(marker):
@@ -336,9 +339,9 @@ def _copy_func(func: Callable[[Any], Any]) -> Callable[[Any], Any]:
 
     Example
     -------
-    >>> def func(): pass
-    >>> copied_func = _copy_func(func)
-    >>> func == copied_func
+    >>> def _func(): pass
+    >>> copied_func = _copy_func(_func)
+    >>> _func == copied_func
     False
 
     """

src/_pytask/traceback.py

@@ -46,7 +46,8 @@ def _filter_internal_traceback_frames(frame):
     """
     for frame in _yield_traceback_frames(frame):
         if frame is None or not _is_internal_traceback_frame(frame):
-            return frame
+            break
+    return frame
 
 
 def _yield_traceback_frames(frame):