lsst-pex-config 30.0.1rc1__tar.gz → 30.2026.300__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. {lsst_pex_config-30.0.1rc1/python/lsst_pex_config.egg-info → lsst_pex_config-30.2026.300}/PKG-INFO +1 -2
  2. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/CHANGES.rst +0 -23
  3. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/pyproject.toml +0 -1
  4. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/callStack.py +1 -1
  5. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/choiceField.py +3 -3
  6. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/comparison.py +5 -5
  7. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/config.py +25 -26
  8. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configChoiceField.py +3 -3
  9. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configDictField.py +5 -5
  10. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configField.py +6 -6
  11. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableActions/_configurableActionStructField.py +1 -1
  12. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableField.py +7 -7
  13. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/dictField.py +6 -6
  14. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/listField.py +10 -10
  15. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/rangeField.py +2 -2
  16. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/registry.py +4 -4
  17. lsst_pex_config-30.2026.300/python/lsst/pex/config/version.py +2 -0
  18. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/wrap.py +4 -4
  19. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300/python/lsst_pex_config.egg-info}/PKG-INFO +1 -2
  20. lsst_pex_config-30.0.1rc1/python/lsst/pex/config/version.py +0 -2
  21. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/COPYRIGHT +0 -0
  22. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/LICENSE +0 -0
  23. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/MANIFEST.in +0 -0
  24. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/README.rst +0 -0
  25. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/bsd_license.txt +0 -0
  26. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/design-notes.rst +0 -0
  27. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/field-types.rst +0 -0
  28. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/index.rst +0 -0
  29. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/inspecting-configs.rst +0 -0
  30. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/overview.rst +0 -0
  31. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/registry-intro.rst +0 -0
  32. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/doc/lsst.pex.config/wrapping-cpp-control-objects.rst +0 -0
  33. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/gpl-v3.0.txt +0 -0
  34. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/__init__.py +0 -0
  35. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/__init__.py +0 -0
  36. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/__init__.py +0 -0
  37. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/_doNotImportMe.py +0 -0
  38. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableActions/__init__.py +0 -0
  39. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableActions/_configurableAction.py +0 -0
  40. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableActions/_configurableActionField.py +0 -0
  41. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/configurableActions/tests.py +0 -0
  42. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/convert.py +0 -0
  43. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/history.py +0 -0
  44. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst/pex/config/py.typed +0 -0
  45. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst_pex_config.egg-info/SOURCES.txt +0 -0
  46. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst_pex_config.egg-info/dependency_links.txt +0 -0
  47. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst_pex_config.egg-info/requires.txt +0 -0
  48. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst_pex_config.egg-info/top_level.txt +0 -0
  49. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/python/lsst_pex_config.egg-info/zip-safe +0 -0
  50. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/setup.cfg +0 -0
  51. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/testLib.py +0 -0
  52. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_Config.py +0 -0
  53. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test__file__.py +0 -0
  54. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_configChoiceField.py +0 -0
  55. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_configDictField.py +0 -0
  56. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_configurableActions.py +0 -0
  57. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_configurableField.py +0 -0
  58. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_dictField.py +0 -0
  59. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_history.py +0 -0
  60. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_listField.py +0 -0
  61. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_registry.py +0 -0
  62. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket1911.py +0 -0
  63. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket1914.py +0 -0
  64. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket1915.py +0 -0
  65. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket1929.py +0 -0
  66. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket1995.py +0 -0
  67. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticket2818.py +0 -0
  68. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_ticketDM-7337.py +0 -0
  69. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_unloaded_yaml.py +0 -0
  70. {lsst_pex_config-30.0.1rc1 → lsst_pex_config-30.2026.300}/tests/test_wrap.py +0 -0
@@ -1,11 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: lsst-pex-config
3
- Version: 30.0.1rc1
3
+ Version: 30.2026.300
4
4
  Summary: A flexible configuration system using Python files.
5
5
  Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
6
6
  License-Expression: BSD-3-Clause OR GPL-3.0-or-later
7
7
  Project-URL: Homepage, https://github.com/lsst/pex_config
8
- Project-URL: Source, https://github.com/lsst/pex_config
9
8
  Keywords: lsst
10
9
  Classifier: Intended Audience :: Science/Research
11
10
  Classifier: Operating System :: OS Independent
@@ -1,26 +1,3 @@
1
- lsst-pex-config v30.0.0 (2026-01-15)
2
- ====================================
3
-
4
- Python 3.11 is now the minimum supported version.
5
- Tested on Python 3.14.
6
-
7
- New Features
8
- ------------
9
-
10
- - Added a ``copy`` method that unfreezes. (`DM-16523 <https://rubinobs.atlassian.net/browse/DM-16523>`_)
11
- - * 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.
12
- * Modified the config loader to support URI schemes ``file``, ``resource``, and ``eups`` supported by ``lsst-resources``.
13
- 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>`_)
14
-
15
-
16
- Bug Fixes
17
- ---------
18
-
19
- - 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>`_)
20
- - Fixed copying of ``ConfigDictField``. (`DM-53767 <https://rubinobs.atlassian.net/browse/DM-53767>`_)
21
- - Fixed copying of ``ConfigChoiceField`` and ``RegistryField``. (`DM-53791 <https://rubinobs.atlassian.net/browse/DM-53791>`_)
22
-
23
-
24
1
  lsst-pex-config v29.0.0 (2025-03-25)
25
2
  ====================================
26
3
 
@@ -32,7 +32,6 @@ dynamic = ["version"]
32
32
 
33
33
  [project.urls]
34
34
  "Homepage" = "https://github.com/lsst/pex_config"
35
- "Source" = "https://github.com/lsst/pex_config"
36
35
 
37
36
  [project.optional-dependencies]
38
37
  test = [
@@ -102,7 +102,7 @@ class StackFrame:
102
102
  getStackFrame
103
103
  """
104
104
 
105
- _STRIP = "/python/"
105
+ _STRIP = "/python/lsst/"
106
106
  """String to strip from the ``filename`` in the constructor."""
107
107
 
108
108
  def __init__(self, filename, lineno, function, content=None):
@@ -42,7 +42,7 @@ class ChoiceField(Field[FieldTypeVar]):
42
42
  ----------
43
43
  doc : `str`
44
44
  Documentation string that describes the configuration field.
45
- dtype : `type`
45
+ dtype : class
46
46
  The type of the field's choices. For example, `str` or `int`.
47
47
  allowed : `dict`
48
48
  The allowed values. Keys are the allowed choices (of ``dtype``-type).
@@ -52,9 +52,9 @@ class ChoiceField(Field[FieldTypeVar]):
52
52
  choices.
53
53
  optional : `bool`, optional
54
54
  If `True`, this configuration field is *optional*. Default is `True`.
55
- deprecated : `None` or `str`, optional
55
+ deprecated : None or `str`, optional
56
56
  A description of why this Field is deprecated, including removal date.
57
- If not `None`, the string is appended to the docstring for this Field.
57
+ If not None, the string is appended to the docstring for this Field.
58
58
 
59
59
  See Also
60
60
  --------
@@ -70,18 +70,18 @@ def compareScalars(name, v1, v2, output, rtol=1e-8, atol=1e-8, dtype=None):
70
70
  Name to use when reporting differences, typically created by
71
71
  `getComparisonName`. This will always appear as the beginning of any
72
72
  messages reported via ``output``.
73
- v1 : `object`
73
+ v1 : object
74
74
  Left-hand side value to compare.
75
- v2 : `object`
75
+ v2 : object
76
76
  Right-hand side value to compare.
77
- output : `collections.abc.Callable` or `None`
77
+ output : callable or `None`
78
78
  A callable that takes a string, used (possibly repeatedly) to report
79
79
  inequalities (for example, `print`). Set to `None` to disable output.
80
80
  rtol : `float`, optional
81
81
  Relative tolerance for floating point comparisons.
82
82
  atol : `float`, optional
83
83
  Absolute tolerance for floating point comparisons.
84
- dtype : `type`, optional
84
+ dtype : class, optional
85
85
  Data type of values for comparison. May be `None` if values are not
86
86
  floating-point.
87
87
 
@@ -130,7 +130,7 @@ def compareConfigs(name, c1, c2, shortcut=True, rtol=1e-8, atol=1e-8, output=Non
130
130
  Relative tolerance for floating point comparisons.
131
131
  atol : `float`, optional
132
132
  Absolute tolerance for floating point comparisons.
133
- output : `collections.abc.Callable`, optional
133
+ output : callable, optional
134
134
  A callable that takes a string, used (possibly repeatedly) to report
135
135
  inequalities. For example: `print`.
136
136
 
@@ -148,14 +148,14 @@ def _autocast(x, dtype):
148
148
 
149
149
  Parameters
150
150
  ----------
151
- x : `object`
151
+ x : object
152
152
  A value.
153
153
  dtype : type
154
154
  Data type, such as `float`, `int`, or `str`.
155
155
 
156
156
  Returns
157
157
  -------
158
- values : `object`
158
+ values : object
159
159
  If appropriate, the returned value is ``x`` cast to the given type
160
160
  ``dtype``. If the cast cannot be performed the original value of
161
161
  ``x`` is returned.
@@ -300,7 +300,7 @@ class FieldValidationError(ValueError):
300
300
 
301
301
  See also
302
302
  --------
303
- ``lsst.pex.config.Field.name``
303
+ lsst.pex.config.Field.name
304
304
  """
305
305
 
306
306
  self.fullname = _joinNamePath(config._name, field.name)
@@ -321,7 +321,7 @@ class FieldValidationError(ValueError):
321
321
  error = (
322
322
  f"{self.fieldType.__name__} '{self.fullname}' failed validation: {msg}\n"
323
323
  f"For more information see the Field definition at:\n{self.fieldSource.format()}"
324
- f" and the Config definition for {_typeStr(config)} at:\n{self.configSource.format()}"
324
+ f" and the Config definition at:\n{self.configSource.format()}"
325
325
  )
326
326
  super().__init__(error)
327
327
 
@@ -334,14 +334,14 @@ class Field(Generic[FieldTypeVar]):
334
334
  ----------
335
335
  doc : `str`
336
336
  A description of the field for users.
337
- dtype : `type`, optional
337
+ dtype : type, optional
338
338
  The field's data type. ``Field`` only supports basic data types:
339
339
  `int`, `float`, `complex`, `bool`, and `str`. See
340
340
  `Field.supportedTypes`. Optional if supplied as a typing argument to
341
341
  the class.
342
- default : `object`, optional
342
+ default : object, optional
343
343
  The field's default value.
344
- check : `collections.abc.Callable`, optional
344
+ check : callable, optional
345
345
  A callable that is called with the field's value. This callable should
346
346
  return `False` if the value is invalid. More complex inter-field
347
347
  validation can be written as part of the
@@ -350,7 +350,7 @@ class Field(Generic[FieldTypeVar]):
350
350
  This sets whether the field is considered optional, and therefore
351
351
  doesn't need to be set by the user. When `False`,
352
352
  `lsst.pex.config.Config.validate` fails if the field's value is `None`.
353
- deprecated : `None` or `str`, optional
353
+ deprecated : None or `str`, optional
354
354
  A description of why this Field is deprecated, including removal date.
355
355
  If not None, the string is appended to the docstring for this Field.
356
356
 
@@ -374,7 +374,7 @@ class Field(Generic[FieldTypeVar]):
374
374
 
375
375
  Notes
376
376
  -----
377
- `Field` instances (including those of any subclass of `Field`) are used
377
+ ``Field`` instances (including those of any subclass of ``Field``) are used
378
378
  as class attributes of `~lsst.pex.config.Config` subclasses (see the
379
379
  example, below). ``Field`` attributes work like the `property` attributes
380
380
  of classes that implement custom setters and getters. `Field` attributes
@@ -385,15 +385,15 @@ class Field(Generic[FieldTypeVar]):
385
385
  When you access a `Field` attribute on a `Config` instance, you don't
386
386
  get the `Field` instance itself. Instead, you get the value of that field,
387
387
  which might be a simple type (`int`, `float`, `str`, `bool`) or a custom
388
- container type (like a `lsst.pex.config.ListField`) depending on the
389
- field's type. See the example, below.
388
+ container type (like a `lsst.pex.config.List`) depending on the field's
389
+ type. See the example, below.
390
390
 
391
391
  Fields can be annotated with a type similar to other python classes (python
392
392
  specification `here <https://peps.python.org/pep-0484/#generics>`_ ).
393
393
  See the name field in the Config example below for an example of this.
394
394
  Unlike most other uses in python, this has an effect at type checking *and*
395
395
  runtime. If the type is specified with a class annotation, it will be used
396
- as the value of the ``dtype`` in the `Field` and there is no need to
396
+ as the value of the ``dtype`` in the ``Field`` and there is no need to
397
397
  specify it as an argument during instantiation.
398
398
 
399
399
  There are Some notes on dtype through type annotation syntax. Type
@@ -401,20 +401,19 @@ class Field(Generic[FieldTypeVar]):
401
401
  name. i.e. "float", but this cannot be used to resolve circular references.
402
402
  Type annotation syntax can be used on an identifier in addition to Class
403
403
  assignment i.e. ``variable: Field[str] = Config.someField`` vs
404
- ``someField = Field[str](doc="some doc")``. However, this syntax is only
404
+ ``someField = Field[str](doc="some doc"). However, this syntax is only
405
405
  useful for annotating the type of the identifier (i.e. variable in previous
406
- example) and does nothing for assigning the dtype of the `Field`.
406
+ example) and does nothing for assigning the dtype of the ``Field``.
407
407
 
408
408
  Examples
409
409
  --------
410
- Instances of `Field` should be used as class attributes of
410
+ Instances of ``Field`` should be used as class attributes of
411
411
  `lsst.pex.config.Config` subclasses:
412
412
 
413
413
  >>> from lsst.pex.config import Config, Field
414
414
  >>> class Example(Config):
415
415
  ... myInt = Field("An integer field.", int, default=0)
416
416
  ... name = Field[str](doc="A string Field")
417
- >>> config = Example()
418
417
  >>> print(config.myInt)
419
418
  0
420
419
  >>> config.myInt = 5
@@ -625,7 +624,7 @@ class Field(Generic[FieldTypeVar]):
625
624
 
626
625
  Parameters
627
626
  ----------
628
- value : `object`
627
+ value : object
629
628
  The value being validated.
630
629
 
631
630
  Raises
@@ -667,8 +666,8 @@ class Field(Generic[FieldTypeVar]):
667
666
 
668
667
  Parameters
669
668
  ----------
670
- outfile : `typing.IO`
671
- A writeable file handle.
669
+ outfile : file-like object
670
+ A writeable field handle.
672
671
  instance : `~lsst.pex.config.Config`
673
672
  The `~lsst.pex.config.Config` instance that contains this field.
674
673
 
@@ -709,7 +708,7 @@ class Field(Generic[FieldTypeVar]):
709
708
 
710
709
  Returns
711
710
  -------
712
- value : `object`
711
+ value : object
713
712
  The field's value. See *Notes*.
714
713
 
715
714
  Notes
@@ -868,7 +867,7 @@ class Field(Generic[FieldTypeVar]):
868
867
  Relative tolerance for floating point comparisons.
869
868
  atol : `float`, optional
870
869
  Absolute tolerance for floating point comparisons.
871
- output : `collections.abc.Callable`, optional
870
+ output : callable, optional
872
871
  A callable that takes a string, used (possibly repeatedly) to
873
872
  report inequalities.
874
873
 
@@ -1282,7 +1281,7 @@ class Config(metaclass=ConfigMeta): # type: ignore
1282
1281
 
1283
1282
  Parameters
1284
1283
  ----------
1285
- stream : `typing.IO`, `str`, `bytes`, or `~types.CodeType`
1284
+ stream : file-like object, `str`, `bytes`, or `~types.CodeType`
1286
1285
  Stream containing configuration override code. If this is a
1287
1286
  code object, it should be compiled with ``mode="exec"``.
1288
1287
  root : `str`, optional
@@ -1467,7 +1466,7 @@ class Config(metaclass=ConfigMeta): # type: ignore
1467
1466
 
1468
1467
  Parameters
1469
1468
  ----------
1470
- outfile : `typing.TextIO`
1469
+ outfile : file-like object
1471
1470
  Destination file object write the config into. Accepts strings not
1472
1471
  bytes.
1473
1472
  root : `str`, optional
@@ -1521,7 +1520,7 @@ class Config(metaclass=ConfigMeta): # type: ignore
1521
1520
 
1522
1521
  Parameters
1523
1522
  ----------
1524
- outfile : `typing.TextIO`
1523
+ outfile : file-like object
1525
1524
  Destination file object write the config into. Accepts strings not
1526
1525
  bytes.
1527
1526
  """
@@ -1756,7 +1755,7 @@ class Config(metaclass=ConfigMeta): # type: ignore
1756
1755
  Relative tolerance for floating point comparisons.
1757
1756
  atol : `float`, optional
1758
1757
  Absolute tolerance for floating point comparisons.
1759
- output : `collections.abc.Callable`, optional
1758
+ output : callable, optional
1760
1759
  A callable that takes a string, used (possibly repeatedly) to
1761
1760
  report inequalities.
1762
1761
 
@@ -1877,7 +1876,7 @@ def unreduceConfig(cls_, stream):
1877
1876
  cls_ : `lsst.pex.config.Config`-type
1878
1877
  A `lsst.pex.config.Config` type (not an instance) that is instantiated
1879
1878
  with configurations in the ``stream``.
1880
- stream : `typing.IO`, `str`, or `~types.CodeType`
1879
+ stream : file-like object, `str`, or `~types.CodeType`
1881
1880
  Stream containing configuration override code.
1882
1881
 
1883
1882
  Returns
@@ -412,9 +412,9 @@ class ConfigChoiceField(Field[ConfigInstanceDict]):
412
412
  If `False`, the field allows only a single selection. In this case,
413
413
  set the active config by assigning the config's key from the
414
414
  ``typemap`` to the field's ``name`` attribute (see *Examples*).
415
- deprecated : `None` or `str`, optional
415
+ deprecated : None or `str`, optional
416
416
  A description of why this Field is deprecated, including removal date.
417
- If not `None`, the string is appended to the docstring for this Field.
417
+ If not None, the string is appended to the docstring for this Field.
418
418
 
419
419
  See Also
420
420
  --------
@@ -650,7 +650,7 @@ class ConfigChoiceField(Field[ConfigInstanceDict]):
650
650
  Relative tolerance for floating point comparisons.
651
651
  atol : `float`
652
652
  Absolute tolerance for floating point comparisons.
653
- output : `collections.abc.Callable`
653
+ output : callable
654
654
  A callable that takes a string, used (possibly repeatedly) to
655
655
  report inequalities.
656
656
 
@@ -148,7 +148,7 @@ class ConfigDictField(DictField):
148
148
  itemtype : `lsst.pex.config.Config`-type
149
149
  The type of the values in the mapping. This must be
150
150
  `~lsst.pex.config.Config` or a subclass.
151
- default : `typing.Any`, optional
151
+ default : optional
152
152
  Unknown.
153
153
  default : ``itemtype``-dtype, optional
154
154
  Default value of this field.
@@ -161,9 +161,9 @@ class ConfigDictField(DictField):
161
161
  Callable to check a key.
162
162
  itemCheck : `~collections.abc.Callable` or `None`, optional
163
163
  Callable to check an item.
164
- deprecated : `None` or `str`, optional
164
+ deprecated : None or `str`, optional
165
165
  A description of why this Field is deprecated, including removal date.
166
- If not `None`, the string is appended to the docstring for this Field.
166
+ If not None, the string is appended to the docstring for this Field.
167
167
 
168
168
  Raises
169
169
  ------
@@ -171,7 +171,7 @@ class ConfigDictField(DictField):
171
171
  Raised if the inputs are invalid:
172
172
 
173
173
  - ``keytype`` or ``itemtype`` arguments are not supported types
174
- (members of `Field.supportedTypes`.
174
+ (members of `ConfigDictField.supportedTypes`.
175
175
  - ``dictCheck``, ``keyCheck`` or ``itemCheck`` is not a callable
176
176
  function.
177
177
 
@@ -326,7 +326,7 @@ class ConfigDictField(DictField):
326
326
  Relative tolerance for floating point comparisons.
327
327
  atol : `float`
328
328
  Absolute tolerance for floating point comparisons.
329
- output : `collections.abc.Callable`
329
+ output : callable
330
330
  A callable that takes a string, used (possibly repeatedly) to
331
331
  report inequalities.
332
332
 
@@ -52,12 +52,12 @@ class ConfigField(Field[FieldTypeVar]):
52
52
  considered equivalent to assigning a default-constructed sub-config.
53
53
  This means that the argument default can be ``dtype``, as well as an
54
54
  instance of ``dtype``.
55
- check : `collections.abc.Callable`, optional
55
+ check : callable, optional
56
56
  A callback function that validates the field's value, returning `True`
57
57
  if the value is valid, and `False` otherwise.
58
- deprecated : `None` or `str`, optional
58
+ deprecated : None or `str`, optional
59
59
  A description of why this Field is deprecated, including removal date.
60
- If not `None`, the string is appended to the docstring for this Field.
60
+ If not None, the string is appended to the docstring for this Field.
61
61
 
62
62
  See Also
63
63
  --------
@@ -178,7 +178,7 @@ class ConfigField(Field[FieldTypeVar]):
178
178
 
179
179
  Parameters
180
180
  ----------
181
- outfile : `typing.IO`
181
+ outfile : file-like object
182
182
  A writeable field handle.
183
183
  instance : `~lsst.pex.config.Config`
184
184
  The `~lsst.pex.config.Config` instance that contains this field.
@@ -226,7 +226,7 @@ class ConfigField(Field[FieldTypeVar]):
226
226
 
227
227
  Returns
228
228
  -------
229
- value : `object`
229
+ value : object
230
230
  The field's value. See *Notes*.
231
231
 
232
232
  Notes
@@ -299,7 +299,7 @@ class ConfigField(Field[FieldTypeVar]):
299
299
  Relative tolerance for floating point comparisons.
300
300
  atol : `float`
301
301
  Absolute tolerance for floating point comparisons.
302
- output : `collections.abc.Callable`
302
+ output : callable
303
303
  A callable that takes a string, used (possibly repeatedly) to
304
304
  report inequalities.
305
305
 
@@ -446,7 +446,7 @@ class ConfigurableActionStructField(Field[ActionTypeVar]):
446
446
  Relative tolerance for floating point comparisons.
447
447
  atol : `float`
448
448
  Absolute tolerance for floating point comparisons.
449
- output : `collections.abc.Callable`
449
+ output : callable
450
450
  A callable that takes a string, used (possibly repeatedly) to
451
451
  report inequalities.
452
452
 
@@ -247,7 +247,7 @@ class ConfigurableField(Field[ConfigurableInstance[FieldTypeVar]]):
247
247
  ----------
248
248
  doc : `str`
249
249
  A description of the configuration field.
250
- target : `lsst.pipe.base.Task` or other configurable class
250
+ target : configurable class
251
251
  The configurable target. Configurables have a ``ConfigClass``
252
252
  attribute. Within the task framework, configurables are
253
253
  `lsst.pipe.base.Task` subclasses).
@@ -255,16 +255,16 @@ class ConfigurableField(Field[ConfigurableInstance[FieldTypeVar]]):
255
255
  The subclass of `lsst.pex.config.Config` expected as the configuration
256
256
  class of the ``target``. If ``ConfigClass`` is unset then
257
257
  ``target.ConfigClass`` is used.
258
- default : `type`, optional
258
+ default : ``ConfigClass``-type, optional
259
259
  The default configuration class. Normally this parameter is not set,
260
260
  and defaults to ``ConfigClass`` (or ``target.ConfigClass``).
261
- check : `collections.abc.Callable`, optional
261
+ check : callable, optional
262
262
  Callable that takes the field's value (the ``target``) as its only
263
263
  positional argument, and returns `True` if the ``target`` is valid (and
264
264
  `False` otherwise).
265
- deprecated : `None` or `str`, optional
265
+ deprecated : None or `str`, optional
266
266
  A description of why this Field is deprecated, including removal date.
267
- If not `None`, the string is appended to the docstring for this Field.
267
+ If not None, the string is appended to the docstring for this Field.
268
268
 
269
269
  See Also
270
270
  --------
@@ -289,7 +289,7 @@ class ConfigurableField(Field[ConfigurableInstance[FieldTypeVar]]):
289
289
 
290
290
  Parameters
291
291
  ----------
292
- target : `type`
292
+ target : configurable class
293
293
  The configurable being verified.
294
294
  ConfigClass : `lsst.pex.config.Config`-type or `None`
295
295
  The configuration class associated with the ``target``. This can
@@ -486,7 +486,7 @@ class ConfigurableField(Field[ConfigurableInstance[FieldTypeVar]]):
486
486
  Relative tolerance for floating point comparisons.
487
487
  atol : `float`
488
488
  Absolute tolerance for floating point comparisons.
489
- output : `collections.abc.Callable`
489
+ output : callable
490
490
  A callable that takes a string, used (possibly repeatedly) to
491
491
  report inequalities. For example: `print`.
492
492
 
@@ -229,15 +229,15 @@ class DictField(Field[Dict[KeyTypeVar, ItemTypeVar]], Generic[KeyTypeVar, ItemTy
229
229
  The default mapping.
230
230
  optional : `bool`, optional
231
231
  If `True`, the field doesn't need to have a set value.
232
- dictCheck : `collections.abc.Callable`
232
+ dictCheck : callable
233
233
  A function that validates the dictionary as a whole.
234
- keyCheck : `collections.abc.Callable`
234
+ keyCheck : callable
235
235
  A function that validates individual mapping keys.
236
- itemCheck : `collections.abc.Callable`
236
+ itemCheck : callable
237
237
  A function that validates individual mapping values.
238
- deprecated : `None` or `str`, optional
238
+ deprecated : None or `str`, optional
239
239
  A description of why this Field is deprecated, including removal date.
240
- If not `None`, the string is appended to the docstring for this Field.
240
+ If not None, the string is appended to the docstring for this Field.
241
241
 
242
242
  See Also
243
243
  --------
@@ -439,7 +439,7 @@ class DictField(Field[Dict[KeyTypeVar, ItemTypeVar]], Generic[KeyTypeVar, ItemTy
439
439
  Relative tolerance for floating point comparisons.
440
440
  atol : `float`
441
441
  Absolute tolerance for floating point comparisons.
442
- output : `collections.abc.Callable`
442
+ output : callable
443
443
  A callable that takes a string, used (possibly repeatedly) to
444
444
  report inequalities.
445
445
 
@@ -57,7 +57,7 @@ class List(collections.abc.MutableSequence[FieldTypeVar]):
57
57
  Config instance that contains the ``field``.
58
58
  field : `ListField`
59
59
  Instance of the `ListField` using this ``List``.
60
- value : `collections.abc.Sequence`
60
+ value : sequence
61
61
  Sequence of values that are inserted into this ``List``.
62
62
  at : `list` of `~lsst.pex.config.callStack.StackFrame`
63
63
  The call stack (created by `lsst.pex.config.callStack.getCallStack`).
@@ -114,7 +114,7 @@ class List(collections.abc.MutableSequence[FieldTypeVar]):
114
114
  ----------
115
115
  i : `int`
116
116
  Index of the item in the `list`.
117
- x : `object`
117
+ x : object
118
118
  Item in the `list`.
119
119
 
120
120
  Raises
@@ -215,7 +215,7 @@ class List(collections.abc.MutableSequence[FieldTypeVar]):
215
215
  ----------
216
216
  i : `int`
217
217
  Index where the item is inserted.
218
- x : `object`
218
+ x : object
219
219
  Item that is inserted.
220
220
  at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`,\
221
221
  optional
@@ -283,18 +283,18 @@ class ListField(Field[List[FieldTypeVar]], Generic[FieldTypeVar]):
283
283
  ----------
284
284
  doc : `str`
285
285
  A description of the field.
286
- dtype : `type`, optional
286
+ dtype : class, optional
287
287
  The data type of items in the list. Optional if supplied as typing
288
288
  argument to the class.
289
- default : `collections.abc.Sequence`, optional
289
+ default : sequence, optional
290
290
  The default items for the field.
291
291
  optional : `bool`, optional
292
292
  Set whether the field is *optional*. When `False`,
293
293
  `lsst.pex.config.Config.validate` will fail if the field's value is
294
294
  `None`.
295
- listCheck : `collections.abc.Callable`, optional
295
+ listCheck : callable, optional
296
296
  A callable that validates the list as a whole.
297
- itemCheck : `collections.abc.Callable`, optional
297
+ itemCheck : callable, optional
298
298
  A callable that validates individual items in the list.
299
299
  length : `int`, optional
300
300
  If set, this field must contain exactly ``length`` number of items.
@@ -304,9 +304,9 @@ class ListField(Field[List[FieldTypeVar]], Generic[FieldTypeVar]):
304
304
  maxLength : `int`, optional
305
305
  If set, this field must contain *no more than* ``maxLength`` number of
306
306
  items.
307
- deprecated : `None` or `str`, optional
307
+ deprecated : None or `str`, optional
308
308
  A description of why this Field is deprecated, including removal date.
309
- If not `None`, the string is appended to the docstring for this Field.
309
+ If not None, the string is appended to the docstring for this Field.
310
310
 
311
311
  See Also
312
312
  --------
@@ -503,7 +503,7 @@ class ListField(Field[List[FieldTypeVar]], Generic[FieldTypeVar]):
503
503
  Relative tolerance for floating point comparisons.
504
504
  atol : `float`
505
505
  Absolute tolerance for floating point comparisons.
506
- output : `collections.abc.Callable`
506
+ output : callable
507
507
  If not None, a callable that takes a `str`, used (possibly
508
508
  repeatedly) to report inequalities.
509
509
 
@@ -56,9 +56,9 @@ class RangeField(Field):
56
56
  If `True`, the ``min`` value is included in the allowed range.
57
57
  inclusiveMax : `bool`, optional
58
58
  If `True`, the ``max`` value is included in the allowed range.
59
- deprecated : `None` or `str`, optional
59
+ deprecated : None or `str`, optional
60
60
  A description of why this Field is deprecated, including removal date.
61
- If not `None`, the string is appended to the docstring for this Field.
61
+ If not None, the string is appended to the docstring for this Field.
62
62
 
63
63
  See Also
64
64
  --------
@@ -42,7 +42,7 @@ class ConfigurableWrapper:
42
42
 
43
43
  Parameters
44
44
  ----------
45
- target : `lsst.pipe.base.Task` or other configurable class
45
+ target : configurable class
46
46
  Target class.
47
47
  ConfigClass : `type`
48
48
  Config class.
@@ -135,7 +135,7 @@ class Registry(collections.abc.Mapping):
135
135
  Name that the ``target`` is registered under. The target can
136
136
  be accessed later with `dict`-like patterns using ``name`` as
137
137
  the key.
138
- target : `lsst.pipe.base.Task` or other configurable type
138
+ target : obj
139
139
  A configurable type, usually a subclass of `lsst.pipe.base.Task`.
140
140
  ConfigClass : `lsst.pex.config.Config`-type, optional
141
141
  A subclass of `lsst.pex.config.Config` used to configure the
@@ -188,7 +188,7 @@ class Registry(collections.abc.Mapping):
188
188
  ----------
189
189
  doc : `str`
190
190
  A description of the field.
191
- default : `object`, optional
191
+ default : object, optional
192
192
  The default target for the field.
193
193
  optional : `bool`, optional
194
194
  When `False`, `lsst.pex.config.Config.validate` fails if the
@@ -456,7 +456,7 @@ def registerConfig(name, registry, target):
456
456
  Name of the ``target`` in the ``registry``.
457
457
  registry : `Registry`
458
458
  The registry containing the ``target``.
459
- target : `lsst.pipe.base.Task` or other configurable type
459
+ target : obj
460
460
  A configurable type, such as a subclass of `lsst.pipe.base.Task`.
461
461
 
462
462
  See Also
@@ -0,0 +1,2 @@
1
+ __all__ = ["__version__"]
2
+ __version__ = "30.2026.300"
@@ -61,7 +61,7 @@ def makeConfigClass(ctrl, name=None, base=Config, doc=None, module=None, cls=Non
61
61
 
62
62
  Parameters
63
63
  ----------
64
- ctrl : `type`
64
+ ctrl : class
65
65
  C++ control class to wrap.
66
66
  name : `str`, optional
67
67
  Name of the new config class; defaults to the ``__name__`` of the
@@ -70,7 +70,7 @@ def makeConfigClass(ctrl, name=None, base=Config, doc=None, module=None, cls=Non
70
70
  Base class for the config class.
71
71
  doc : `str`, optional
72
72
  Docstring for the config class.
73
- module : `object`, `str`, `int`, or `None` optional
73
+ module : object, `str`, `int`, or `None` optional
74
74
  Either a module object, a string specifying the name of the module, or
75
75
  an integer specifying how far back in the stack to look for the module
76
76
  to use: 0 is the immediate caller of `~lsst.pex.config.wrap`. This will
@@ -78,7 +78,7 @@ def makeConfigClass(ctrl, name=None, base=Config, doc=None, module=None, cls=Non
78
78
  will also be added to the module. Ignored if `None` or if ``cls`` is
79
79
  not `None`. Defaults to None in which case module is looked up from the
80
80
  module of ctrl.
81
- cls : `type` [`lsst.pex.config.Config`]
81
+ cls : class
82
82
  An existing config class to use instead of creating a new one; name,
83
83
  base doc, and module will be ignored if this is not `None`.
84
84
 
@@ -316,7 +316,7 @@ def wrap(ctrl):
316
316
 
317
317
  Parameters
318
318
  ----------
319
- ctrl : `object`
319
+ ctrl : object
320
320
  The C++ control class.
321
321
 
322
322
  Notes
@@ -1,11 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: lsst-pex-config
3
- Version: 30.0.1rc1
3
+ Version: 30.2026.300
4
4
  Summary: A flexible configuration system using Python files.
5
5
  Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
6
6
  License-Expression: BSD-3-Clause OR GPL-3.0-or-later
7
7
  Project-URL: Homepage, https://github.com/lsst/pex_config
8
- Project-URL: Source, https://github.com/lsst/pex_config
9
8
  Keywords: lsst
10
9
  Classifier: Intended Audience :: Science/Research
11
10
  Classifier: Operating System :: OS Independent
@@ -1,2 +0,0 @@
1
- __all__ = ["__version__"]
2
- __version__ = "30.0.1rc1"