Parametrization becomes a real plugin. (#10)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.1.0
+    rev: v3.2.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=10']
@@ -11,12 +11,12 @@ repos:
         exclude: (debugging\.py|main\.py)
     -   id: end-of-file-fixer
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.7.1
+    rev: v2.7.2
     hooks:
     -   id: pyupgrade
         args: [--py36-plus]
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.3.0
+    rev: v2.3.5
     hooks:
     -   id: reorder-python-imports
 -   repo: https://github.com/psf/black

docs/conf.py

@@ -9,7 +9,7 @@
 import sys
 
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../src"))
 
 
 # -- Project information ---------------------------------------------------------------
@@ -51,6 +51,8 @@
 
 # Configuration for autodoc
 autosummary_generate = True
+add_module_names = False
+autodoc_mock_imports = ["attr", "click", "networkx", "pluggy", "pony"]
 
 copybutton_prompt_text = r"\\$ |>>> "
 copybutton_prompt_is_regexp = True
@@ -61,12 +63,12 @@
 }
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.7", None),
+    "python": ("https://docs.python.org/3.8", None),
 }
 
 # Configuration for numpydoc
 numpydoc_xref_param_type = True
-numpydoc_xref_ignore = {"type", "optional", "default"}
+numpydoc_xref_ignore = {"type", "optional", "default", "of"}
 
 
 # -- Options for HTML output -----------------------------------------------------------

docs/index.rst

@@ -85,6 +85,7 @@ The documentation has currently one of four planned parts.
                     </div>
                 </a>
             </div>
+            -->
             <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                 <a href="reference_guides/index.html" id="index-link">
                     <div class="card text-center intro-card shadow">
@@ -102,7 +103,6 @@ The documentation has currently one of four planned parts.
                     </div>
                  </a>
             </div>
-            -->
         </div>
     </div>
 

docs/reference_guides/index.rst

@@ -14,3 +14,4 @@ additional details on the inner workings of pytask.
    :maxdepth: 1
 
    summary
+   marks

docs/reference_guides/marks.rst

@@ -0,0 +1,11 @@
+Marks
+=====
+
+pytask uses marks to attach additional information to task functions which is processed
+in the host or in plugins. The following marks are available by default.
+
+
+pytask.mark.parametrize
+-----------------------
+
+.. autofunction:: pytask.parametrize.parametrize

docs/tutorials/how_to_parametrize_a_task.rst

@@ -1,8 +1,8 @@
 How to parametrize a task
 =========================
 
-Often times, you define a task which should be repeated over a range of inputs. Just
-like pytest, pytask has a parametrize decorator for this reason.
+Often times, you define a task which should be repeated over a range of inputs. pytask
+has a parametrize decorator for this reason.
 
 Since pytask needs to track dependencies and products of tasks, there is a little bit
 more logic bound to the parametrize decorator which is explained in this section.
@@ -20,10 +20,9 @@ First, we write the task for one number.
 .. code-block:: python
 
     import pytask
-    from pathlib import Path
 
 
-    @pytask.mark.produces(Path("0.txt"))
+    @pytask.mark.produces("0.txt")
     def task_save_number(produces, i=0):
         produces.write_text(str(i))
 
@@ -32,10 +31,9 @@ In the next step, we parametrize the task.
 .. code-block:: python
 
     import pytask
-    from pathlib import pathlib
 
 
-    @pytask.mark.parametrize("produces, i", [(Path(f"{i}.txt"), i) for i in range(5)])
+    @pytask.mark.parametrize("produces, i", [(f"{i}.txt", i) for i in range(5)])
     def task_save_number(produces, i):
         produces.write_text(str(i))
 
@@ -68,7 +66,7 @@ mapped to the argument ``produces`` and ``i`` receives the number.
 
     .. code-block:: python
 
-        @pytask.mark.produces(Path("1.txt"))
+        @pytask.mark.produces("1.txt")
         def task_save_number(produces, i=1):
             produces.write_text(str(i))
 
@@ -82,7 +80,10 @@ example is equivalent to the former example.
 
 .. code-block:: python
 
-    @pytask.mark.parametrize("produces, i", [(Path(f"{i}.txt"), i) for i in range(5)])
+    from pathlib import Path
+
+
+    @pytask.mark.parametrize("produces, i", [(f"{i}.txt", i) for i in range(5)])
     def task_save_number(i):
         Path(__file__).parent.joinpath(f"{i}.txt").write_text(str(i))
 
@@ -107,7 +108,7 @@ all generated tasks and save it along a generated number to a file.
 .. code-block:: python
 
     @pytask.mark.depends_on(Path("additional_text.txt"))
-    @pytask.mark.parametrize("produces, i", [(Path(f"{i}.txt"), i) for i in range(5)])
+    @pytask.mark.parametrize("produces, i", [(f"{i}.txt", i) for i in range(5)])
     def task_save_number(depends_on, produces, i):
         additional_text = depends_on.read_text()
         produces.write_text(additional_text + str(i))

src/pytask/collect.py

@@ -90,7 +90,7 @@ def pytask_collect_file(session, path, reports):
         collected_reports = []
         for name, obj in inspect.getmembers(mod):
             if has_marker(obj, "parametrize"):
-                names_and_objects = session.hook.pytask_generate_tasks(
+                names_and_objects = session.hook.pytask_parametrize_task(
                     session=session, name=name, obj=obj
                 )
             else:

src/pytask/hookspecs.py

@@ -81,23 +81,6 @@ def pytask_collect_file(session, path, reports):
     """Collect tasks from files."""
 
 
-@hookspec(firstresult=True)
-def pytask_generate_tasks(session, name, obj):
-    """Generate multiple tasks from name and object with parametrization."""
-
-
-@hookspec(firstresult=True)
-def generate_product_of_names_and_functions(
-    session, name, obj, base_arg_names, arg_names, arg_values
-):
-    """Generate names and functions from Cartesian product."""
-
-
-@hookspec
-def pytask_generate_tasks_add_marker(obj, kwargs):
-    """Add some keyword arguments as markers to task."""
-
-
 @hookspec(firstresult=True)
 def pytask_collect_task_protocol(session, reports, path, name, obj):
     """Start protocol to collect tasks."""
@@ -118,6 +101,19 @@ def pytask_collect_node(path, node):
     """Collect a single node which is a dependency or a product."""
 
 
+# Hooks to parametrize tasks.
+
+
+@hookspec(firstresult=True)
+def pytask_parametrize_task(session, name, obj):
+    """Generate multiple tasks from name and object with parametrization."""
+
+
+@hookspec
+def pytask_parametrize_kwarg_to_marker(obj, kwargs):
+    """Add some keyword arguments as markers to object."""
+
+
 # Hooks for resolving dependencies.
 
 

src/pytask/nodes.py

@@ -3,6 +3,8 @@
 from abc import ABCMeta
 from abc import abstractmethod
 from pathlib import Path
+from typing import Type
+from typing import TypeVar
 
 import attr
 from pytask.exceptions import NodeNotCollectedError
@@ -97,14 +99,17 @@ def state(self):
         pass
 
 
+_FilePathNodeType = TypeVar("_FilePathNodeType", bound="FilePathNode")
+
+
 @attr.s
 class FilePathNode(MetaNode):
     name = attr.ib()
     value = attr.ib()
 
     @classmethod
     @functools.lru_cache()
-    def from_path(cls, path):
+    def from_path(cls: "Type[_FilePathNodeType]", path: Path) -> _FilePathNodeType:
         """Instantiate class from path to file.
 
         The `lru_cache` decorator ensures that the same object is not collected twice.