X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=bindings%2Fpython%2Fnotmuch%2Ftag.py;h=d2dc498ca589b9622ba31c7c7c7dd372653660bb;hb=bf6039e34eca52ccf7fe1db51e1b5c843a9828f3;hp=0f25b0f74d056904a82c09b4f783e0551e88f897;hpb=f10ec87cc3ed9cbdb4e535ee6574c2a568c38b1d;p=notmuch
diff --git a/bindings/python/notmuch/tag.py b/bindings/python/notmuch/tag.py
index 0f25b0f7..d2dc498c 100644
--- a/bindings/python/notmuch/tag.py
+++ b/bindings/python/notmuch/tag.py
@@ -17,10 +17,10 @@ along with notmuch. If not, see .
Copyright 2010 Sebastian Spaeth '
"""
from ctypes import c_char_p
-from notmuch.globals import nmlib, STATUS, NotmuchError
+from notmuch.globals import nmlib, STATUS, NotmuchError, NotmuchTagsP, Python3StringMixIn
-class Tags(object):
+class Tags(Python3StringMixIn):
"""Represents a list of notmuch tags
This object provides an iterator over a list of notmuch tags (which
@@ -50,6 +50,7 @@ class Tags(object):
#notmuch_tags_get
_get = nmlib.notmuch_tags_get
+ _get.argtypes = [NotmuchTagsP]
_get.restype = c_char_p
def __init__(self, tags_p, parent=None):
@@ -69,8 +70,8 @@ class Tags(object):
:TODO: Make the iterator optionally work more than once by
cache the tags in the Python object(?)
"""
- if tags_p is None:
- NotmuchError(STATUS.NULL_POINTER)
+ if not tags_p:
+ raise NotmuchError(STATUS.NULL_POINTER)
self._tags = tags_p
#save reference to parent object so we keep it alive
@@ -80,15 +81,24 @@ class Tags(object):
""" Make Tags an iterator """
return self
- def next(self):
+ _valid = nmlib.notmuch_tags_valid
+ _valid.argtypes = [NotmuchTagsP]
+ _valid.restype = bool
+
+ _move_to_next = nmlib.notmuch_tags_move_to_next
+ _move_to_next.argtypes = [NotmuchTagsP]
+ _move_to_next.restype = None
+
+ def __next__(self):
if self._tags is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
- if not nmlib.notmuch_tags_valid(self._tags):
+ if not self._valid(self._tags):
self._tags = None
raise StopIteration
tag = Tags._get(self._tags).decode('UTF-8')
- nmlib.notmuch_tags_move_to_next(self._tags)
+ self._move_to_next(self._tags)
return tag
+ next = __next__ # python2.x iterator protocol compatibility
def __nonzero__(self):
"""Implement bool(Tags) check that can be repeatedly used
@@ -99,20 +109,25 @@ class Tags(object):
:returns: True if the Tags() iterator has at least one more Tag
left."""
- return nmlib.notmuch_tags_valid(self._tags) > 0
+ return self._valid(self._tags) > 0
- def __str__(self):
- """The str() representation of Tags() is a space separated list of tags
+ def __unicode__(self):
+ """string representation of :class:`Tags`: a space separated list of 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.
+ .. 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.
"""
return " ".join(self)
+ _destroy = nmlib.notmuch_tags_destroy
+ _destroy.argtypes = [NotmuchTagsP]
+ _destroy.restype = None
+
def __del__(self):
"""Close and free the notmuch tags"""
if self._tags is not None:
- nmlib.notmuch_tags_destroy(self._tags)
+ self._destroy(self._tags)