From: Sebastian Spaeth <sebastian@sspaeth.de>
Date: Mon, 15 Mar 2010 15:00:11 +0000 (+0100)
Subject: Tags: clarify documentation: we can only iterate once over Tags, and free underlying... 
X-Git-Tag: 0.3~121^2~103
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=632762cd1af790875c69e8dad4c2221af4b80663

Tags: clarify documentation: we can only iterate once over Tags, and free underlying tags once we iterated through.

--HG--
extra : transplant_source : %0BI%C9%899k%80%8C4j%07%85%038%86%04%2A%FE%A6%A3
---

diff --git a/cnotmuch/database.py b/cnotmuch/database.py
index f3082e9a..2df3b4cb 100644
--- a/cnotmuch/database.py
+++ b/cnotmuch/database.py
@@ -123,7 +123,14 @@ class Tags(object):
     def __init__(self, tags_p, db=None):
         """ Is passed the db these tags are derived from, and saves a
         reference to it, so we can automatically delete the db object
-        once all derived objects are dead."""
+        once all derived objects are dead.
+
+        Tags() provides an iterator over all contained tags. However, you will
+        only be able to iterate over the Tags once, because the underlying C
+        function only allows iterating once.
+        #TODO: make the iterator work more than once and cache the tags in 
+               the Python object.
+        """
         self._tags = tags_p
         self._db = db
         print "inited tags with %d %s" %(tags_p, str(db))
@@ -137,6 +144,8 @@ class Tags(object):
             raise StopIteration
         nmlib.notmuch_tags_move_to_next(self._tags)
         if not nmlib.notmuch_tags_valid(self._tags):
+            print("Freeing the Tags now")
+            nmlib.notmuch_tags_destroy (self._tags)
             raise StopIteration
         return Tags._get (self._tags)