Handle configured paths as sets.

* Define each attribute as set[Path].
* Resolve and add each path to the sets when loading configuration.

Author: bcbnz

data/share/matplotlib-pgfutils/pgfutils.toml

@@ -135,7 +135,9 @@ environment = ""
 # taken to be relative to the project's top-level directory. Note that these
 # are not added to any search paths, i.e., you still have to use the full path
 # when loading data files in a script.
-data = "."
+data = [
+  ".",
+]
 
 # Entries to add to the start of sys.path. This will be done in the order
 # specified here, so the last path in this setting will be the first in
@@ -147,12 +149,12 @@ data = "."
 #   subdir/pythonlib
 #   /usr/share/myotherlib
 #
-pythonpath = ""
+pythonpath = []
 
 
 # Paths containing Python libraries which are already on the Python path, but
 # should be included in the file tracking.
-extra_imports = ""
+extra_imports = []
 
 
 # Specific Matplotlib rcParams to set.

pgfutils.py

@@ -330,9 +330,9 @@ def parse_dimension(spec: str) -> float:
 class PathConfig(TypedDict):
     """Path configuration options."""
 
-    data: str
-    pythonpath: str
-    extra_imports: str
+    data: set[Path]
+    pythonpath: set[Path]
+    extra_imports: set[Path]
 
 
 class PGFUtilsConfig(TypedDict):
@@ -393,7 +393,9 @@ def __init__(self, load_file: bool = True) -> None:
             directory and load it after setting the defaults.
 
         """
-        self.paths = dict(data=".", pythonpath="", extra_imports="")
+        self.paths = dict(
+            data={Path.cwd().resolve()}, pythonpath=set(), extra_imports=set()
+        )
         self.pgfutils = dict(
             preamble="",
             preamble_substitute=False,
@@ -531,6 +533,17 @@ def update(self, new_settings: Mapping[str, Mapping[str, Any]]):
                         )
                     section[key] = val
 
+                # For a set, handle based on the type of the set items.
+                elif origin is set:
+                    if not isinstance(val, (set, list, tuple)):
+                        raise ConfigError(name, key, "value must be a list")
+
+                    if args == (Path,):
+                        for item in val:
+                            section[key].add(Path(item).resolve())
+                    else:
+                        raise RuntimeError(f"unhandled set type {args}")
+
                 # Assume a string.
                 else:
                     section[key] = val
@@ -557,19 +570,17 @@ def in_tracking_dir(type, fn):
 
     """
     if type == "data":
-        paths = config.paths["data"].strip().splitlines()
+        paths = config.paths["data"]
     elif type == "import":
-        paths = config.paths["pythonpath"].strip().splitlines()
-        paths.extend(config.paths["extra_imports"].strip().splitlines())
+        paths = config.paths["pythonpath"].union(config.paths["extra_imports"])
     else:
         raise ValueError(f"Unknown tracking type {type}.")
 
     # If we can compute a relative path, it must be within the directory.
     fn = Path(fn).resolve()
     for path in paths:
-        resolved = Path(path).resolve()
         try:
-            fn.relative_to(resolved)
+            fn.relative_to(path)
         except ValueError:
             continue
         return True
@@ -737,10 +748,8 @@ def setup_figure(
             _interactive = True
 
     # Add any desired entries to sys.path.
-    for newpath in config.paths["pythonpath"].splitlines():
-        newpath = newpath.strip()
-        if newpath:
-            sys.path.insert(0, newpath)
+    for newpath in config.paths["pythonpath"]:
+        sys.path.insert(0, str(newpath))
 
     # Set the backend. We don't want to overwrite the current backend if this is an
     # interactive run as the PGF backend does not implement a GUI.

tests/sources/fix_raster_paths/pgfutils.toml

@@ -1,9 +1,6 @@
 # SPDX-FileCopyrightText: Blair Bonnett
 # SPDX-License-Identifier: BSD-3-Clause
 
-[paths]
-data = "."
-
 [post_processing]
 fix_raster_paths = true
 tikzpicture = false

tests/sources/pythonpath/pgfutils.toml

@@ -2,4 +2,4 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 [paths]
-pythonpath = "libdir"
+pythonpath = ["libdir"]

tests/sources/tracking/extra_dirs/pgfutils.toml

@@ -2,8 +2,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 [paths]
-data = """
-.
-..
-../..
-"""
+data = [
+	"..",
+	"../..",
+]

tests/sources/tracking/imports/cfg_extra/pgfutils.toml

@@ -2,6 +2,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 [paths]
-extra_imports = """
-  ../lib
-"""
+extra_imports = [
+  "../lib"
+]

tests/sources/tracking/imports/cfg_pythonpath/pgfutils.toml

@@ -2,6 +2,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 [paths]
-pythonpath = """
-  ../lib
-"""
+pythonpath = [
+  "../lib",
+]