lsst-pex-config 26.0.0a20230400__tar.gz → 29.2025.4500__tar.gz

lsst_pex_config-29.2025.4500/COPYRIGHT

@@ -0,0 +1,4 @@
+Copyright 2008-2014, 2016, 2017, 2019, 2020, 2022-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
+Copyright 2014-2023 The Trustees of Princeton University
+Copyright 2015-2016, 2018-2020, 2022-2023 University of Washington
+Copyright 2015, 2018-2020 The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory

{lsst-pex-config-26.0.0a20230400/python/lsst_pex_config.egg-info → lsst_pex_config-29.2025.4500}/PKG-INFO

@@ -1,26 +1,31 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: lsst-pex-config
-Version: 26.0.0a20230400
+Version: 29.2025.4500
 Summary: A flexible configuration system using Python files.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
-License: BSD 3-Clause License, GPLv3+
+License-Expression: BSD-3-Clause OR GPL-3.0-or-later
 Project-URL: Homepage, https://github.com/lsst/pex_config
 Keywords: lsst
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+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
 Description-Content-Type: text/x-rst
-Provides-Extra: test
 License-File: COPYRIGHT
 License-File: LICENSE
 License-File: gpl-v3.0.txt
 License-File: bsd_license.txt
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: numpy>=1.17
+Provides-Extra: test
+Requires-Dist: pytest>=3.2; extra == "test"
+Requires-Dist: pytest-openfiles>=0.5.0; extra == "test"
+Dynamic: license-file
 
 ##########
 pex_config

lsst_pex_config-29.2025.4500/doc/lsst.pex.config/CHANGES.rst

@@ -0,0 +1,125 @@
+lsst-pex-config v29.0.0 (2025-03-25)
+====================================
+
+New Features
+------------
+
+- Introduced the ``keyCheck`` callback to ``DictField`` and ``ConfigDictField``, allowing custom key validation during assignment. Added unit tests to ensure functionality. (`DM-48074 <https://rubinobs.atlassian.net/browse/DM-48074>`_)
+- Make the messages emitted by ``compareConfigs`` consistently start with the fully-qualified name of the config field. (`DM-49121 <https://rubinobs.atlassian.net/browse/DM-49121>`_)
+
+
+lsst-pex-config v28.0.0 (2024-11-21)
+====================================
+
+No significant changes.
+
+
+lsst-pex-config v27.0.0 (2024-05-29)
+====================================
+
+- Improved all docstrings to make them compliant with Numpydoc.
+- Minor code cleanups driven by Ruff linting. (`DM-42116 <https://rubinobs.atlassian.net/browse/DM-42116>`_)
+
+lsst-pex-config v26.0.0 (2023-09-22)
+====================================
+
+New Features
+------------
+
+- Added a dynamic-default callback argument to ``RegistryField``. (`DM-31924 <https://rubinobs.atlassian.net/browse/DM-31924>`_)
+- Introduced ``ConfigurableActions``. These are ``pex_config`` fields and config types which function as a functor, state is set at config time, but the ``ConfigurableActions`` are callable at runtime to produce an action. (`DM-36649 <https://rubinobs.atlassian.net/browse/DM-36649>`_)
+
+
+API Changes
+-----------
+
+- The ``loadFromStream`` and ``loadFromString`` methods now take a dictionary as an optional argument which allows specifying additional variables to use in local scope when reading configs. (`DM-40198 <https://rubinobs.atlassian.net/browse/DM-40198>`_)
+
+
+Other Changes and Additions
+---------------------------
+
+- There is now a requirement for configuration parameters to have a non-empty docstring. (`DM-4037 <https://rubinobs.atlassian.net/browse/DM-4037>`_)
+
+
+lsst-pex-config v25.0.0 (2023-02-28)
+====================================
+
+Other Changes and Additions
+---------------------------
+
+- Some sorting now happens when saving config files (via DM-33027). (`DM-35060 <https://rubinobs.atlassian.net/browse/DM-35060>`_)
+
+
+lsst-pex-config v24.0.0 (2022-08-30)
+====================================
+
+New Features
+------------
+
+* Add support for python typing of Fields. (DM-35312)
+* ``loadFromStream`` now accepts a file-like object. (DM-32733)
+
+Removals
+--------
+
+* The old ``root`` name in configuration files has been removed. (DM-32759)
+* The Python2 iteration methods (``iterkeys``, etc) have been removed (DM-7148)
+
+Other Changes
+-------------
+
+* Attempting to pickle a proxy object now fails with a useful error message. (DM-33963)
+
+lsst-pex-config v23.0.0 (2021-12-21)
+====================================
+
+Other Changes
+-------------
+
+* Internal data structures have been modified to aid Python reference counting. (DM-31507)
+
+lsst-pex-config v22.0.0 (2021-07-09)
+====================================
+
+Other Changes
+-------------
+
+* Fix some issues with history handling. (DM-27519)
+
+lsst-pex-config v21.0.0 (2020-12-08)
+====================================
+
+New Features
+------------
+
+* Configuration objects can now be serialized to YAML. (DM-26008)
+
+lsst-pex-config v20.0.0 (2020-06-24)
+====================================
+
+New Features
+------------
+
+* ``__file__`` can now be accessed within a config file.
+  This allow the config to acccess another config file relative to this one without having to use an environment variable or ``getPackageDir``. (DM-23359)
+
+Bug Fixes
+---------
+
+* Freezing a config no longer affects other instances of that config. (DM-24435)
+
+Other Changes
+-------------
+
+* It is now possible to print a configuration without the associated imports. (DM-22301)
+
+lsst-pex-config v19.0.0 (2019-12-05)
+====================================
+
+New Features
+------------
+
+* Now released under a dual GPLv3 and 3-clause BSD license.
+* Add support for deprecating configuration fields. Such fields are not written out. (DM-20378)
+* ``pex_policy`` and ``daf_base`` are now optional dependencies, and the dependency on the LSST ``utils`` package in testing has been removed. (DM-21064)

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/field-types.rst

@@ -7,7 +7,7 @@ Types of configuration fields
 .. TODO: improve this page to summarize the purpose of each field, and then have a dedicated section for each field. https://jira.lsstcorp.org/browse/DM-17196
 
 Attributes of the configuration object must be subclasses of `Field`.
-A number of these are predefined: `Field`, `RangeField`, `ChoiceField`, `ListField`, `ConfigField`, `ConfigChoiceField`, `RegistryField` and `ConfigurableField`.
+A number of these are predefined: `Field`, `RangeField`, `ChoiceField`, `ListField`, `ConfigField`, `ConfigChoiceField`, `RegistryField`, `ConfigurableField`, `~.configurableActions.ConfigurableActionField`, and `~.configurableActions.ConfigurableActionStructField`.
 
 Example of `RangeField`:
 
@@ -17,7 +17,7 @@ Example of `RangeField`:
         """Parameters for controlling background estimation.
         """
         binSize = pexConfig.RangeField(
-            doc=("How large a region of the sky should be "
+            doc=("Define the region of the sky size "
                  "used for each background point."),
             dtype=int, default=256, min=10
         )
@@ -31,7 +31,7 @@ Example of `ListField` and `Config` inheritance:
         """
         subregionSize = pexConfig.ListField(
             dtype=int,
-            doc=("width, height of stack subregion size; make "
+            doc=("Width and height of stack subregion size. Make the values "
                  "small enough that a full stack of images will "
                  "fit into memory at once."),
             length=2,
@@ -44,7 +44,7 @@ Examples of `ChoiceField` and `ConfigField` and the use of the `Config` object's
 .. code-block:: python
 
     class InitialPsfConfig(pexConfig.Config):
-        """A config that describes the initial PSF used 
+        """A config that describes the initial PSF used
         for detection and measurement (before PSF
         determination is done).
         """
@@ -78,3 +78,43 @@ Examples of `ChoiceField` and `ConfigField` and the use of the `Config` object's
             if self.doComputeApCorr and not self.doPsf:
                 raise ValueError("Cannot compute aperture correction "
                                  "without doing PSF determination.")
+
+Examples of `~.configurableActions.ConfigurableActionField` and `~.configurableActions.ConfigurableActionStructField` making use of `~.configurableActions.ConfigurableAction`\ s in a `Config` object.
+
+.. code-block:: python
+
+    class ExampleAction(pexConfig.configurableActions.ConfigurableAction):
+        """A ConfigurableAction that performs a simple calculation"""
+
+        numerator = pexConfig.Field[float](doc="Numerator for division operation")
+        divisor = pexConfig.Field[float](doc="Divisor for division operation")
+
+        def __call__(self, **kwargs):
+            return self.numerator / self.divisor
+
+
+    class ExampleConfig(pexConfig.Config):
+        """An example Config class which contains multiple `ConfigurableAction`\ s."""
+
+        divideAction = pexConfig.configurableActions.ConfigurableActionField(
+            doc="A field which points to a single action."
+            default=ExampleAction
+        )
+
+        multipleDivisionActions = pexConfig.configurableActions.ConfigurableActionStructField(
+            doc="A field which acts as a struct, referring to multiple ConfigurableActions."
+        )
+
+        def setDefaults(self):
+            """Example of setting multiple default configurations with `ConfigurableAction`\ s.
+            """
+            self.divideAction.numerator = 1
+            self.divideAction.divisor = 2
+
+            self.multipleDivisionActions.subDivide1 = ExampleAction()
+            self.multipleDivisionActions.subDivide1.numerator = 5
+            self.multipleDivisionActions.subDivide1.divisor = 10
+
+            self.multipleDivisionActions.subDivide2 = ExampleAction()
+            self.multipleDivisionActions.subDivide2.numerator = 7
+            self.multipleDivisionActions.subDivide2.divisor = 8

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/index.rst

@@ -62,3 +62,7 @@ Python API reference
 .. automodapi:: lsst.pex.config.history
    :no-main-docstr:
    :no-inheritance-diagram:
+
+.. automodapi:: lsst.pex.config.configurableActions
+   :no-main-docstr:
+   :no-inheritance-diagram:

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/inspecting-configs.rst

@@ -8,7 +8,7 @@ Field access
 ------------
 
 Iterating through a `Config` instance yields the names of the `Field` attributes it contains.
-The `Config` class also supports many dictionary-like methods: `~Config.keys`, `~Config.items`, `~Config.iterkeys`, `~Config.iteritems`, and `~Config.itervalues`.
+The `Config` class also supports many dictionary-like methods: `~Config.keys`, `~Config.items`, and `~Config.values`.
 
 History
 -------

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/overview.rst

@@ -38,7 +38,7 @@ Here is a config class that includes five fields:
 .. code-block:: python
 
    import lsst.pex.config as pexConfig
-   
+
    class IsrTaskConfig(pexConfig.Config):
        doWrite = pexConfig.Field(
            doc="Write output?",
@@ -49,7 +49,7 @@ Here is a config class that includes five fields:
            dtype=float,
            default=1.0)
        saturatedMaskName = pexConfig.Field(
-           doc="Name of mask plane to use in saturation detection",
+           doc="Name of the mask plane to use in saturation detection.",
            dtype=str,
            default="SAT")
        flatScalingType = pexConfig.ChoiceField(
@@ -62,7 +62,7 @@ Here is a config class that includes five fields:
                "MEDIAN": "Scale by the inverse of the median",
            })
        keysToRemoveFromAssembledCcd = pexConfig.ListField(
-           doc="fields to remove from the metadata of the assembled ccd.",
+           doc="Fields to remove from the metadata of the assembled ccd.",
            dtype=str,
            default=[])
 
@@ -167,3 +167,15 @@ Alternatively, if you wish to locate another configuration file using LSST infra
    from lsst.utils import getPackageDir
 
    config.load(os.path.join(getPackageDir("product_x"), "config", "otherconfig.py"))
+
+Specialized Config subclasses
+=============================
+
+There exists a subclass of `Config` which is designed to be configurable like a standard config, but have a runtime call interface.
+These specialized subclasses are named `~.configurableActions.ConfigurableAction`\ s, or actions for short.
+These actions are not intended to replace other runtime components, but compliment them.
+They provide configuration time mechanics to a simple runtime function.
+This interface allows for both configuration of an action as well as making which action to run configurable.
+These configurations are serialized out in a standard way, and thus allow complete functional states to be completely restored.
+The selection (thus configuration) of which `~.configurableActions.ConfigurableAction`\ s to run is made possible through the use of special `Field`\ s named `~.configurableActions.ConfigurableActionField` and `~.configurableActions.ConfigurableActionStructField`.
+See :doc:`field-types` for more details and examples of both `~.configurableActions.ConfigurableAction`\ s and the corresponding fields.

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/registry-intro.rst

@@ -6,21 +6,21 @@ Registry and RegistryField for configuring subtasks
 
 Example of a `RegistryField` created from a `Registry` object and use of both the `Registry.register` method and the `registerConfigurable` decorator::
 
-    psfDeterminerRegistry = pexConfig.makeRegistry("""A registry of PSF determiner factories""")
+    psfDeterminerRegistry = pexConfig.makeRegistry("""A registry of PSF determiner factories.""")
 
     class PcaPsfDeterminerConfig(pexConfig.Config):
         spatialOrder = pexConfig.Field(
-                "spatial order for PSF kernel creation", int, 2)
+                "Spatial order for PSF kernel creation.", int, 2)
         [...]
 
     @pexConfig.registerConfigurable("pca", psfDeterminerRegistry)
     class PcaPsfDeterminer(object):
         ConfigClass = PcaPsfDeterminerConfig
-            # associate this Configurable class with its Config class for use
-            # by the registry
-        def __init__(self, config, schema=None):
+            # Associate this Configurable class with its Config class for use
+            # by the registry.
+        def __init__(self, config, schema=None, **kwargs):
             [...]
-        def determinePsf(self, exposure, psfCandidateList, metadata=None):
+        def determinePsf(self, exposure, psfCandidateList, metadata=None, **kwargs):
             [...]
 
     psfDeterminerRegistry.register("shapelet", ShapeletPsfDeterminer)

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/doc/lsst.pex.config/wrapping-cpp-control-objects.rst

@@ -4,7 +4,7 @@
 Wrapping C++ control objects
 ############################
 
-C++ control objects defined using the ``LSST_CONTROL_FIELD`` macro in `lsst/pex/config.h` can be wrapped using pybind11 and the functions in `lsst.pex.config.wrap`, creating an equivalent Python `Config` object.
+C++ control objects defined using the ``LSST_CONTROL_FIELD`` macro in ``lsst/pex/config.h`` can be wrapped using pybind11 and the functions in `lsst.pex.config.wrap`, creating an equivalent Python `Config` object.
 The `Config` will automatically create and set values in the C++ object, will provide access to the doc strings from C++, and will even call the C++ class's ``validate`` method, if one exists.
 This helps to minimize duplication of code.
 
@@ -15,7 +15,7 @@ For example, here is a C++ control object:
     struct FooControl {
         LSST_CONTROL_FIELD(bar, int, "documentation for field 'bar'");
         LSST_CONTROL_FIELD(baz, double, "documentation for field 'baz'");
-        
+
         FooControl() : bar(0), baz(0.0) {}
     };
 

lsst_pex_config-29.2025.4500/pyproject.toml

@@ -0,0 +1,196 @@
+[build-system]
+requires = ["setuptools", "lsst-versions >= 1.3.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lsst-pex-config"
+requires-python = ">=3.10.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"]
+readme = "README.rst"
+authors = [
+    {name="Rubin Observatory Data Management", email="dm-admin@lists.lsst.org"},
+]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+keywords = ["lsst"]
+dependencies = [
+    "pyyaml >=5.1",
+    "numpy >= 1.17",
+]
+dynamic = ["version"]
+
+[project.urls]
+"Homepage" = "https://github.com/lsst/pex_config"
+
+[project.optional-dependencies]
+test = [
+    "pytest >= 3.2",
+    "pytest-openfiles >= 0.5.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["python"]
+
+[tool.setuptools]
+zip-safe = true
+
+[tool.setuptools.package-data]
+"lsst.pex.config" = ["py.typed"]
+
+[tool.setuptools.dynamic]
+version = { attr = "lsst_versions.get_lsst_version" }
+
+[tool.black]
+line-length = 110
+target-version = ["py310"]
+
+[tool.isort]
+profile = "black"
+line_length = 110
+known_first_party = ["lsst"]
+
+[tool.towncrier]
+    package = "lsst.pex.config"
+    package_dir = "python"
+    filename = "doc/lsst.pex.config/CHANGES.rst"
+    directory = "doc/changes"
+    title_format = "lsst-pex-config {version} ({project_date})"
+    issue_format = "`{issue} <https://rubinobs.atlassian.net/browse/{issue}>`_"
+
+    [[tool.towncrier.type]]
+        directory = "feature"
+        name = "New Features"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "api"
+        name = "API Changes"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "bugfix"
+        name = "Bug Fixes"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "perf"
+        name = "Performance Enhancement"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "misc"
+        name = "Other Changes and Additions"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "An API Removal or Deprecation"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "doc"
+        name = "Documentation Enhancement"
+        showcontent = true
+
+[tool.lsst_versions]
+write_to = "python/lsst/pex/config/version.py"
+
+[tool.pytest.ini_options]
+
+[tool.pydocstyle]
+convention = "numpy"
+# Our coding style does not require docstrings for magic methods (D105)
+# Our docstyle documents __init__ at the class level (D107)
+# We allow methods to inherit docstrings and this is not compatible with D102.
+# Docstring at the very first line is not required
+# D200, D205 and D400 all complain if the first sentence of the docstring does
+# not fit on one line.
+add-ignore = ["D107", "D105", "D102", "D100", "D200", "D205", "D400", "D104"]
+
+[tool.ruff]
+line-length = 110
+target-version = "py310"
+exclude = [
+    "__init__.py",
+    "tests/config/*.py",
+]
+
+[tool.ruff.lint]
+ignore = [
+    "N802",
+    "N803",
+    "N806",
+    "N812",
+    "N815",
+    "N816",
+    "N999",
+    "D107",
+    "D105",
+    "D102",
+    "D104",
+    "D100",
+    "D200",
+    "D205",
+]
+select = [
+    "E",  # pycodestyle
+    "F",  # pyflakes
+    "N",  # pep8-naming
+    "W",  # pycodestyle
+    "D",  # pydocstyle
+    "UP",  # pyupgrade
+    "I",  # isort
+    "RUF022",  # sort __all__
+    "C4",  # comprehensions
+    "B",  # bugbear
+]
+extend-select = [
+    "RUF100", # Warn about unused noqa
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/testLib.py" = ["F403", "F405"]  # Wildcard imports.
+
+[tool.ruff.lint.isort]
+known-first-party = ["lsst"]
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 79
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.format]
+docstring-code-format = true
+# Formatter does not know about indenting.
+docstring-code-line-length = 69
+
+[tool.numpydoc_validation]
+checks = [
+    "all",  # All except the rules listed below.
+    "SA01",  # See Also section.
+    "EX01",  # Example section.
+    "SS06",  # Summary can go into second line.
+    "GL01",  # Summary text can start on same line as """
+    "GL08",  # Do not require docstring.
+    "ES01",  # No extended summary required.
+    "RT01",  # Unfortunately our @property trigger this.
+    "RT02",  # Does not want named return value. DM style says we do.
+    "SS05",  # pydocstyle is better at finding infinitive verb.
+    "SA04",  # Do not require descriptions on all See Also entries.
+]
+exclude = [
+    '^__init__$',
+    '\._[a-zA-Z_]+$',  # Private methods.
+    "^test_.*",  # Do not test docstrings in test code.
+]

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/python/lsst/pex/config/callStack.py

@@ -25,7 +25,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-__all__ = ["getCallerFrame", "getStackFrame", "StackFrame", "getCallStack"]
+__all__ = ["StackFrame", "getCallStack", "getCallerFrame", "getStackFrame"]
 
 import inspect
 import linecache
@@ -42,7 +42,7 @@ def getCallerFrame(relative=0):
 
     Returns
     -------
-    frame : `__builtin__.Frame`
+    frame : `types.FrameType`
         Frame for the caller.
 
     Notes
@@ -50,7 +50,7 @@ def getCallerFrame(relative=0):
     This function is excluded from the frame.
     """
     frame = inspect.currentframe().f_back.f_back  # Our caller's caller
-    for ii in range(relative):
+    for _ in range(relative):
         frame = frame.f_back
     return frame
 
@@ -97,7 +97,7 @@ class StackFrame:
     stack trace by the fact that it does not look up the source code until it
     is absolutely necessary, reducing the I/O.
 
-    See also
+    See Also
     --------
     getStackFrame
     """
@@ -127,7 +127,7 @@ class StackFrame:
 
         Parameters
         ----------
-        frame : `Frame`
+        frame : `types.FrameType`
             Frame object to interpret, such as from `inspect.currentframe`.
 
         Returns
@@ -149,7 +149,7 @@ class StackFrame:
         return cls(filename, lineno, function)
 
     def __repr__(self):
-        return "%s(%s, %s, %s)" % (self.__class__.__name__, self.filename, self.lineno, self.function)
+        return f"{self.__class__.__name__}({self.filename}, {self.lineno}, {self.function})"
 
     def format(self, full=False):
         """Format for printing.
@@ -165,9 +165,9 @@ class StackFrame:
         result : `str`
             Formatted string.
         """
-        result = "  File %s:%s (%s)" % (self.filename, self.lineno, self.function)
+        result = f"  File {self.filename}:{self.lineno} ({self.function})"
         if full:
-            result += "\n    %s" % (self.content,)
+            result += f"\n    {self.content}"
         return result
 
 

{lsst-pex-config-26.0.0a20230400 → lsst_pex_config-29.2025.4500}/python/lsst/pex/config/choiceField.py

@@ -56,7 +56,7 @@ class ChoiceField(Field[FieldTypeVar]):
         A description of why this Field is deprecated, including removal date.
         If not None, the string is appended to the docstring for this Field.
 
-    See also
+    See Also
     --------
     ConfigChoiceField
     ConfigDictField
@@ -89,10 +89,11 @@ class ChoiceField(Field[FieldTypeVar]):
         for choice, choiceDoc in self.allowed.items():
             if choice is not None and not isinstance(choice, dtype):
                 raise ValueError(
-                    "ChoiceField's allowed choice %s is of incorrect type %s. Expected %s"
-                    % (choice, _typeStr(choice), _typeStr(dtype))
+                    f"ChoiceField's allowed choice {choice} is of incorrect type "
+                    f"{_typeStr(choice)}. Expected {_typeStr(dtype)}"
                 )
-            self.__doc__ += "%s\n  %s\n" % ("``{0!r}``".format(str(choice)), choiceDoc)
+            # Force to a string so that additional quotes are added with !r
+            self.__doc__ += f"``{str(choice)!r}``\n  {choiceDoc}\n"
 
         self.source = getStackFrame()