add config object and parser (#30)

Author: thrau

plux/build/config.py

@@ -0,0 +1,44 @@
+"""
+Module for our config wrapper. Currently, this only supports ``pyproject.toml`` files but could be extended in the
+future to support ``tox.ini``, ``setup.cfg``, etc.
+"""
+import dataclasses
+import os
+from importlib.util import find_spec
+import typing as t
+
+
+@dataclasses.dataclass
+class PluxConfiguration:
+    """
+    Configuration object with sane default values.
+    """
+    exclude: t.List[str] = dataclasses.field(default_factory=list)
+
+
+def parse_pyproject_toml(path: str | os.PathLike[str]) -> PluxConfiguration:
+    """
+    Parses a pyproject.toml file and searches for the ``[tool.plux]`` section. It then creates a ``Configuration``
+    object from the found values. Uses tomli or tomllib to parse the file.
+
+    :param path: Path to the pyproject.toml file.
+    :return: A ``Configuration`` object containing the parsed values.
+    :raises FileNotFoundError: If the file does not exist.
+    """
+    if find_spec("tomllib"):
+        from tomllib import load as load_toml
+    elif find_spec("tomli"):
+        from tomli import load as load_toml
+    else:
+        raise ImportError("Could not find a TOML parser. Please install either tomllib or tomli.")
+
+    if not os.path.exists(path):
+        raise FileNotFoundError(f"No pyproject.toml found at {path}")
+
+    with open(path, "rb") as file:
+        pyproject_config = load_toml(file)
+
+    tool_table = pyproject_config.get("tool", {})
+    tool_config = tool_table.get("plux", {})
+
+    return PluxConfiguration(**tool_config)

plux/build/setuptools.py

@@ -10,12 +10,13 @@
 import sys
 import typing as t
 from fnmatch import fnmatchcase
-from importlib.util import find_spec
 from pathlib import Path
 
 import setuptools
 from setuptools.command.egg_info import egg_info
 
+from plux.build import config
+
 try:
     from setuptools.command.editable_wheel import editable_wheel
 except ImportError:
@@ -61,7 +62,7 @@ def finalize_options(self) -> None:
         # we merge the configuration from the CLI arguments with the configuration read from the `pyproject.toml`
         # [tool.plux] section
         project_config = read_plux_configuration(self.distribution)
-        file_exclude = project_config.get("exclude")
+        file_exclude = project_config.exclude
         if file_exclude:
             self.exclude = set(self.exclude) | set(file_exclude)
         self.exclude = [_path_to_module(item) for item in self.exclude]
@@ -198,43 +199,28 @@ def load_plux_entrypoints(cmd, file_name, file_path):
     write_entries(cmd, ep_file, ep_path)
 
 
-def get_plux_json_path(distribution):
+def get_plux_json_path(distribution: setuptools.Distribution) -> str:
     dirs = distribution.package_dir
     egg_base = (dirs or {}).get("", os.curdir)
     egg_info_dir = _to_filename(_safe_name(distribution.get_name())) + ".egg-info"
     egg_info_dir = os.path.join(egg_base, egg_info_dir)
     return os.path.join(egg_info_dir, "plux.json")
 
 
-def read_plux_configuration(distribution) -> dict:
+def read_plux_configuration(distribution) -> config.PluxConfiguration:
     """
-    Try reading the [tool.plux] section of the `pyproject.toml` TOML file of the Distribution, and returns it as a
-    dictionary.
+    Try reading the [tool.plux] section of the `pyproject.toml` TOML file of the Distribution, and parse it using our
+    config parser.
     """
-    if find_spec("tomllib"):
-        # the tomllib library is part of the standard library since 3.11
-        from tomllib import load as load_toml
-    elif find_spec("tomli"):
-        # setuptools vendors the tomli library in 3.10
-        from tomli import load as load_toml
-    else:
-        # if we cannot find a TOML lib, we do not return any configuration
-        return {}
-
     dirs = distribution.package_dir
     pyproject_base = (dirs or {}).get("", os.curdir)
     pyproject_file = os.path.join(pyproject_base, "pyproject.toml")
     if not os.path.exists(pyproject_file):
-        return {}
-
-    with open(pyproject_file, "rb") as file:
-        pyproject_config = load_toml(file)
-
-    tool_table = pyproject_config.get("tool", {})
-    return tool_table.get("plux", {})
+        return config.PluxConfiguration()
 
+    return config.parse_pyproject_toml(pyproject_file)
 
-def update_entrypoints(distribution, ep: EntryPointDict):
+def update_entrypoints(distribution: setuptools.Distribution, ep: EntryPointDict):
     if distribution.entry_points is None:
         distribution.entry_points = {}