from ctypes import c_char_p
from notmuch.globals import nmlib, STATUS, NotmuchError
-#------------------------------------------------------------------------------
+
class Tags(object):
"""Represents a list of notmuch tags
This object provides an iterator over a list of notmuch tags (which
- are unicode instances).
+ are unicode instances).
Do note that the underlying library only provides a one-time
iterator (it cannot reset the iterator to the start). Thus iterating
STATUS.NOT_INITIALIZED. Also note, that any function that uses
iteration (nearly all) will also exhaust the tags. So both::
- for tag in tags: print tag
+ for tag in tags: print tag
as well as::
valid, we will raise an :exc:`NotmuchError`
(STATUS.NULL_POINTER) if it is `None`.
:type tags_p: :class:`ctypes.c_void_p`
- :param parent: The parent object (ie :class:`Database` or
+ :param parent: The parent object (ie :class:`Database` or
:class:`Message` 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.
cache the tags in the Python object(?)
"""
if tags_p is None:
- NotmuchError(STATUS.NULL_POINTER)
+ raise NotmuchError(STATUS.NULL_POINTER)
self._tags = tags_p
#save reference to parent object so we keep it alive
self._parent = parent
-
+
def __iter__(self):
""" Make Tags an iterator """
return self
def next(self):
if self._tags is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
- # No need to call nmlib.notmuch_tags_valid(self._tags);
- # Tags._get safely returns None, if there is no more valid tag.
- tag = Tags._get(self._tags).decode('utf-8')
- if tag is None:
+ if not nmlib.notmuch_tags_valid(self._tags):
self._tags = None
raise StopIteration
+ tag = Tags._get(self._tags).decode('UTF-8')
nmlib.notmuch_tags_move_to_next(self._tags)
return tag
left."""
return nmlib.notmuch_tags_valid(self._tags) > 0
- def __len__(self):
- """len(:class:`Tags`) returns the number of contained tags
-
- .. note:: As this iterates over the tags, we will not be able
- to iterate over them again (as in retrieve them)! If
- the tags have been exhausted already, this will raise a
- :exc:`NotmuchError` STATUS.NOT_INITIALIZED on
- subsequent attempts.
- """
- if self._tags is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
-
- i=0
- while nmlib.notmuch_tags_valid(self._msgs):
- nmlib.notmuch_tags_move_to_next(self._msgs)
- i += 1
- self._tags = None
- return i
-
def __str__(self):
"""The str() representation of Tags() is a space separated list of tags
def __del__(self):
"""Close and free the notmuch tags"""
if self._tags is not None:
- nmlib.notmuch_tags_destroy (self._tags)
+ nmlib.notmuch_tags_destroy(self._tags)