commit with hidden circular import error.

Author: tobiasraabe

pyproject.toml

@@ -87,7 +87,7 @@ Homepage = "https://pytask-dev.readthedocs.io/en/stable"
 Tracker = "https://github.com/pytask-dev/pytask/issues"
 
 [project.scripts]
-pytask = "_pytask.cli:cli"
+pytask = "pytask:cli"
 
 [tool.setuptools]
 include-package-data = true

src/_pytask/build.py

@@ -24,8 +24,8 @@
 from _pytask.exceptions import ResolvingDependenciesError
 from _pytask.outcomes import ExitCode
 from _pytask.path import HashPathCache
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.shared import parse_paths
 from _pytask.shared import to_list
@@ -177,8 +177,6 @@ def build(  # noqa: C901, PLR0912, PLR0913
 
     """
     try:
-        pm = get_plugin_manager()
-
         raw_config = {
             "capture": capture,
             "check_casing_of_paths": check_casing_of_paths,

src/_pytask/clean.py

@@ -25,8 +25,8 @@
 from _pytask.outcomes import ExitCode
 from _pytask.path import find_common_ancestor
 from _pytask.path import relative_to
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.shared import to_list
 from _pytask.traceback import Traceback
@@ -101,7 +101,6 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912
 
     try:
         # Duplication of the same mechanism in :func:`pytask.build`.
-        pm = get_plugin_manager()
 
         config = pm.hook.pytask_configure(pm=pm, raw_config=raw_config)
         session = Session.from_config(config)

src/_pytask/cli.py

@@ -5,7 +5,7 @@
 
 import click
 from _pytask.click import ColoredGroup
-from _pytask.pluginmanager import get_plugin_manager
+from _pytask.pluginmanager import plugin_manager as pm
 from packaging.version import parse as parse_version
 
 
@@ -23,7 +23,6 @@
 
 def _extend_command_line_interface(cli: click.Group) -> click.Group:
     """Add parameters from plugins to the commandline interface."""
-    pm = get_plugin_manager()
     pm.hook.pytask_extend_command_line_interface.call_historic(kwargs={"cli": cli})
     _sort_options_for_each_command_alphabetically(cli)
     return cli

src/_pytask/collect_command.py

@@ -26,8 +26,8 @@
 from _pytask.outcomes import ExitCode
 from _pytask.path import find_common_ancestor
 from _pytask.path import relative_to
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.tree_util import tree_leaves
 from rich.text import Text
@@ -57,7 +57,6 @@ def collect(**raw_config: Any | None) -> NoReturn:
     raw_config["command"] = "collect"
 
     try:
-        pm = get_plugin_manager()
         config = pm.hook.pytask_configure(pm=pm, raw_config=raw_config)
         session = Session.from_config(config)
 

src/_pytask/dag_command.py

@@ -19,8 +19,8 @@
 from _pytask.exceptions import ConfigurationError
 from _pytask.exceptions import ResolvingDependenciesError
 from _pytask.outcomes import ExitCode
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.shared import parse_paths
 from _pytask.shared import reduce_names_of_multiple_nodes
@@ -80,7 +80,6 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
 def dag(**raw_config: Any) -> int:
     """Create a visualization of the project's directed acyclic graph."""
     try:
-        pm = get_plugin_manager()
         config = pm.hook.pytask_configure(pm=pm, raw_config=raw_config)
         session = Session.from_config(config)
 
@@ -142,8 +141,6 @@ def build_dag(raw_config: dict[str, Any]) -> nx.DiGraph:
 
     """
     try:
-        pm = get_plugin_manager()
-
         # If someone called the programmatic interface, we need to do some parsing.
         if "command" not in raw_config:
             raw_config["command"] = "dag"

src/_pytask/data_catalog.py

@@ -16,7 +16,7 @@
 from _pytask.node_protocols import PNode
 from _pytask.node_protocols import PPathNode
 from _pytask.nodes import PickleNode
-from _pytask.pluginmanager import get_plugin_manager
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from attrs import define
 from attrs import field
@@ -36,9 +36,7 @@ def _get_parent_path_of_data_catalog_module(stacklevel: int = 2) -> Path:
 
 def _create_default_session() -> Session:
     """Create a default session to use the hooks and collect nodes."""
-    return Session(
-        config={"check_casing_of_paths": True}, hook=get_plugin_manager().hook
-    )
+    return Session(config={"check_casing_of_paths": True}, hook=pm.hook)
 
 
 @define(kw_only=True)

src/_pytask/hookspecs.py

@@ -30,7 +30,7 @@
 hookspec = pluggy.HookspecMarker("pytask")
 
 
-@hookspec
+@hookspec(historic=True)
 def pytask_add_hooks(pm: pluggy.PluginManager) -> None:
     """Add hook specifications and implementations to the plugin manager.
 

src/_pytask/mark/__init__.py

@@ -18,8 +18,8 @@
 from _pytask.mark.structures import MarkDecorator
 from _pytask.mark.structures import MarkGenerator
 from _pytask.outcomes import ExitCode
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.shared import parse_markers
 from attrs import define
@@ -51,7 +51,6 @@ def markers(**raw_config: Any) -> NoReturn:
     raw_config["command"] = "markers"
 
     try:
-        pm = get_plugin_manager()
         config = pm.hook.pytask_configure(pm=pm, raw_config=raw_config)
         session = Session.from_config(config)
 

src/_pytask/parameters.py

@@ -3,16 +3,22 @@
 
 from pathlib import Path
 from typing import Iterable
+from typing import TYPE_CHECKING
 
 import click
 from _pytask.config_utils import set_defaults_from_config
 from _pytask.path import import_path
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
+from _pytask.pluginmanager import register_hook_impls_from_modules
 from click import Context
 from sqlalchemy.engine import make_url
 from sqlalchemy.engine import URL
 from sqlalchemy.exc import ArgumentError
 
+if TYPE_CHECKING:
+    from pluggy import PluginManager
+
 
 _CONFIG_OPTION = click.Option(
     ["-c", "--config"],
@@ -110,7 +116,7 @@ def _hook_module_callback(
     name: str,  # noqa: ARG001
     value: tuple[str, ...],
 ) -> Iterable[str | Path]:
-    """Check the hook module."""
+    """Register the user's hook modules from the configuration file."""
     if not value:
         return value
 
@@ -124,6 +130,21 @@ def _hook_module_callback(
             parsed_modules.append(module.__name__)
         else:
             parsed_modules.append(module_name)
+
+    # If there are hook modules, we register a hook implementation to add them.
+    # ``pytask_add_hooks`` is a historic hook specification, so even command line
+    # options can be added.
+    if parsed_modules:
+
+        class HookModule:
+            @staticmethod
+            @hookimpl
+            def pytask_add_hooks(pm: PluginManager) -> None:
+                """Add hooks."""
+                register_hook_impls_from_modules(pm, parsed_modules)
+
+        pm.register(HookModule)
+
     return parsed_modules
 
 

src/_pytask/pluginmanager.py

@@ -2,7 +2,6 @@
 from __future__ import annotations
 
 import importlib
-from typing import Any
 from typing import Iterable
 
 import pluggy
@@ -46,26 +45,28 @@ def pytask_add_hooks(pm: pluggy.PluginManager) -> None:
             "_pytask.collect",
             "_pytask.collect_command",
             "_pytask.config",
+            "_pytask.dag",
+            "_pytask.dag_command",
             "_pytask.database",
             "_pytask.debugging",
             "_pytask.execute",
-            "_pytask.dag_command",
             "_pytask.live",
             "_pytask.logging",
             "_pytask.mark",
             "_pytask.nodes",
             "_pytask.parameters",
             "_pytask.persist",
             "_pytask.profile",
-            "_pytask.dag",
             "_pytask.skipping",
             "_pytask.task",
             "_pytask.warnings",
         )
         register_hook_impls_from_modules(pm, builtin_hook_impl_modules)
 
-    @staticmethod
-    @hookimpl(tryfirst=True)
-    def pytask_parse_config(config: dict[str, Any]) -> None:
-        """Parse the configuration."""
-        register_hook_impls_from_modules(config["pm"], config["hook_module"])
+
+plugin_manager = pluggy.PluginManager("pytask")
+plugin_manager.add_hookspecs(hookspecs)
+plugin_manager.load_setuptools_entrypoints("pytask")
+
+plugin_manager.register(BuiltinPlugins)
+plugin_manager.hook.pytask_add_hooks.call_historic(kwargs={"pm": plugin_manager})

src/_pytask/profile.py

@@ -24,8 +24,8 @@
 from _pytask.node_protocols import PTask
 from _pytask.outcomes import ExitCode
 from _pytask.outcomes import TaskOutcome
-from _pytask.pluginmanager import get_plugin_manager
 from _pytask.pluginmanager import hookimpl
+from _pytask.pluginmanager import plugin_manager as pm
 from _pytask.session import Session
 from _pytask.traceback import Traceback
 from rich.table import Table
@@ -114,7 +114,6 @@ def profile(**raw_config: Any) -> NoReturn:
     raw_config["command"] = "profile"
 
     try:
-        pm = get_plugin_manager()
         config = pm.hook.pytask_configure(pm=pm, raw_config=raw_config)
         session = Session.from_config(config)
 

src/_pytask/traceback.py

@@ -47,9 +47,9 @@ class Traceback:
 
     show_locals: ClassVar[bool] = False
     suppress: ClassVar[tuple[Path, ...]] = (
-        _PLUGGY_DIRECTORY,
-        TREE_UTIL_LIB_DIRECTORY,
-        _PYTASK_DIRECTORY,
+        # _PLUGGY_DIRECTORY,
+        # TREE_UTIL_LIB_DIRECTORY,
+        # _PYTASK_DIRECTORY,
     )
 
     def __rich_console__(

src/pytask/__init__.py

@@ -6,6 +6,7 @@
 from _pytask.build import build
 from _pytask.capture_utils import CaptureMethod
 from _pytask.capture_utils import ShowCapture
+from _pytask.cli import cli
 from _pytask.click import ColoredCommand
 from _pytask.click import ColoredGroup
 from _pytask.click import EnumChoice
@@ -73,11 +74,6 @@
 from _pytask.warnings_utils import warning_record_to_str
 from _pytask.warnings_utils import WarningReport
 
-
-# This import must come last, otherwise a circular import occurs.
-from _pytask.cli import cli  # noreorder
-
-
 __all__ = [
     "BaseTable",
     "CaptureMethod",