Add predicate argument to loader function

Daniel Holth · djc · commit 835c5f1872e4 · 2016-05-05T22:25:29.000+02:00
diff --git a/couchdb/loader.py b/couchdb/loader.py
@@ -67,12 +67,16 @@
 import codecs
 import json
 
-def load_design_doc(directory, strip=False):
+def load_design_doc(directory, strip=False, predicate=lambda x: True):
     """
     Load a design document from the filesystem.
 
     strip: remove leading and trailing whitespace from file contents,
         like couchdbkit.
+
+    predicate: function that is passed the full path to each file or directory.
+        Each entry is only added to the document if predicate returns True.
+        Can be used to ignore backup files etc.
     """
     objects = {}
 
@@ -87,6 +91,7 @@ def load_design_doc(directory, strip=False):
         for name in filenames:
             fkey = os.path.splitext(name)[0]
             fullname = os.path.join(dirpath, name)
+            if not predicate(fullname): continue
             with codecs.open(fullname, 'r', 'utf-8') as f:
                 contents = f.read()
                 if name.endswith('.json'):
@@ -98,7 +103,9 @@ def load_design_doc(directory, strip=False):
         for name in dirnames:
             if name == '_attachments':
                 raise NotImplementedError("_attachments are not supported")
-            subkey, subthing = objects[os.path.join(dirpath, name)]
+            fullpath = os.path.join(dirpath, name)
+            if not predicate(fullpath): continue
+            subkey, subthing = objects[fullpath]
             ob[subkey] = subthing
 
     return ob
diff --git a/couchdb/tests/loader.py b/couchdb/tests/loader.py
@@ -22,7 +22,10 @@ class LoaderTestCase(unittest.TestCase):
 
     def test_loader(self):
         directory = os.path.join(os.path.dirname(__file__), '_loader')
-        doc = loader.load_design_doc(directory, strip=True)
+        doc = loader.load_design_doc(directory,
+                                     strip=True,
+                                     predicate=lambda x: \
+                                        not x.endswith('.xml'))
         self.assertEqual(doc, expected)
 
     def test_bad_directory(self):
