Rename Node back to MetaNode. (#371)

Author: tobiasraabe

docs/source/reference_guides/api.md

@@ -266,10 +266,10 @@ The remaining exceptions convey specific errors.
 ## Nodes
 
 Nodes are the interface for different kinds of dependencies or products. They inherit
-from {class}`pytask.Node`.
+from {class}`pytask.MetaNode`.
 
 ```{eval-rst}
-.. autoclass:: pytask.Node
+.. autoclass:: pytask.MetaNode
 ```
 
 Then, different kinds of nodes can be implemented.

pyproject.toml

@@ -75,3 +75,14 @@ extend-ignore = [
 
 [tool.ruff.pydocstyle]
 convention = "numpy"
+
+
+[tool.pytest.ini_options]
+testpaths = ["src", "tests"]
+markers = [
+    "wip: Tests that are work-in-progress.",
+    "unit: Flag for unit tests which target mainly a single function.",
+    "integration: Flag for integration tests which may comprise of multiple unit tests.",
+    "end_to_end: Flag for tests that cover the whole program.",
+]
+norecursedirs = [".idea", ".tox"]

src/_pytask/collect_utils.py

@@ -20,7 +20,7 @@
 
 if TYPE_CHECKING:
     from _pytask.session import Session
-    from _pytask.nodes import Node
+    from _pytask.nodes import MetaNode
 
 
 __all__ = ["depends_on", "parse_nodes", "produces"]
@@ -196,7 +196,7 @@ def _merge_dictionaries(list_of_dicts: list[dict[Any, Any]]) -> dict[Any, Any]:
 
 def _collect_node(
     session: Session, path: Path, name: str, node: str | Path
-) -> dict[str, Node]:
+) -> dict[str, MetaNode]:
     """Collect nodes for a task.
 
     Parameters

src/_pytask/dag.py

@@ -22,7 +22,7 @@
 from _pytask.mark_utils import get_marks
 from _pytask.mark_utils import has_mark
 from _pytask.nodes import FilePathNode
-from _pytask.nodes import Node
+from _pytask.nodes import MetaNode
 from _pytask.nodes import Task
 from _pytask.path import find_common_ancestor_of_nodes
 from _pytask.report import DagReport
@@ -128,7 +128,7 @@ def _have_task_or_neighbors_changed(
 
 @orm.db_session
 @hookimpl(trylast=True)
-def pytask_dag_has_node_changed(node: Node, task_name: str) -> bool:
+def pytask_dag_has_node_changed(node: MetaNode, task_name: str) -> bool:
     """Indicate whether a single dependency or product has changed."""
     if isinstance(node, (FilePathNode, Task)):
         # If node does not exist, we receive None.
@@ -236,7 +236,7 @@ def _check_if_root_nodes_are_available(dag: nx.DiGraph) -> None:
 
 
 def _check_if_tasks_are_skipped(
-    node: Node, dag: nx.DiGraph, is_task_skipped: dict[str, bool]
+    node: MetaNode, dag: nx.DiGraph, is_task_skipped: dict[str, bool]
 ) -> tuple[bool, dict[str, bool]]:
     """Check for a given node whether it is only used by skipped tasks."""
     are_all_tasks_skipped = []

src/_pytask/hookspecs.py

@@ -18,7 +18,7 @@
 
 if TYPE_CHECKING:
     from _pytask.session import Session
-    from _pytask.nodes import Node
+    from _pytask.nodes import MetaNode
     from _pytask.nodes import Task
     from _pytask.outcomes import CollectionOutcome
     from _pytask.outcomes import TaskOutcome
@@ -195,8 +195,8 @@ def pytask_collect_task_teardown(session: Session, task: Task) -> None:
 
 @hookspec(firstresult=True)
 def pytask_collect_node(
-    session: Session, path: pathlib.Path, node: Node
-) -> Node | None:
+    session: Session, path: pathlib.Path, node: MetaNode
+) -> MetaNode | None:
     """Collect a node which is a dependency or a product of a task."""
 
 
@@ -287,7 +287,7 @@ def pytask_dag_select_execution_dag(session: Session, dag: networkx.DiGraph) ->
 
 @hookspec(firstresult=True)
 def pytask_dag_has_node_changed(
-    session: Session, dag: networkx.DiGraph, node: Node, task_name: str
+    session: Session, dag: networkx.DiGraph, node: MetaNode, task_name: str
 ) -> None:
     """Select the subgraph which needs to be executed.
 

src/_pytask/nodes.py

@@ -17,10 +17,10 @@
     from _pytask.mark import Mark
 
 
-__all__ = ["FilePathNode", "Node", "Task"]
+__all__ = ["FilePathNode", "MetaNode", "Task"]
 
 
-class Node(metaclass=ABCMeta):
+class MetaNode(metaclass=ABCMeta):
     """Meta class for nodes."""
 
     name: str
@@ -32,7 +32,7 @@ def state(self) -> Any:
 
 
 @define(kw_only=True)
-class Task(Node):
+class Task(MetaNode):
     """The class for tasks which are Python functions."""
 
     base_name: str
@@ -45,9 +45,9 @@ class Task(Node):
     """The name of the task."""
     short_name: str | None = field(default=None, init=False)
     """The shortest uniquely identifiable name for task for display."""
-    depends_on: dict[str, Node] = field(factory=dict)
+    depends_on: dict[str, MetaNode] = field(factory=dict)
     """A list of dependencies of task."""
-    produces: dict[str, Node] = field(factory=dict)
+    produces: dict[str, MetaNode] = field(factory=dict)
     """A list of products of task."""
     markers: list[Mark] = field(factory=list)
     """A list of markers attached to the task function."""
@@ -82,7 +82,7 @@ def add_report_section(self, when: str, key: str, content: str) -> None:
 
 
 @define(kw_only=True)
-class FilePathNode(Node):
+class FilePathNode(MetaNode):
     """The class for a node which is a path."""
 
     name: str

src/_pytask/report.py

@@ -15,7 +15,7 @@
 
 
 if TYPE_CHECKING:
-    from _pytask.nodes import Node
+    from _pytask.nodes import MetaNode
     from _pytask.nodes import Task
 
 
@@ -27,15 +27,15 @@ class CollectionReport:
     """A collection report for a task."""
 
     outcome: CollectionOutcome
-    node: Node | None = None
+    node: MetaNode | None = None
     exc_info: ExceptionInfo | None = None
 
     @classmethod
     def from_exception(
         cls: type[CollectionReport],
         outcome: CollectionOutcome,
         exc_info: ExceptionInfo,
-        node: Node | None = None,
+        node: MetaNode | None = None,
     ) -> CollectionReport:
         exc_info = remove_internal_traceback_frames_from_exc_info(exc_info)
         return cls(outcome=outcome, node=node, exc_info=exc_info)

src/_pytask/shared.py

@@ -11,7 +11,7 @@
 import networkx as nx
 from _pytask.console import format_task_id
 from _pytask.nodes import FilePathNode
-from _pytask.nodes import Node
+from _pytask.nodes import MetaNode
 from _pytask.nodes import Task
 from _pytask.path import find_closest_ancestor
 from _pytask.path import find_common_ancestor
@@ -57,7 +57,7 @@ def parse_paths(x: Any | None) -> list[Path] | None:
     return out
 
 
-def reduce_node_name(node: Node, paths: Sequence[str | Path]) -> str:
+def reduce_node_name(node: MetaNode, paths: Sequence[str | Path]) -> str:
     """Reduce the node name.
 
     The whole name of the node - which includes the drive letter - can be very long
@@ -75,7 +75,7 @@ def reduce_node_name(node: Node, paths: Sequence[str | Path]) -> str:
             except ValueError:
                 ancestor = node.path.parents[-1]
 
-        if isinstance(node, Node):
+        if isinstance(node, MetaNode):
             name = relative_to(node.path, ancestor).as_posix()
         else:
             raise TypeError(f"Unknown node {node} with type {type(node)!r}.")
@@ -95,7 +95,7 @@ def reduce_names_of_multiple_nodes(
             short_name = format_task_id(
                 node, editor_url_scheme="no_link", short_name=True
             )
-        elif isinstance(node, Node):
+        elif isinstance(node, MetaNode):
             short_name = reduce_node_name(node, paths)
         else:
             raise TypeError(f"Requires 'Task' or 'Node' and not {type(node)!r}.")

src/pytask/__init__.py

@@ -33,7 +33,7 @@
 from _pytask.mark_utils import set_marks
 from _pytask.models import CollectionMetadata
 from _pytask.nodes import FilePathNode
-from _pytask.nodes import Node
+from _pytask.nodes import MetaNode
 from _pytask.nodes import Task
 from _pytask.outcomes import CollectionOutcome
 from _pytask.outcomes import count_outcomes
@@ -78,7 +78,7 @@
     "Mark",
     "MarkDecorator",
     "MarkGenerator",
-    "Node",
+    "MetaNode",
     "NodeNotCollectedError",
     "NodeNotFoundError",
     "Persisted",

tests/test_collect_command.py

@@ -10,7 +10,7 @@
 from attrs import define
 from pytask import cli
 from pytask import ExitCode
-from pytask import Node
+from pytask import MetaNode
 from pytask import Task
 
 
@@ -304,7 +304,7 @@ def task_example_2():
 
 
 @define
-class Node(Node):
+class MetaNode(MetaNode):
     path: Path
 
     def state(self):
@@ -323,8 +323,8 @@ def test_print_collected_tasks_without_nodes(capsys):
                 base_name="function",
                 path=Path("task_path.py"),
                 function=function,
-                depends_on={0: Node("in.txt")},
-                produces={0: Node("out.txt")},
+                depends_on={0: MetaNode("in.txt")},
+                produces={0: MetaNode("out.txt")},
             )
         ]
     }
@@ -346,8 +346,8 @@ def test_print_collected_tasks_with_nodes(capsys):
                 base_name="function",
                 path=Path("task_path.py"),
                 function=function,
-                depends_on={0: Node("in.txt")},
-                produces={0: Node("out.txt")},
+                depends_on={0: MetaNode("in.txt")},
+                produces={0: MetaNode("out.txt")},
             )
         ]
     }
@@ -370,8 +370,10 @@ def test_find_common_ancestor_of_all_nodes(show_nodes, expected_add):
             base_name="function",
             path=Path.cwd() / "src" / "task_path.py",
             function=function,
-            depends_on={0: Node(Path.cwd() / "src" / "in.txt")},
-            produces={0: Node(Path.cwd().joinpath("..", "bld", "out.txt").resolve())},
+            depends_on={0: MetaNode(Path.cwd() / "src" / "in.txt")},
+            produces={
+                0: MetaNode(Path.cwd().joinpath("..", "bld", "out.txt").resolve())
+            },
         )
     ]