Rename to plugins_for_nox_sessions and require as BaseConfig should be used at this point

Author: ArBridgeman

doc/changes/unreleased.md

@@ -10,4 +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: Replaced `plugins` with `BaseConfig.nox_task_plugins`
+* #626: Replaced `plugins` with `BaseConfig.plugins_for_nox_sessions`

doc/user_guide/customization.rst

@@ -65,14 +65,14 @@ 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 `PROJECT_CONFIG`, you should amend the `nox_task_plugins` tuple to include the new plugin:
+In the Nox `PROJECT_CONFIG`, you should amend the `plugins_for_nox_sessions` tuple to include the new plugin:
 
 .. code-block:: python
 
     from exasol.toolbox.config import BaseConfig
 
     PROJECT_CONFIG = BaseConfig(
-        nox_task_plugins=(UpdateTemplates,), # register the plugin
+        plugins_for_nox_sessions=(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.

exasol/toolbox/config.py

@@ -95,10 +95,10 @@ class BaseConfig(BaseModel):
         `exasol.toolbox.config.DEFAULT_EXCLUDED_PATHS`.
         """,
     )
-    nox_task_plugins: tuple[ValidPluginHook, ...] = Field(
+    plugins_for_nox_sessions: tuple[ValidPluginHook, ...] = Field(
         default=(),
         description="""
-        This is used to provide hooks to extend one or more of the Nox tasks provided
+        This is used to provide hooks to extend one or more of the Nox sessions 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,

exasol/toolbox/nox/plugin.py

@@ -108,7 +108,18 @@ def post_integration_tests_hook(self, session, config, context):
     def plugin_manager(config) -> pluggy.PluginManager:
         pm = pluggy.PluginManager(_PLUGIN_MARKER)
         pm.add_hookspecs(NoxTasks)
-        for plugin in getattr(config, "nox_task_plugins", []):
+        plugin_attribute = "plugins_for_nox_sessions"
+
+        if not hasattr(config, plugin_attribute):
+            raise AttributeError(
+                "in the noxconfig.py file, the class Config should inherit "
+                "from `exasol.toolbox.config.BaseConfig`. This is used to "
+                f"set the default `{plugin_attribute}`. If the allowed "
+                f"`{plugin_attribute} needs to differ in your project and is an "
+                "input parameter (not property), you can set it in the PROJECT_CONFIG statement."
+            )
+
+        for plugin in getattr(config, plugin_attribute):
             pm.register(plugin())
         return pm
 

noxconfig.py

@@ -71,5 +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],),
-    nox_task_plugins=(UpdateTemplates,),
+    plugins_for_nox_sessions=(UpdateTemplates,),
 )

test/unit/config_test.py

@@ -110,20 +110,20 @@ def prepare_release_update_version(self, session, config, version: Version) -> N
 class TestPlugins:
     @staticmethod
     def test_works_when_empty():
-        BaseConfig(nox_task_plugins=())
+        BaseConfig(plugins_for_nox_sessions=())
 
     @staticmethod
     def test_works_for_hook(capsys):
-        BaseConfig(nox_task_plugins=(WithHook,))
+        BaseConfig(plugins_for_nox_sessions=(WithHook,))
 
     @staticmethod
     def test_raises_exception_method_with_hook_not_specified():
         with pytest.raises(ValidationError) as ex:
-            BaseConfig(nox_task_plugins=(WithNotSpecifiedHook,))
+            BaseConfig(plugins_for_nox_sessions=(WithNotSpecifiedHook,))
         assert "Method `not_specified_anywhere`" in str(ex.value)
 
     @staticmethod
     def test_raises_exception_without_hook():
         with pytest.raises(ValidationError) as ex:
-            BaseConfig(nox_task_plugins=(WithoutHook,))
+            BaseConfig(plugins_for_nox_sessions=(WithoutHook,))
         assert "No methods in `WithoutHook`" in str(ex.value)