Replace pytest.mark with pytask.mark. (#12)

Author: tobiasraabe

.conda/meta.yaml

@@ -29,7 +29,6 @@ requirements:
     - networkx
     - pluggy
     - pony >=0.7.13
-    - pytest
 
 test:
   imports:
@@ -41,8 +40,9 @@ test:
     - tox.ini
     - tests
   commands:
-    - pytask --version
     - pytask --help
+    - pytask --markers
+    - pytask --version
 
     - pytest tests
 

docs/tutorials/how_to_configure_pytask.rst

@@ -0,0 +1,49 @@
+How to configure pytask
+=======================
+
+pytask can be configured via the command-line interface or permanently with a
+configuration file.
+
+
+The configuration file
+----------------------
+
+pytask accepts configurations in three files which are ``pytask.ini``, ``tox.ini`` and
+``setup.cfg``. Place a ``[pytask]`` section in those files and add your configuration
+below.
+
+.. code-block:: ini
+
+    # Content of tox.ini
+
+    [pytask]
+    ignore =
+        some_path
+
+You can also leave the section empty. It will still have the benefit that pytask has a
+stable root and will store the information about tasks, dependencies, and products in
+the same directory as the configuration file.
+
+
+.. _tutorial_configure_markers:
+
+markers
+-------
+
+pytask uses markers to attach additional information to task functions. To see which
+markers are available, type
+
+.. code-block:: bash
+
+    $ pytask --markers
+
+on the command-line interface.
+
+If you use a marker which has not been configured, you will get a warning. To silence
+the warning and document the marker, provide the following information in your pytask
+configuration file.
+
+.. code-block:: ini
+
+    markers =
+        wip: Work-in-progress. These are tasks which I am currently working on.

docs/tutorials/index.rst

@@ -17,4 +17,5 @@ Tutorials help you to get started with pytask.
    how_to_debug
    how_to_parametrize_a_task
    how_to_set_up_a_project
+   how_to_configure_pytask
    how_to_select_tasks

src/pytask/__init__.py

@@ -1,7 +1,9 @@
 import pluggy
-from pytask.mark import MARK_GEN as mark  # noqa: F401, N811
+from pytask.mark.structures import MARK_GEN as mark  # noqa: F401, N811
 
-__version__ = "0.0.4"
+hookimpl = pluggy.HookimplMarker("pytask")
 
 
-hookimpl = pluggy.HookimplMarker("pytask")
+__version__ = "0.0.4"
+
+__all__ = ["hookimpl", "mark"]

src/pytask/cli.py

@@ -2,8 +2,7 @@
 from pathlib import Path
 
 import click
-import pytask
-from pytask.main import main
+import pytask.mark.cli
 from pytask.pluginmanager import get_plugin_manager
 
 
@@ -17,19 +16,33 @@ def add_parameters(func):
     pm.hook.pytask_add_hooks(pm=pm)
     pm.hook.pytask_add_parameters_to_cli(command=func)
 
+    # Hack to pass the plugin manager via a hidden option to the ``config_from_cli``.
+    func.params.append(click.Option(["--pm"], default=pm, hidden=True))
+
     return func
 
 
 @pytask.hookimpl
 def pytask_add_hooks(pm):
+    """Add some hooks and plugins.
+
+    This hook implementation registers only plugins which extend the command line
+    interface or patch the main entry-point :func:`pytask.hookspecs.pytask_main`.
+
+    """
     from pytask import database
     from pytask import debugging
+    from pytask import main
+    from pytask.mark import cli as mark_cli
 
     pm.register(database)
     pm.register(debugging)
+    pm.register(main)
+    pm.register(mark_cli)
 
 
 def _to_path(ctx, param, value):  # noqa: U100
+    """Callback for :class:`click.Argument` or :class:`click.Option`."""
     return [Path(i).resolve() for i in value]
 
 
@@ -45,7 +58,11 @@ def pytask_add_parameters_to_cli(command):
             multiple=True,
             help="Ignore path (globs and multi allowed).",
         ),
-        click.Option(["--debug-pytask"], is_flag=True, help="Debug pytask."),
+        click.Option(
+            ["--debug-pytask"],
+            is_flag=True,
+            help="Debug pytask by tracing all hook calls.",
+        ),
     ]
     command.params.extend(additional_parameters)
 
@@ -55,5 +72,6 @@ def pytask_add_parameters_to_cli(command):
 @click.version_option()
 def pytask(**config_from_cli):
     """Command-line interface for pytask."""
-    session = main(config_from_cli)
+    pm = config_from_cli["pm"]
+    session = pm.hook.pytask_main(config_from_cli=config_from_cli)
     sys.exit(session.exit_code)

src/pytask/collect.py

@@ -11,7 +11,7 @@
 import pytask
 from pytask.exceptions import CollectionError
 from pytask.exceptions import TaskDuplicatedError
-from pytask.mark import has_marker
+from pytask.mark.structures import has_marker
 from pytask.nodes import FilePathNode
 from pytask.nodes import PythonFunctionTask
 from pytask.report import CollectionReportFile

src/pytask/config.py

@@ -8,6 +8,7 @@
 
 import click
 import pytask
+from pytask.mark.structures import MARK_GEN
 from pytask.shared import get_first_not_none_value
 from pytask.shared import to_list
 
@@ -23,13 +24,20 @@
 def pytask_configure(pm, config_from_cli):
     config = {"pm": pm, "terminal_width": _get_terminal_width()}
 
-    paths = get_first_not_none_value(config_from_cli, key="paths", callback=to_list)
+    paths = get_first_not_none_value(
+        config_from_cli, key="paths", default=[Path.cwd()], callback=to_list
+    )
     paths = [Path(p).resolve() for path in paths for p in glob.glob(path.as_posix())]
     config["paths"] = paths if paths else [Path.cwd().resolve()]
 
     config["root"], config["ini"] = _find_project_root_and_ini(config["paths"])
     config_from_file = _read_config(config["ini"]) if config["ini"] is not None else {}
 
+    config["markers"] = {
+        "depends_on": "Attach a dependency/dependencies to a task.",
+        "produces": "Attach a product/products to a task.",
+    }
+
     config["pm"].hook.pytask_parse_config(
         config=config,
         config_from_cli=config_from_cli,
@@ -38,6 +46,8 @@ def pytask_configure(pm, config_from_cli):
 
     config["pm"].hook.pytask_post_parse(config=config)
 
+    MARK_GEN.config = config
+
     return config
 
 

src/pytask/execute.py

@@ -12,7 +12,7 @@
 from pytask.database import create_or_update_state
 from pytask.exceptions import ExecutionError
 from pytask.exceptions import NodeNotFoundError
-from pytask.mark import Mark
+from pytask.mark.structures import Mark
 from pytask.nodes import FilePathNode
 from pytask.report import ExecutionReport
 from pytask.report import format_execute_footer

src/pytask/hookspecs.py

@@ -18,6 +18,14 @@ def pytask_add_parameters_to_cli(command: click.Command):
     """Add parameter to :class:`click.Command`."""
 
 
+# Hooks for the pytask_main interface.
+
+
+@hookspec(firstresult=True)
+def pytask_main(config_from_cli: dict):
+    """Take the cli config, create the configuration and start the session."""
+
+
 # Hooks for the configuration.
 
 

src/pytask/main.py

@@ -13,7 +13,6 @@
 
 @pytask.hookimpl
 def pytask_add_hooks(pm):
-    from pytask import cli
     from pytask import collect
     from pytask import config
     from pytask import database
@@ -23,8 +22,8 @@ def pytask_add_hooks(pm):
     from pytask import parametrize
     from pytask import resolve_dependencies
     from pytask import skipping
+    from pytask.mark import config as mark_config
 
-    pm.register(cli)
     pm.register(collect)
     pm.register(config)
     pm.register(database)
@@ -34,9 +33,11 @@ def pytask_add_hooks(pm):
     pm.register(parametrize)
     pm.register(resolve_dependencies)
     pm.register(skipping)
+    pm.register(mark_config)
 
 
-def main(config_from_cli):
+@pytask.hookimpl
+def pytask_main(config_from_cli):
     try:
         pm = get_plugin_manager()
         pm.register(sys.modules[__name__])