Move plugins to BaseConfig

Author: ArBridgeman

doc/changes/unreleased.md

@@ -10,3 +10,4 @@ and replaces them with `format:fix` and `format:check`.
 ## Feature
 
 * #614: Replaced `path_filters` with `BaseConfig.add_to_excluded_python_paths` and `BaseConfig.excluded_python_paths`
+* #626: Moved `plugins` into `BaseConfig`

doc/user_guide/customization.rst

@@ -65,16 +65,15 @@ Plugin Registration
 
 Once the plugin class has been defined, it must be registered in the Nox configuration. This is done by adding the class to the `plugins` list within the `Config` data class.
 
-In the Nox `Config` data class, you should amend the `plugins` list to include the new plugin:
+In the Nox `PROJECT_CONFIG`, you should amend the `plugins` list to include the new plugin:
 
 .. code-block:: python
 
-    @dataclass(frozen=True)
-    class Config:
-        """Project-specific configuration used by Nox infrastructure."""
-        # ... other configuration attributes ...
+    from exasol.toolbox.config import BaseConfig
 
-        plugins = [UpdateTemplates]  # register the plugin
+    PROJECT_CONFIG = BaseConfig(
+        plugins=(UpdateTemplates,), # register the plugin
+    )
 
 When Nox runs, it will instantiate `UpdateTemplates` with no arguments and integrate the hooks defined by the plugin into the execution lifecycle. All registered plugins’ hooks are called at their designated points in the Nox workflow.
 

doc/user_guide/getting_started.rst

@@ -91,7 +91,7 @@ example shown below.
 
 .. note::
 
-   For further details on plugins, see the customization section.
+   For further details on plugins, see :ref:`plugins` in the Customization section.
 
 .. collapse:: noxconfig.py
 

exasol/toolbox/config.py

@@ -68,6 +68,17 @@ class BaseConfig(BaseModel):
         `exasol.toolbox.config.DEFAULT_EXCLUDED_PATHS`.
         """,
     )
+    plugins: tuple[object, ...] = Field(
+        default=(),
+        description="""
+        This is used to provide hooks to extend one or more of the Nox tasks provided
+        by the python-toolbox. As described on the plugins pages:
+            - https://exasol.github.io/python-toolbox/main/user_guide/customization.html#plugins
+            - https://exasol.github.io/python-toolbox/main/developer_guide/plugins.html,
+        possible plugin options are defined in the `exasol.toolbox.nox.plugins`
+        namespace.
+        """,
+    )
     model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)
 
     @computed_field  # type: ignore[misc]

noxconfig.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from collections.abc import Iterable
 from pathlib import Path
 
 from exasol.toolbox.config import BaseConfig
@@ -56,7 +55,6 @@ class Config(BaseConfig):
     source: Path = Path("exasol/toolbox")
     importlinter: Path = Path(__file__).parent / ".import_linter_config"
     version_file: Path = Path(__file__).parent / "exasol" / "toolbox" / "version.py"
-    plugins: Iterable[object] = (UpdateTemplates,)
 
 
 PROJECT_CONFIG = Config(
@@ -73,4 +71,5 @@ class Config(BaseConfig):
     # The PTB does not have integration tests run with an Exasol DB,
     # so for running in the CI, we take the first element.
     exasol_versions=(BaseConfig().exasol_versions[0],),
+    plugins=(UpdateTemplates,),
 )

project-template/{{cookiecutter.repo_name}}/noxconfig.py

@@ -16,6 +16,5 @@ class Config(BaseConfig):
             / "{{cookiecutter.package_name}}"
             / "version.py"
     )
-    plugins: Iterable[object] = ()
 
 PROJECT_CONFIG = Config()