lsst-pex-config 30.0.0rc2__tar.gz → 30.0.0rc3__tar.gz

{lsst_pex_config-30.0.0rc2/python/lsst_pex_config.egg-info → lsst_pex_config-30.0.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-pex-config
-Version: 30.0.0rc2
+Version: 30.0.0rc3
 Summary: A flexible configuration system using Python files.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later
@@ -9,12 +9,12 @@ Keywords: lsst
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Astronomy
-Requires-Python: >=3.10.0
+Requires-Python: >=3.11.0
 Description-Content-Type: text/x-rst
 License-File: COPYRIGHT
 License-File: LICENSE
@@ -22,6 +22,7 @@ License-File: gpl-v3.0.txt
 License-File: bsd_license.txt
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: numpy>=1.17
+Requires-Dist: lsst-resources
 Provides-Extra: test
 Requires-Dist: pytest>=3.2; extra == "test"
 Requires-Dist: pytest-openfiles>=0.5.0; extra == "test"

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/doc/lsst.pex.config/CHANGES.rst

@@ -1,3 +1,26 @@
+lsst-pex-config v30.0.0 (2026-01-15)
+====================================
+
+Python 3.11 is now the minimum supported version.
+Tested on Python 3.14.
+
+New Features
+------------
+
+- Added a ``copy`` method that unfreezes. (`DM-16523 <https://rubinobs.atlassian.net/browse/DM-16523>`_)
+- * Changed the config loader method such that if a relative path is specified inside another config it is treated as being relative to that original config file.
+  * Modified the config loader to support URI schemes ``file``, ``resource``, and ``eups`` supported by ``lsst-resources``.
+    This change means that in some cases ``__file__`` can be a URI string and not a simple path. (`DM-33226 <https://rubinobs.atlassian.net/browse/DM-33226>`_)
+
+
+Bug Fixes
+---------
+
+- Fixed a bug that caused history-printing to fail when the initial value for a field was `None`. (`DM-51850 <https://rubinobs.atlassian.net/browse/DM-51850>`_)
+- Fixed copying of ``ConfigDictField``. (`DM-53767 <https://rubinobs.atlassian.net/browse/DM-53767>`_)
+- Fixed copying of ``ConfigChoiceField`` and ``RegistryField``. (`DM-53791 <https://rubinobs.atlassian.net/browse/DM-53791>`_)
+
+
 lsst-pex-config v29.0.0 (2025-03-25)
 ====================================
 

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lsst-pex-config"
-requires-python = ">=3.10.0"
+requires-python = ">=3.11.0"
 description = "A flexible configuration system using Python files."
 license = "BSD-3-Clause OR GPL-3.0-or-later"
 license-files = ["COPYRIGHT", "LICENSE", "gpl-v3.0.txt", "bsd_license.txt"]
@@ -16,7 +16,7 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -26,6 +26,7 @@ keywords = ["lsst"]
 dependencies = [
     "pyyaml >=5.1",
     "numpy >= 1.17",
+    "lsst-resources",
 ]
 dynamic = ["version"]
 

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/python/lsst/pex/config/config.py

@@ -38,6 +38,7 @@ __all__ = (
 import copy
 import importlib
 import io
+import logging
 import math
 import numbers
 import os
@@ -47,9 +48,13 @@ import sys
 import tempfile
 import warnings
 from collections.abc import Mapping
+from contextlib import contextmanager
+from contextvars import ContextVar
 from types import GenericAlias
 from typing import Any, ForwardRef, Generic, TypeVar, cast, overload
 
+from lsst.resources import ResourcePath, ResourcePathExpression
+
 # if YAML is not available that's fine and we simply don't register
 # the yaml representer since we know it won't be used.
 try:
@@ -74,6 +79,25 @@ else:
     YamlLoaders = ()
     doImport = None
 
+_LOG = logging.getLogger(__name__)
+
+
+# Tracks the current config directory for the current context.
+_config_dir_stack: ContextVar[ResourcePath | None] = ContextVar("_config_dir_stack", default=None)
+
+
+def _get_config_root() -> ResourcePath | None:
+    return _config_dir_stack.get()
+
+
+@contextmanager
+def _push_config_root(dirname: ResourcePath):
+    token = _config_dir_stack.set(dirname)
+    try:
+        yield
+    finally:
+        _config_dir_stack.reset(token)
+
 
 class _PexConfigGenericAlias(GenericAlias):
     """A Subclass of python's GenericAlias used in defining and instantiating
@@ -1171,15 +1195,51 @@ class Config(metaclass=ConfigMeta):  # type: ignore
                 e.add_note(f"No field of name {name} exists in config type {_typeStr(self)}")
                 raise
 
+    def _filename_to_resource(
+        self, filename: ResourcePathExpression | None = None
+    ) -> tuple[ResourcePath | None, str]:
+        """Create resource path from filename.
+
+        Parameters
+        ----------
+        filename : `lsst.resources.ResourcePathExpression` or `None`
+            The URI expression associated with this config. Can be `None`
+            if no file URI is known.
+
+        Returns
+        -------
+        resource : `lsst.resources.ResourcePath` or `None`
+            The resource version of the filename. Returns `None` if no filename
+            was given or refers to unspecified value.
+        file_string : `str`
+            String form of the resource for use in ``__file__``
+        """
+        if filename is None or filename in ("?", "<unknown>"):
+            return None, "<unknown>"
+        base = _get_config_root()
+        resource = ResourcePath(filename, forceAbsolute=True, forceDirectory=False, root=base)
+
+        # Preferred definition of __file__ is the full OS path. If a config
+        # is loaded with a relative path it must be converted to the absolute
+        # path to avoid confusion with later relative paths referenced inside
+        # the config.
+        if resource.scheme == "file":
+            file_string = resource.ospath
+        else:
+            file_string = str(resource)
+
+        return resource, file_string
+
     def load(self, filename, root="config"):
         """Modify this config in place by executing the Python code in a
         configuration file.
 
         Parameters
         ----------
-        filename : `str`
-            Name of the configuration file. A configuration file is Python
-            module.
+        filename : `lsst.resources.ResourcePathExpression`
+            Name of the configuration URI. A configuration file is a Python
+            module. Since configuration files are Python code, remote URIs
+            are not allowed.
         root : `str`, optional
             Name of the variable in file that refers to the config being
             overridden.
@@ -1199,9 +1259,21 @@ class Config(metaclass=ConfigMeta):  # type: ignore
         lsst.pex.config.Config.saveToStream
         lsst.pex.config.Config.saveToString
         """
-        with open(filename) as f:
-            code = compile(f.read(), filename=filename, mode="exec")
-            self.loadFromString(code, root=root, filename=filename)
+        resource, file_string = self._filename_to_resource(filename)
+        if resource is None:
+            # A filename is required.
+            raise ValueError(f"Undefined URI provided to load command: {filename}.")
+
+        if resource.scheme not in ("file", "eups", "resource"):
+            raise ValueError(f"Remote URI ({resource}) can not be used to load configurations.")
+
+        # Push the directory of the file we are now reading onto the stack
+        # so that nested loads are relative to this file.
+        with _push_config_root(resource.dirname()):
+            _LOG.debug("Updating config from URI %s", str(resource))
+            with resource.open("r") as f:
+                code = compile(f.read(), filename=file_string, mode="exec")
+            self._loadFromString(code, root=root, filename=file_string)
 
     def loadFromStream(self, stream, root="config", filename=None, extraLocals=None):
         """Modify this Config in place by executing the Python code in the
@@ -1224,7 +1296,8 @@ class Config(metaclass=ConfigMeta):  # type: ignore
             Then this config's field ``myField`` is set to ``5``.
         filename : `str`, optional
             Name of the configuration file, or `None` if unknown or contained
-            in the stream. Used for error reporting.
+            in the stream. Used for error reporting and to set ``__file__``
+            variable in config.
         extraLocals : `dict` of `str` to `object`, optional
             Any extra variables to include in local scope when loading.
 
@@ -1244,7 +1317,7 @@ class Config(metaclass=ConfigMeta):  # type: ignore
         """
         if hasattr(stream, "read"):
             if filename is None:
-                filename = getattr(stream, "name", "?")
+                filename = getattr(stream, "name", "<unknown>")
             code = compile(stream.read(), filename=filename, mode="exec")
         else:
             code = stream
@@ -1268,9 +1341,11 @@ class Config(metaclass=ConfigMeta):  # type: ignore
                 config.myField = 5
 
             Then this config's field ``myField`` is set to ``5``.
-        filename : `str`, optional
-            Name of the configuration file, or `None` if unknown or contained
-            in the stream. Used for error reporting.
+        filename : `lsst.resources.ResourcePathExpression`, optional
+            URI of the configuration file, or `None` if unknown or contained
+            in the stream. Used for error reporting and to set ``__file__``
+            variable. Required to be set if the string config attempts to
+            load other configs using either relative path or ``__file__``.
         extraLocals : `dict` of `str` to `object`, optional
             Any extra variables to include in local scope when loading.
 
@@ -1291,7 +1366,24 @@ class Config(metaclass=ConfigMeta):  # type: ignore
         if filename is None:
             # try to determine the file name; a compiled string
             # has attribute "co_filename",
-            filename = getattr(code, "co_filename", "?")
+            filename = getattr(code, "co_filename", "<unknown>")
+
+        resource, file_string = self._filename_to_resource(filename)
+        if resource is None:
+            # No idea where this config came from so no ability to deal with
+            # relative paths. No reason to use context.
+            self._loadFromString(code, root=root, filename=filename, extraLocals=extraLocals)
+        else:
+            # Push the directory of the file we are now reading onto the stack
+            # so that nested loads are relative to this file.
+            with _push_config_root(resource.dirname()):
+                self._loadFromString(code, root=root, filename=file_string, extraLocals=extraLocals)
+
+    def _loadFromString(self, code, root="config", filename=None, extraLocals=None):
+        """Update config from string.
+
+        Assumes relative directory path context has been setup by caller.
+        """
         with RecordingImporter() as importer:
             globals = {"__file__": filename}
             local = {root: self}

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/python/lsst/pex/config/configChoiceField.py

@@ -192,7 +192,7 @@ class ConfigInstanceDict(collections.abc.Mapping[str, Config]):
         result._typemap = self._typemap
         if self._selection is not None:
             if self._field.multi:
-                result._selection = SelectionSet(result._dict, self._selection._set)
+                result._selection = SelectionSet(self, self._selection._set)
             else:
                 result._selection = self._selection
         return result

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/python/lsst/pex/config/configDictField.py

@@ -76,7 +76,7 @@ class ConfigDict(Dict[str, Config]):
         return type(self)(
             config,
             self._field,
-            {k: v._copy() for k, v in self._dict.items()},
+            {k: v.copy() for k, v in self._dict.items()},
             at=None,
             label="copy",
             setHistory=False,

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/python/lsst/pex/config/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "30.0.0rc2"
+__version__ = "30.0.0rc3"

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3/python/lsst_pex_config.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-pex-config
-Version: 30.0.0rc2
+Version: 30.0.0rc3
 Summary: A flexible configuration system using Python files.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later
@@ -9,12 +9,12 @@ Keywords: lsst
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Astronomy
-Requires-Python: >=3.10.0
+Requires-Python: >=3.11.0
 Description-Content-Type: text/x-rst
 License-File: COPYRIGHT
 License-File: LICENSE
@@ -22,6 +22,7 @@ License-File: gpl-v3.0.txt
 License-File: bsd_license.txt
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: numpy>=1.17
+Requires-Dist: lsst-resources
 Provides-Extra: test
 Requires-Dist: pytest>=3.2; extra == "test"
 Requires-Dist: pytest-openfiles>=0.5.0; extra == "test"

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/python/lsst_pex_config.egg-info/requires.txt

@@ -1,5 +1,6 @@
 pyyaml>=5.1
 numpy>=1.17
+lsst-resources
 
 [test]
 pytest>=3.2

lsst_pex_config-30.0.0rc3/tests/test__file__.py

@@ -0,0 +1,103 @@
+# This file is part of pex_config.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (http://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This software is dual licensed under the GNU General Public License and also
+# under a 3-clause BSD license. Recipients may choose which of these licenses
+# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
+# respectively.  If you choose the GPL option then the following text applies
+# (but note that there is still no warranty even if you opt for BSD instead):
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import unittest
+
+import lsst.pex.config as pexConf
+from lsst.resources import ResourcePath
+
+TESTDIR = os.path.dirname(os.path.abspath(__file__))
+
+
+class FileConfig(pexConf.Config):
+    """Config used for testing __file__."""
+
+    number = pexConf.Field("FileConfig.number", int, default=0)
+    filename = pexConf.Field("FileConfig.filename", str, default=None)
+
+
+class FilenameTestCase(unittest.TestCase):
+    """Check that __file__ can be used in a config file."""
+
+    def test__file(self):
+        fileUri = ResourcePath(f"{TESTDIR}/config/filename.py", forceAbsolute=True, forceDirectory=False)
+        for confFile in (os.path.join(TESTDIR, "config", "filename.py"), fileUri, str(fileUri)):
+            c = FileConfig()
+            c.load(confFile)
+            # The __file__ is always the ospath form.
+            self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py"))
+            self.assertEqual(c.number, 5)
+
+        c = FileConfig()
+        with fileUri.open("r") as fh:
+            c.loadFromStream(fh)
+            self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py"))
+            self.assertEqual(c.number, 5)
+
+        c = FileConfig()
+        data = fileUri.read()
+        c.loadFromString(data)
+        self.assertEqual(c.filename, "<unknown>")
+
+        c.loadFromString(data, filename=fileUri.ospath)
+        self.assertEqual(c.filename, fileUri.ospath)
+
+        c = FileConfig()
+        with self.assertRaises(ValueError):
+            # Use mem scheme because we do not support it for config
+            # loading and it does not require additional dependencies
+            # such as requests or boto3 to be available.
+            c.load("mem://not_there.py")
+
+    def test_relative(self):
+        fileUri = ResourcePath(f"{TESTDIR}/config/relfilename.py", forceAbsolute=True, forceDirectory=False)
+        for confFile in (os.path.join(TESTDIR, "config", "relfilename.py"), fileUri, str(fileUri)):
+            c = FileConfig()
+            c.load(confFile)
+            # The __file__ is always the ospath form and should be the file
+            # loaded by the config.
+            self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py"))
+            self.assertEqual(c.number, 5)
+
+        c = FileConfig()
+        with fileUri.open("r") as fh:
+            c.loadFromStream(fh)
+            self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py"))
+            self.assertEqual(c.number, 5)
+
+        c = FileConfig()
+        data = fileUri.read()
+        with self.assertRaises(FileNotFoundError):
+            c.loadFromString(data)
+
+        c.loadFromString(data, filename=fileUri.ospath)
+        self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py"))
+
+
+if __name__ == "__main__":
+    unittest.main()

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/tests/test_configChoiceField.py

@@ -165,6 +165,20 @@ class ConfigChoiceFieldTest(unittest.TestCase):
         with self.assertRaises(pexConfig.UnexpectedProxyUsageError):
             pickle.dumps(self.config.c.names)
 
+    def test_copy(self):
+        """Test the copy method on a ConfigChoiceField."""
+        copy1: Config3 = self.config.copy()
+        copy1.a["AAA"].f = 1
+        copy1.a["BBB"].f = 1.0
+        copy1.a = "BBB"
+        self.assertEqual(self.config.a.name, "AAA")
+        self.assertEqual(self.config.a.active.f, 4)
+        self.assertEqual(self.config.a["AAA"].f, 4)
+        self.assertEqual(self.config.a["BBB"].f, 0.5)
+        self.assertEqual(copy1.a.name, "BBB")
+        self.assertEqual(copy1.a["AAA"].f, 1)
+        self.assertEqual(copy1.a["BBB"].f, 1.0)
+
 
 if __name__ == "__main__":
     unittest.main()

{lsst_pex_config-30.0.0rc2 → lsst_pex_config-30.0.0rc3}/tests/test_configDictField.py

@@ -207,6 +207,19 @@ class ConfigDictFieldTest(unittest.TestCase):
 
         self.assertTrue(pexConfig.compareConfigs("test", c1, c2))
 
+    def test_copy(self):
+        """Test that the copy method works on ConfigDictField instances."""
+        original = Config2()
+        original.d1 = {"a": Config1, "b": Config1(f=4.0)}
+        original.freeze()
+        copy1 = original.copy()
+        self.assertEqual(copy1.d1["a"].f, 3.0)
+        self.assertEqual(copy1.d1["b"].f, 4.0)
+        copy1.d1["a"].f = 6.0
+        self.assertEqual(copy1.d1["a"].f, 6.0)
+        self.assertEqual(copy1.d1["b"].f, 4.0)
+        self.assertEqual(original.d1["a"].f, 3.0)
+
 
 if __name__ == "__main__":
     unittest.main()

lsst_pex_config-30.0.0rc2/tests/test__file__.py

@@ -1,55 +0,0 @@
-# This file is part of pex_config.
-#
-# Developed for the LSST Data Management System.
-# This product includes software developed by the LSST Project
-# (http://www.lsst.org).
-# See the COPYRIGHT file at the top-level directory of this distribution
-# for details of code ownership.
-#
-# This software is dual licensed under the GNU General Public License and also
-# under a 3-clause BSD license. Recipients may choose which of these licenses
-# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
-# respectively.  If you choose the GPL option then the following text applies
-# (but note that there is still no warranty even if you opt for BSD instead):
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import unittest
-
-import lsst.pex.config as pexConf
-
-TESTDIR = os.path.dirname(os.path.abspath(__file__))
-
-
-class FileConfig(pexConf.Config):
-    """Config used for testing __file__."""
-
-    number = pexConf.Field("FileConfig.number", int, default=0)
-    filename = pexConf.Field("FileConfig.filename", str, default=None)
-
-
-class FilenameTestCase(unittest.TestCase):
-    """Check that __file__ can be used in a config file."""
-
-    def test__file(self):
-        c = FileConfig()
-        confFile = os.path.join(TESTDIR, "config", "filename.py")
-        c.load(confFile)
-        self.assertEqual(c.filename, confFile)
-        self.assertEqual(c.number, 5)
-
-
-if __name__ == "__main__":
-    unittest.main()