lsst-pex-config 30.0.0rc2__py3-none-any.whl → 30.0.0rc3__py3-none-any.whl

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/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/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/version.py

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

{lsst_pex_config-30.0.0rc2.dist-info → lsst_pex_config-30.0.0rc3.dist-info}/METADATA

@@ -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.dist-info → lsst_pex_config-30.0.0rc3.dist-info}/RECORD

@@ -5,9 +5,9 @@ lsst/pex/config/_doNotImportMe.py,sha256=AYqqE8aIHH711hPcZJssplBsIIW4xCbz2oZqRNh
 lsst/pex/config/callStack.py,sha256=HxcH1QpYERsR68sBLs8jqX3Gj85e28vhCCjCy6lnVaE,5917
 lsst/pex/config/choiceField.py,sha256=S_ygw6coQaKNIstpQxKF-MMsX0agdEZtqZuEcK1EYJg,4277
 lsst/pex/config/comparison.py,sha256=2zbOdMD5aOC3ccI2NJSxtiI59wLMmssuP9oxdXBvzaE,6320
-lsst/pex/config/config.py,sha256=DPlN6tLVJawAaJPuxTjjDZQGYPnwWOv1cGq5myFoNQU,63028
-lsst/pex/config/configChoiceField.py,sha256=CbISBYgMuKEJyed2G6f8XEodL-98O3L2Haxc8Dx_s1I,24439
-lsst/pex/config/configDictField.py,sha256=gnVi52CHB3B0K-NNC3NUZDxi556pFJnVSF4-73JlJw4,12893
+lsst/pex/config/config.py,sha256=bGlaQ9F5dtmXXbnlyzvUisT7UXn7SYBaZ4GS14LRANI,66935
+lsst/pex/config/configChoiceField.py,sha256=gWBODt4Vbw7IcMTNLBBizWdXBXyJSCN0SRl8c2zafL4,24431
+lsst/pex/config/configDictField.py,sha256=_OjAj8DSwyF8HPoIRjCvyw3Bt1IcP0GACdl-SHggR1M,12892
 lsst/pex/config/configField.py,sha256=9jSPSHO_9p-499SmJgvMWBbizAl4p1jTQrtlib1gXHo,11655
 lsst/pex/config/configurableField.py,sha256=-nYA54G6UJLVzB_lQgPRiCMQJ_yv9c-43uxyCJkH198,18995
 lsst/pex/config/convert.py,sha256=dBTLjkcoh3lM6FxtY9DV33iLOtD6V0PMni6O2b9K4Ww,2397
@@ -17,19 +17,19 @@ lsst/pex/config/listField.py,sha256=H0j1TR3jTxUM80vcBWmoNlCCjd1HFSP15UxiR56gBxY,
 lsst/pex/config/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lsst/pex/config/rangeField.py,sha256=VmfcAoLYRJIdIsnFQIFlVYKrmNnfGX6Ef9enEYkFTx8,5429
 lsst/pex/config/registry.py,sha256=JKy6kXOumSYDoOdHlg4oBGeQN7pmMSOgCJCXylEI6yM,15790
-lsst/pex/config/version.py,sha256=CrAQNQjb1NNXqaNvScI53U2GvkmrnpRtyOiy0bIrcl4,52
+lsst/pex/config/version.py,sha256=Tt7y1Knxuicvk026_H8m0GXmxEFM8XEWyfbDoHcAxbs,52
 lsst/pex/config/wrap.py,sha256=t8s5KzN2kJ-oW8AJTZrz4xAl0Qtpvnqo9H6rQKRBK_s,12964
 lsst/pex/config/configurableActions/__init__.py,sha256=kwMbhFr3LirwEqzgHij7CxWF_xki3UYeajzveb4vpTI,1039
 lsst/pex/config/configurableActions/_configurableAction.py,sha256=KZiYYzIQHNeUhDxS1DMb_D9X28_LOzLyNXclaOW-ApY,2784
 lsst/pex/config/configurableActions/_configurableActionField.py,sha256=E1uVrGIvu64QDJL76sW3LlIrR30-NJs0ZQeofy-iVEs,5353
 lsst/pex/config/configurableActions/_configurableActionStructField.py,sha256=HL53MsLh1DaKmZBD3midrHcB8tbJ46lNBwerjne0qrg,17754
 lsst/pex/config/configurableActions/tests.py,sha256=aisHgzghfR4NFQD22NU2K5pNilCjAwcJTSMs0vK7dzI,3039
-lsst_pex_config-30.0.0rc2.dist-info/licenses/COPYRIGHT,sha256=J3bcuh9PTaTU9iNjxE-9THWEwoo5drYshgYvZVgUKoI,381
-lsst_pex_config-30.0.0rc2.dist-info/licenses/LICENSE,sha256=pRExkS03v0MQW-neNfIcaSL6aiAnoLxYgtZoFzQ6zkM,232
-lsst_pex_config-30.0.0rc2.dist-info/licenses/bsd_license.txt,sha256=7MIcv8QRX9guUtqPSBDMPz2SnZ5swI-xZMqm_VDSfxY,1606
-lsst_pex_config-30.0.0rc2.dist-info/licenses/gpl-v3.0.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-lsst_pex_config-30.0.0rc2.dist-info/METADATA,sha256=mJscy7ZVKy3me7ddU2jrehkQdhZWvt1gQ4J0jM2wYho,2206
-lsst_pex_config-30.0.0rc2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lsst_pex_config-30.0.0rc2.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
-lsst_pex_config-30.0.0rc2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-lsst_pex_config-30.0.0rc2.dist-info/RECORD,,
+lsst_pex_config-30.0.0rc3.dist-info/licenses/COPYRIGHT,sha256=J3bcuh9PTaTU9iNjxE-9THWEwoo5drYshgYvZVgUKoI,381
+lsst_pex_config-30.0.0rc3.dist-info/licenses/LICENSE,sha256=pRExkS03v0MQW-neNfIcaSL6aiAnoLxYgtZoFzQ6zkM,232
+lsst_pex_config-30.0.0rc3.dist-info/licenses/bsd_license.txt,sha256=7MIcv8QRX9guUtqPSBDMPz2SnZ5swI-xZMqm_VDSfxY,1606
+lsst_pex_config-30.0.0rc3.dist-info/licenses/gpl-v3.0.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+lsst_pex_config-30.0.0rc3.dist-info/METADATA,sha256=FWwCQ97l9cvOytpuduZ_8A6GwnzyQwRX_YXFCSPS72I,2236
+lsst_pex_config-30.0.0rc3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lsst_pex_config-30.0.0rc3.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
+lsst_pex_config-30.0.0rc3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+lsst_pex_config-30.0.0rc3.dist-info/RECORD,,