only expose _fields to the user, so deleted Fields remain hidden

Author: chris-simpson

python/lsst/pex/config/config.py

@@ -818,6 +818,12 @@ def __set__(
         if instance._frozen:
             raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
 
+        if at is None:
+            at = getCallStack()
+        # setDefaults() gets a free pass due to our mashing of inheritance
+        if self.name not in instance._fields:
+            raise AttributeError(f"{instance.__class__.__name__} has no attribute {self.name}")
+
         history = instance._history.setdefault(self.name, [])
         if value is not None:
             value = _autocast(value, self.dtype)
@@ -1004,6 +1010,9 @@ class behavior.
     _history: dict[str, list[Any]]
     _imports: set[Any]
 
+    # Only _fields are exposure. _storage retains items that have been
+    # deleted.
+
     def __iter__(self):
         """Iterate over fields."""
         return self._fields.__iter__()
@@ -1016,7 +1025,7 @@ def keys(self):
         names : `~collections.abc.KeysView`
             List of `lsst.pex.config.Field` names.
         """
-        return self._storage.keys()
+        return list(self._fields)
 
     def values(self):
         """Get field values.
@@ -1026,7 +1035,7 @@ def values(self):
         values : `~collections.abc.ValuesView`
             Iterator of field values.
         """
-        return self._storage.values()
+        return self.toDict().values()
 
     def items(self):
         """Get configurations as ``(field name, field value)`` pairs.
@@ -1039,7 +1048,22 @@ def items(self):
             0. Field name.
             1. Field value.
         """
-        return self._storage.items()
+        return self.toDict().items()
+
+    def doc(self, field):
+        """Return docstring for field.
+
+        Parameters
+        ----------
+        field : `str`
+            Field to select.
+
+        Returns
+        -------
+        doc : `str`
+            Associated docstring.
+        """
+        return self._fields[field].doc
 
     def __contains__(self, name):
         """Return `True` if the specified field exists in this config.
@@ -1054,7 +1078,7 @@ def __contains__(self, name):
         in : `bool`
             `True` if the specified field exists in the config.
         """
-        return self._storage.__contains__(name)
+        return self._storage.__contains__(name) and name in self._fields
 
     def __new__(cls, *args, **kw):
         """Allocate a new `lsst.pex.config.Config` object.
@@ -1080,9 +1104,7 @@ def __new__(cls, *args, **kw):
         instance._history = {}
         instance._imports = set()
         # load up defaults
-        for field in instance._fields.values():
-            instance._history[field.name] = []
-            field.__set__(instance, field.default, at=at + [field.source], label="default")
+        instance.reset(at=at)
         # set custom default-overrides
         instance.setDefaults()
         # set constructor overrides
@@ -1102,6 +1124,20 @@ def __reduce__(self):
         self.saveToStream(stream)
         return (unreduceConfig, (self.__class__, stream.getvalue().encode()))
 
+    def reset(self, at=None):
+        """Reset all values to their defaults.
+
+        Parameters
+        ----------
+        at : `lists` [ `StackFrame` ] or `None`, optional
+            Location in stack.
+        """
+        if at is None:
+            at = getCallStack()
+        for field in self._fields.values():
+            self._history[field.name] = []
+            field.__set__(self, field.default, at=at + [field.source], label="default")
+
     def setDefaults(self):
         """Subclass hook for computing defaults.
 
@@ -1170,7 +1206,7 @@ def update(self, **kw):
                 field = self._fields[name]
                 field.__set__(self, value, at=at, label=label)
             except KeyError as e:
-                e.add_note(f"No field of name {name} exists in config type {_typeStr(self)}")
+                e.add_note(f"{type(self).__name__.replace('Config', '')} has no field named {name}")
                 raise
 
     def load(self, filename, root="config"):
@@ -1617,11 +1653,12 @@ def __setattr__(self, attr, value, at=None, label="assignment"):
             raise AttributeError(f"{_typeStr(self)} has no attribute {attr}")
 
     def __delattr__(self, attr, at=None, label="deletion"):
+        # CJS: Hacked to allow setDefaults() to delete non-existent fields
+        if at is None:
+            at = getCallStack()
         if attr in self._fields:
-            if at is None:
-                at = getCallStack()
-            self._fields[attr].__delete__(self, at=at, label=label)
-        else:
+            del self._fields[attr]
+        elif not any(stk.function == "setDefaults" for stk in at):
             object.__delattr__(self, attr)
 
     def __eq__(self, other):