X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Ftag.py;h=50e3686b6580d65369ac3178d988d90c1837d932;hb=e92b438f46a3ad7103299b1c62747f36d9de06bf;hp=cf1152a1e5747bc46ed0c3089fb6d60f1f973da4;hpb=8cbb5114a20c1217f23977fd5edca99a0b7a2955;p=notmuch diff --git a/bindings/python/notmuch/tag.py b/bindings/python/notmuch/tag.py index cf1152a1..50e3686b 100644 --- a/bindings/python/notmuch/tag.py +++ b/bindings/python/notmuch/tag.py @@ -19,19 +19,21 @@ Copyright 2010 Sebastian Spaeth ' 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. Do - note that the underlying library only provides a one-time iterator - (it cannot reset the iterator to the start). Thus iterating over - the function will "exhaust" the list of tags, and a subsequent + This object provides an iterator over a list of notmuch tags (which + 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 + over the function will "exhaust" the list of tags, and a subsequent iteration attempt will raise a :exc:`NotmuchError` 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:: @@ -60,7 +62,7 @@ class Tags(object): 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. @@ -68,12 +70,12 @@ class Tags(object): 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 @@ -81,33 +83,23 @@ class Tags(object): def next(self): if self._tags is None: raise NotmuchError(STATUS.NOT_INITIALIZED) - if not nmlib.notmuch_tags_valid(self._tags): self._tags = None raise StopIteration - - tag = Tags._get (self._tags) + tag = Tags._get(self._tags).decode('UTF-8') nmlib.notmuch_tags_move_to_next(self._tags) return tag - def __len__(self): - """len(:class:`Tags`) returns the number of contained tags + def __nonzero__(self): + """Implement bool(Tags) check that can be repeatedly used - .. 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) + If __nonzero__ is not implemented, "if Tags()" + will implicitly call __len__, using up our iterator, so it is + important that this function is defined. - i=0 - while nmlib.notmuch_tags_valid(self._msgs): - nmlib.notmuch_tags_move_to_next(self._msgs) - i += 1 - self._tags = None - return i + :returns: True if the Tags() iterator has at least one more Tag + left.""" + return nmlib.notmuch_tags_valid(self._tags) > 0 def __str__(self): """The str() representation of Tags() is a space separated list of tags @@ -123,4 +115,4 @@ class Tags(object): 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)