X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Ffilename.py;h=353eb76e3e946f7b480eca634640fcbdf405bba9;hb=c1094bc2d767159b5478cd0399d37a4813d0de05;hp=6b332a92a1733ce11793a7a1e514ec75bc181153;hpb=86b0aeb1ca0f12286e13b71d7f025ba8a59a808d;p=notmuch
diff --git a/bindings/python/notmuch/filename.py b/bindings/python/notmuch/filename.py
index 6b332a92..353eb76e 100644
--- a/bindings/python/notmuch/filename.py
+++ b/bindings/python/notmuch/filename.py
@@ -17,11 +17,17 @@ along with notmuch. If not, see .
Copyright 2010 Sebastian Spaeth '
"""
from ctypes import c_char_p
-from notmuch.globals import (nmlib, STATUS, NotmuchError,
- NotmuchFilenamesP, NotmuchMessageP)
+from notmuch.globals import (
+ nmlib,
+ NullPointerError,
+ NotInitializedError,
+ NotmuchMessageP,
+ NotmuchFilenamesP,
+ Python3StringMixIn,
+)
-class Filenames(object):
+class Filenames(Python3StringMixIn):
"""Represents a list of filenames as returned by notmuch
This object contains the Filenames iterator. The main function is
@@ -29,9 +35,9 @@ class Filenames(object):
iterator over a list of notmuch filenames. 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::
+ tags, and a subsequent iteration attempt will raise a
+ :exc:`NotInitializedError`. Also note, that any function that uses
+ iteration (nearly all) will also exhaust the tags. So both::
for name in filenames: print name
@@ -61,16 +67,16 @@ class Filenames(object):
will almost never instantiate a :class:`Tags` object
herself. They are usually handed back as a result,
e.g. in :meth:`Database.get_all_tags`. *tags_p* must be
- valid, we will raise an :exc:`NotmuchError`
- (STATUS.NULL_POINTER) if it is `None`.
+ valid, we will raise an :exc:`NullPointerError`
+ if it is `None`.
:type files_p: :class:`ctypes.c_void_p`
:param parent: The parent object (ie :class:`Message` these
filenames are derived from, and saves a
reference to it, so we can automatically delete the db object
once all derived objects are dead.
"""
- if files_p is None:
- raise NotmuchError(STATUS.NULL_POINTER)
+ if not files_p:
+ raise NullPointerError()
self._files = files_p
#save reference to parent object so we keep it alive
@@ -89,22 +95,22 @@ class Filenames(object):
This is the main function that will usually be used by the
user."""
- if self._files is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ if not self._files:
+ raise NotInitializedError()
while self._valid(self._files):
- yield Filenames._get(self._files)
+ yield Filenames._get(self._files).decode('utf-8', 'ignore')
self._move_to_next(self._files)
self._files = None
- def __str__(self):
+ def __unicode__(self):
"""Represent Filenames() as newline-separated list of full paths
.. note:: As this iterates over the filenames, 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
+ :exc:`NotInitializedError` on subsequent
attempts. However, you can use
:meth:`Message.get_filenames` repeatedly to perform
various actions on filenames.