Added Config.names() to return all names in a config (recursively)

python/lsst/pex/config/config.py

@@ -26,8 +26,9 @@
 from past.builtins import basestring
 from past.builtins import unicode
 
-import os
 import io
+import os
+import re
 import sys
 import math
 import copy
@@ -237,7 +238,7 @@ def _validateValue(self, value):
 
         This is called from __set__
         This is not part of the Field API. However, simple derived field types
-            may benifit from implementing _validateValue
+            may benefit from implementing _validateValue
         """
         if value is None:
             return
@@ -660,6 +661,31 @@ def toDict(self):
             dict_[name] = field.toDict(self)
         return dict_
 
+    def names(self):
+        """!Return all the keys in a config recursively
+        """
+        #
+        # Rather than sort out the recursion all over again use the
+        # pre-existing saveToStream()
+        #
+        with io.StringIO() as strFd:
+            self.saveToStream(strFd, "config")
+            contents = strFd.getvalue()
+            strFd.close()
+        #
+        # Pull the names out of the dumped config
+        #
+        keys = []
+        for line in contents.split("\n"):
+            if re.search(r"^((assert|import)\s+|\s*$|#)", line):
+                continue
+
+            mat = re.search(r"^(?:config\.)?([^=]+)\s*=\s*.*", line)
+            if mat:
+                keys.append(mat.group(1))
+
+        return keys
+
     def _rename(self, name):
         """!Rename this Config object in its parent config
 

tests/test_Config.py

@@ -418,6 +418,18 @@ def testLoadError(self):
         self.assertRaises(SyntaxError, self.simple.loadFromStream, "bork bork bork")
         self.assertRaises(NameError, self.simple.loadFromStream, "config.f = bork")
 
+    def testNames(self):
+        """Check that the names() method returns valid keys
+
+        Also check that we have the right number of keys, and as they are
+        all known to be valid we know that we got them all
+        """
+
+        names = self.simple.names()
+        self.assertEqual(len(names), 8)
+        for name in names:
+            self.assertTrue(hasattr(self.simple, name))
+
 
 class TestMemory(lsst.utils.tests.MemoryTestCase):
     pass