Add a nox.configure() overload that takes a RepositoryType

To make the most common (default) configuration easier and more obvious,
we add an overload of `nox.configure()` that takes a `RepositoryType`
instead of a `Config` object.  This will then pick the default
configuration for that type of repository automatically.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

cookiecutter/{{cookiecutter.github_repo_name}}/noxfile.py

@@ -3,7 +3,6 @@
 
 """Configuration file for nox."""
 
-from frequenz.repo.config import nox
-from frequenz.repo.config.nox import default
+from frequenz.repo.config import RepositoryType, nox
 
-nox.configure(default.{{cookiecutter.type}}_config)
+nox.configure(RepositoryType.{{cookiecutter.type | upper}})

src/frequenz/repo/config/__init__.py

@@ -26,22 +26,22 @@
 package and use the [`frequenz.repo.config.nox.configure`][] function,
 which will configure all nox sessions.
 
-You should call `configure()` using one of the default configurations provided
-in the [`frequenz.repo.config.nox.default`][] module. For example:
+To use the default options, you should call `configure()` using one of the [repository
+types][frequenz.repo.config.RepositoryType].  For example:
 
 ```python
-from frequenz.repo.config import nox
-from frequenz.repo.config.nox import default
+from frequenz.repo.config import RepositoryType, nox
 
-nox.configure(default.lib_config)
+nox.configure(RepositoryType.LIB)
 ```
 
-Again, make sure to pick the correct default configuration based on the type of your
+Again, make sure to pick the correct project typedefault configuration based on the type of your
 project (`actor_config`, `api_config`, `app_config`, `lib_config`, `model_config`).
 
-If you need to modify the configuration, you can copy one of the default
-configurations by using the
-[`copy()`][frequenz.repo.config.nox.config.Config.copy] method:
+If you need to use some custom configuration, you can start from the default settings in
+the [`frequenz.repo.config.nox.default`][] module,
+[copying][frequenz.repo.config.nox.config.Config.copy] it and changing whatever you
+need to customize.  For example:
 
 ```python
 from frequenz.repo.config import nox

src/frequenz/repo/config/nox/__init__.py

@@ -6,27 +6,30 @@
 The main entry point is the [`configure()`][configure] function, which will
 configure all nox sessions according to some configuration.
 
-You should call `configure()` using one of the default configurations provided
-in the [`default`][] module. For example:
+To use the default options, you should call `configure()` using one of the [repository
+types][frequenz.repo.config.RepositoryType].  For example:
 
 ```python
-from frequenz.repo.config import nox
-from frequenz.repo.config.nox import default
+from frequenz.repo.config import RepositoryType, nox
 
-nox.configure(default.lib_config)
+nox.configure(RepositoryType.LIB)
 ```
 
-If you need to modify the configuration, you can copy one of the default
-configurations by using the
-[`copy()`][frequenz.repo.config.nox.config.Config.copy] method:
+Again, make sure to pick the correct project typedefault configuration based on the type of your
+project (`actor_config`, `api_config`, `app_config`, `lib_config`, `model_config`).
+
+If you need to use some custom configuration, you can start from the default settings in
+the [`frequenz.repo.config.nox.default`][] module,
+[copying][frequenz.repo.config.nox.config.Config.copy] it and changing whatever you
+need to customize.  For example:
 
 ```python
 from frequenz.repo.config import nox
 from frequenz.repo.config.nox import default
 
-conf = default.lib_config.copy()
-conf.opts.black.append("--diff")
-nox.configure(conf)
+config = default.lib_config.copy()
+config.opts.black.append("--diff")
+nox.configure(config)
 ```
 
 If you need further customization or to define new sessions, you can use the

src/frequenz/repo/config/nox/config.py

@@ -14,10 +14,11 @@
 
 import dataclasses as _dataclasses
 import itertools as _itertools
-from typing import Self
+from typing import Self, assert_never, overload
 
 import nox as _nox
 
+from .._core import RepositoryType
 from . import util as _util
 
 
@@ -177,6 +178,7 @@ def get() -> Config:
     return _config
 
 
+@overload
 def configure(conf: Config, /, *, import_default_sessions: bool = True) -> None:
     """Configure nox using the provided configuration.
 
@@ -186,10 +188,63 @@ def configure(conf: Config, /, *, import_default_sessions: bool = True) -> None:
             This is only necessary if you want to avoid using the default provided
             sessions and use your own.
     """
+
+
+@overload
+def configure(
+    repo_type: RepositoryType, /, *, import_default_sessions: bool = True
+) -> None:
+    """Configure nox using the provided repository type.
+
+    Args:
+        repo_type: The repository type to use to configure nox.  This will use the
+            default configuration in [`frequenz.repo.config.nox.default`][] for that
+            type of repository.
+        import_default_sessions: Whether to import the default sessions or not.
+            This is only necessary if you want to avoid using the default provided
+            sessions and use your own.
+    """
+
+
+def configure(
+    conf: Config | RepositoryType, /, *, import_default_sessions: bool = True
+) -> None:
+    """Configure nox using the provided configuration or repository type.
+
+    Args:
+        conf: The configuration to use to configure nox, or the repository type to use
+            to configure nox.  The later will use the default configuration in
+            [`frequenz.repo.config.nox.default`][] for that type of repository.
+        import_default_sessions: Whether to import the default sessions or not.
+            This is only necessary if you want to avoid using the default provided
+            sessions and use your own.
+    """
+    global _config  # pylint: disable=global-statement
+
     # We need to make sure sessions are imported, otherwise they won't be visible to nox.
     if import_default_sessions:
         # pylint: disable=import-outside-toplevel,cyclic-import
         from . import session as _
-    global _config  # pylint: disable=global-statement
-    _config = conf
+
+    match conf:
+        case Config():
+            _config = conf
+        case RepositoryType() as repo_type:
+            # pylint: disable=import-outside-toplevel,cyclic-import
+            from . import default
+
+            match repo_type:
+                case RepositoryType.ACTOR:
+                    _config = default.actor_config
+                case RepositoryType.API:
+                    _config = default.api_config
+                case RepositoryType.APP:
+                    _config = default.app_config
+                case RepositoryType.LIB:
+                    _config = default.lib_config
+                case RepositoryType.MODEL:
+                    _config = default.model_config
+                case _ as unhandled:
+                    assert_never(unhandled)
+
     _nox.options.sessions = _config.sessions