Add Database.revisions() method to iterate over document revisions (issue 99).

djc · djc · commit 0bc3d9ad99d1 · 2009-12-12T11:20:09.000+01:00
Thanks go to Kirk Strauser for the initial patch.
diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -16,6 +16,7 @@ http://couchdb-python.googlecode.com/hg/?r=default
    slower) `count()` method (issue 91).
  * `schema.ListField` objects now have correct behavior for slicing operations
    and the `pop()` method (issue 92).
+ * Added a `revisions()` method to the Database class (issue 99).
 
 
 Version 0.6
diff --git a/couchdb/client.py b/couchdb/client.py
@@ -479,6 +479,26 @@ def get(self, id, default=None, **options):
         else:
             return Document(data)
 
+    def revisions(self, id, **options):
+        """Return all available revisions of the given document.
+
+        :param id: the document ID
+        :return: an iterator over Document objects, each a different revision,
+                 in reverse chronological order, if any were found
+        """
+        try:
+            resp, data = self.resource.get(id, revs=True)
+        except ResourceNotFound:
+            return
+
+        startrev = data['_revisions']['start']
+        for index, rev in enumerate(data['_revisions']['ids']):
+            options['rev'] = '%d-%s' % (startrev - index, rev)
+            revision = self.get(id, **options)
+            if revision is None:
+                return
+            yield revision
+
     def info(self):
         """Return information about the database as a dictionary.
 
diff --git a/couchdb/tests/client.py b/couchdb/tests/client.py
@@ -131,6 +131,10 @@ def test_doc_revs(self):
         old_doc = self.db.get('foo', rev=old_rev)
         self.assertEqual(old_rev, old_doc['_rev'])
 
+        revs = [i for i in self.db.revisions('foo')]
+        self.assertEqual(revs[0]['_rev'], new_rev)
+        self.assertEqual(revs[1]['_rev'], old_rev)
+
         self.assertTrue(self.db.compact())
         while self.db.info()['compact_running']:
             pass
