Revert "Use sets for config paths and sessions"

This commit introduced an issue because while `dict`s preserve order in
Python, sets don't, and it is unexpected for these variables to have a
random (and non-reproducible) order (in particular `sessions`).

This reverts commit d2dd6c6.

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

Author: llucax

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

@@ -13,6 +13,7 @@
 """
 
 import dataclasses as _dataclasses
+import itertools as _itertools
 from typing import Self
 
 import nox as _nox
@@ -61,10 +62,10 @@ class Config:
     opts: CommandsOptions = _dataclasses.field(default_factory=CommandsOptions)
     """Command-line options for each command used by sessions."""
 
-    sessions: set[str] = _dataclasses.field(default_factory=set)
+    sessions: list[str] = _dataclasses.field(default_factory=lambda: [])
     """List of sessions to run."""
 
-    source_paths: set[str] = _dataclasses.field(default_factory=set)
+    source_paths: list[str] = _dataclasses.field(default_factory=lambda: [])
     """List of paths containing source files that should be analyzed by the sessions.
 
     Source paths are inspected for `__init__.py` files to look for packages.
@@ -77,7 +78,7 @@ class Config:
     checking.
     """
 
-    extra_paths: set[str] = _dataclasses.field(default_factory=set)
+    extra_paths: list[str] = _dataclasses.field(default_factory=lambda: [])
     """List of extra paths to be analyzed by the sessions.
 
     These are not inspected for packages, as they are passed verbatim to the
@@ -91,7 +92,7 @@ def __post_init__(self) -> None:
         """
         for path in _util.discover_paths():
             if path not in self.extra_paths:
-                self.extra_paths.add(path)
+                self.extra_paths.append(path)
 
     def copy(self, /) -> Self:
         """Create a new object as a copy of self.
@@ -101,7 +102,7 @@ def copy(self, /) -> Self:
         """
         return _dataclasses.replace(self)
 
-    def path_args(self, session: _nox.Session, /) -> set[str]:
+    def path_args(self, session: _nox.Session, /) -> list[str]:
         """Return the file paths to run the checks on.
 
         If positional arguments are present in the nox session, those are used
@@ -115,13 +116,13 @@ def path_args(self, session: _nox.Session, /) -> set[str]:
             The file paths to run the checks on.
         """
         if session.posargs:
-            return set(session.posargs)
+            return session.posargs
 
-        return {
-            str(p) for p in _util.existing_paths(self.source_paths | self.extra_paths)
-        }
+        return list(
+            str(p) for p in _util.existing_paths(self.source_paths + self.extra_paths)
+        )
 
-    def package_args(self, session: _nox.Session, /) -> set[str]:
+    def package_args(self, session: _nox.Session, /) -> list[str]:
         """Return the package names to run the checks on.
 
         If positional arguments are present in the nox session, those are used
@@ -138,7 +139,7 @@ def package_args(self, session: _nox.Session, /) -> set[str]:
             The package names found in the `source_paths`.
         """
         if session.posargs:
-            return set(session.posargs)
+            return session.posargs
 
         sources_package_dirs_with_roots = (
             (p, _util.find_toplevel_package_dirs(p))
@@ -155,7 +156,7 @@ def package_args(self, session: _nox.Session, /) -> set[str]:
             _util.path_to_package(p) for p in _util.existing_paths(self.extra_paths)
         )
 
-        return {*source_packages, *extra_packages}
+        return list(_itertools.chain(source_packages, extra_packages))
 
 
 _config: Config | None = None

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

@@ -56,24 +56,24 @@
 
 common_config = _config.Config(
     opts=common_command_options.copy(),
-    sessions={
+    sessions=[
         "formatting",
         "mypy",
         "pylint",
         "docstrings",
         "pytest_min",
         "pytest_max",
-    },
-    source_paths={
+    ],
+    source_paths=[
         "src",
-    },
-    extra_paths={
+    ],
+    extra_paths=[
         "benchmarks",
         "docs",
         "examples",
         "noxfile.py",
         "tests",
-    },
+    ],
 )
 """Default configuration for all types of repositories."""
 
@@ -90,9 +90,9 @@
     common_config,
     opts=api_command_options,
     # We don't check the sources at all because they are automatically generated.
-    source_paths=set(),
+    source_paths=[],
     # We adapt the path to the tests.
-    extra_paths=set(_util.replace(common_config.extra_paths, {"tests": "pytests"})),
+    extra_paths=list(_util.replace(common_config.extra_paths, {"tests": "pytests"})),
 )
 """Default configuration for APIs.