Merge pull request #77 from lsst/tickets/DM-32759

DM-32759: Remove support for the old "root" in config files

python/lsst/pex/config/config.py

@@ -997,11 +997,6 @@ def load(self, filename, root="config"):
 
             Then this config's field ``myField`` is set to ``5``.
 
-            **Deprecated:** For backwards compatibility, older config files
-            that use ``root="root"`` instead of ``root="config"`` will be
-            loaded with a warning printed to `sys.stderr`. This feature will be
-            removed at some point.
-
         See also
         --------
         lsst.pex.config.Config.loadFromStream
@@ -1033,11 +1028,6 @@ def loadFromStream(self, stream, root="config", filename=None):
                 config.myField = 5
 
             Then this config's field ``myField`` is set to ``5``.
-
-            **Deprecated:** For backwards compatibility, older config files
-            that use ``root="root"`` instead of ``root="config"`` will be
-            loaded with a warning printed to `sys.stderr`. This feature will be
-            removed at some point.
         filename : `str`, optional
             Name of the configuration file, or `None` if unknown or contained
             in the stream. Used for error reporting.
@@ -1082,11 +1072,6 @@ def loadFromString(self, code, root="config", filename=None):
                 config.myField = 5
 
             Then this config's field ``myField`` is set to ``5``.
-
-            **Deprecated:** For backwards compatibility, older config files
-            that use ``root="root"`` instead of ``root="config"`` will be
-            loaded with a warning printed to `sys.stderr`. This feature will be
-            removed at some point.
         filename : `str`, optional
             Name of the configuration file, or `None` if unknown or contained
             in the stream. Used for error reporting.
@@ -1105,20 +1090,8 @@ def loadFromString(self, code, root="config", filename=None):
             filename = getattr(code, "co_filename", "?")
         with RecordingImporter() as importer:
             globals = {"__file__": filename}
-            try:
-                local = {root: self}
-                exec(code, globals, local)
-            except NameError as e:
-                if root == "config" and "root" in e.args[0]:
-                    print(
-                        f"Config override file {filename!r}"
-                        " appears to use 'root' instead of 'config'; trying with 'root'",
-                        file=sys.stderr,
-                    )
-                    local = {"root": self}
-                    exec(code, globals, local)
-                else:
-                    raise
+            local = {root: self}
+            exec(code, globals, local)
 
         self._imports.update(importer.getModules())
 

tests/test_Config.py

@@ -308,12 +308,13 @@ def testSave(self):
         self.assertEqual(self.comp.r.name, roundTrip.r.name)
         del roundTrip
 
-        # test backwards compatibility feature of allowing "root" instead of
-        # "config"
+        # Test an override of the default variable name.
         with open("roundtrip.test", "w") as outfile:
             self.comp.saveToStream(outfile, root="root")
         roundTrip = Complex()
-        roundTrip.load("roundtrip.test")
+        with self.assertRaises(NameError):
+            roundTrip.load("roundtrip.test")
+        roundTrip.load("roundtrip.test", root="root")
         os.remove("roundtrip.test")
         self.assertEqual(self.comp.c.f, roundTrip.c.f)
         self.assertEqual(self.comp.r.name, roundTrip.r.name)