python: rename filename.py into filenames.py
authorJustus Winter <4winter@informatik.uni-hamburg.de>
Wed, 22 Feb 2012 21:44:35 +0000 (22:44 +0100)
committerJustus Winter <4winter@informatik.uni-hamburg.de>
Wed, 22 Feb 2012 21:44:35 +0000 (22:44 +0100)
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
bindings/python/notmuch/__init__.py
bindings/python/notmuch/directory.py
bindings/python/notmuch/filename.py [deleted file]
bindings/python/notmuch/filenames.py [new file with mode: 0644]
bindings/python/notmuch/message.py

index 89b98495745a4d5dac3acb7fd61c530f834760d0..fddc492ae013624f5a23f112d95c746bc9aca28a 100644 (file)
@@ -53,7 +53,7 @@ Copyright 2010-2011 Sebastian Spaeth <Sebastian@SSpaeth.de>
 """
 from .database import Database
 from .directory import Directory
-from .filename import Filenames
+from .filenames import Filenames
 from .message import Message
 from .messages import Messages
 from .query import Query
index 3e0763f256660f06a7550ffd3de656b458ab9f65..b679aa293dc21006a06102e612e2cbca631ceb19 100644 (file)
@@ -26,7 +26,7 @@ from notmuch.globals import (
     NotmuchDirectoryP,
     NotmuchFilenamesP
 )
-from .filename import Filenames
+from .filenames import Filenames
 
 class Directory(object):
     """Represents a directory entry in the notmuch directory
diff --git a/bindings/python/notmuch/filename.py b/bindings/python/notmuch/filename.py
deleted file mode 100644 (file)
index 232a9ed..0000000
+++ /dev/null
@@ -1,167 +0,0 @@
-"""
-This file is part of notmuch.
-
-Notmuch is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation, either version 3 of the License, or (at your
-option) any later version.
-
-Notmuch is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-for more details.
-
-You should have received a copy of the GNU General Public License
-along with notmuch.  If not, see <http://www.gnu.org/licenses/>.
-
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
-"""
-from ctypes import c_char_p
-from notmuch.globals import (
-    nmlib,
-    NullPointerError,
-    NotInitializedError,
-    NotmuchMessageP,
-    NotmuchFilenamesP,
-    Python3StringMixIn,
-)
-
-
-class Filenames(Python3StringMixIn):
-    """Represents a list of filenames as returned by notmuch
-
-    This object contains the Filenames iterator. The main function is
-    as_generator() which will return a generator so we can do a Filenamesth an
-    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:`NotInitializedError`. Also note, that any function that uses
-    iteration (nearly all) will also exhaust the tags. So both::
-
-      for name in filenames: print name
-
-    as well as::
-
-       number_of_names = len(names)
-
-    and even a simple::
-
-       #str() iterates over all tags to construct a space separated list
-       print(str(filenames))
-
-    will "exhaust" the Filenames. However, you can use
-    :meth:`Message.get_filenames` repeatedly to get fresh Filenames
-    objects to perform various actions on filenames.
-    """
-
-    #notmuch_filenames_get
-    _get = nmlib.notmuch_filenames_get
-    _get.argtypes = [NotmuchFilenamesP]
-    _get.restype = c_char_p
-
-    def __init__(self, files_p, parent):
-        """
-        :param files_p: A pointer to an underlying *notmuch_tags_t*
-             structure. These are not publically exposed, so a user
-             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:`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 not files_p:
-            raise NullPointerError()
-
-        self._files_p = files_p
-        #save reference to parent object so we keep it alive
-        self._parent = parent
-
-    def __iter__(self):
-        """ Make Filenames an iterator """
-        return self
-
-    _valid = nmlib.notmuch_filenames_valid
-    _valid.argtypes = [NotmuchFilenamesP]
-    _valid.restype = bool
-
-    _move_to_next = nmlib.notmuch_filenames_move_to_next
-    _move_to_next.argtypes = [NotmuchFilenamesP]
-    _move_to_next.restype = None
-
-    def __next__(self):
-        if not self._files_p:
-            raise NotInitializedError()
-
-        if not self._valid(self._files_p):
-            self._files_p = None
-            raise StopIteration
-
-        file_ = Filenames._get(self._files_p)
-        self._move_to_next(self._files_p)
-        return file_.decode('utf-8', 'ignore')
-    next = __next__ # python2.x iterator protocol compatibility
-
-    def as_generator(self):
-        """Return generator of Filenames
-
-        This is the main function that will usually be used by the
-        user.
-
-        .. deprecated:: 0.12
-                        :class:`Filenames` objects implement the
-                        iterator protocol.
-        """
-        return 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:`NotInitializedError` on subsequent
-               attempts. However, you can use
-               :meth:`Message.get_filenames` repeatedly to perform
-               various actions on filenames.
-        """
-        return "\n".join(self)
-
-    _destroy = nmlib.notmuch_filenames_destroy
-    _destroy.argtypes = [NotmuchMessageP]
-    _destroy.restype = None
-
-    def __del__(self):
-        """Close and free the notmuch filenames"""
-        if self._files_p is not None:
-            self._destroy(self._files_p)
-
-    def __len__(self):
-        """len(:class:`Filenames`) returns the number of contained files
-
-        .. note::
-
-            As this iterates over the files, we will not be able to
-            iterate over them again! So this will fail::
-
-                 #THIS FAILS
-                 files = Database().get_directory('').get_child_files()
-                 if len(files) > 0:  # this 'exhausts' msgs
-                     # next line raises
-                     # NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)
-                     for file in files: print file
-        """
-        if not self._files_p:
-            raise NotInitializedError()
-
-        i = 0
-        while self._valid(self._files_p):
-            self._move_to_next(self._files_p)
-            i += 1
-        self._files_p = None
-        return i
diff --git a/bindings/python/notmuch/filenames.py b/bindings/python/notmuch/filenames.py
new file mode 100644 (file)
index 0000000..232a9ed
--- /dev/null
@@ -0,0 +1,167 @@
+"""
+This file is part of notmuch.
+
+Notmuch is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+Notmuch is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with notmuch.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
+"""
+from ctypes import c_char_p
+from notmuch.globals import (
+    nmlib,
+    NullPointerError,
+    NotInitializedError,
+    NotmuchMessageP,
+    NotmuchFilenamesP,
+    Python3StringMixIn,
+)
+
+
+class Filenames(Python3StringMixIn):
+    """Represents a list of filenames as returned by notmuch
+
+    This object contains the Filenames iterator. The main function is
+    as_generator() which will return a generator so we can do a Filenamesth an
+    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:`NotInitializedError`. Also note, that any function that uses
+    iteration (nearly all) will also exhaust the tags. So both::
+
+      for name in filenames: print name
+
+    as well as::
+
+       number_of_names = len(names)
+
+    and even a simple::
+
+       #str() iterates over all tags to construct a space separated list
+       print(str(filenames))
+
+    will "exhaust" the Filenames. However, you can use
+    :meth:`Message.get_filenames` repeatedly to get fresh Filenames
+    objects to perform various actions on filenames.
+    """
+
+    #notmuch_filenames_get
+    _get = nmlib.notmuch_filenames_get
+    _get.argtypes = [NotmuchFilenamesP]
+    _get.restype = c_char_p
+
+    def __init__(self, files_p, parent):
+        """
+        :param files_p: A pointer to an underlying *notmuch_tags_t*
+             structure. These are not publically exposed, so a user
+             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:`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 not files_p:
+            raise NullPointerError()
+
+        self._files_p = files_p
+        #save reference to parent object so we keep it alive
+        self._parent = parent
+
+    def __iter__(self):
+        """ Make Filenames an iterator """
+        return self
+
+    _valid = nmlib.notmuch_filenames_valid
+    _valid.argtypes = [NotmuchFilenamesP]
+    _valid.restype = bool
+
+    _move_to_next = nmlib.notmuch_filenames_move_to_next
+    _move_to_next.argtypes = [NotmuchFilenamesP]
+    _move_to_next.restype = None
+
+    def __next__(self):
+        if not self._files_p:
+            raise NotInitializedError()
+
+        if not self._valid(self._files_p):
+            self._files_p = None
+            raise StopIteration
+
+        file_ = Filenames._get(self._files_p)
+        self._move_to_next(self._files_p)
+        return file_.decode('utf-8', 'ignore')
+    next = __next__ # python2.x iterator protocol compatibility
+
+    def as_generator(self):
+        """Return generator of Filenames
+
+        This is the main function that will usually be used by the
+        user.
+
+        .. deprecated:: 0.12
+                        :class:`Filenames` objects implement the
+                        iterator protocol.
+        """
+        return 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:`NotInitializedError` on subsequent
+               attempts. However, you can use
+               :meth:`Message.get_filenames` repeatedly to perform
+               various actions on filenames.
+        """
+        return "\n".join(self)
+
+    _destroy = nmlib.notmuch_filenames_destroy
+    _destroy.argtypes = [NotmuchMessageP]
+    _destroy.restype = None
+
+    def __del__(self):
+        """Close and free the notmuch filenames"""
+        if self._files_p is not None:
+            self._destroy(self._files_p)
+
+    def __len__(self):
+        """len(:class:`Filenames`) returns the number of contained files
+
+        .. note::
+
+            As this iterates over the files, we will not be able to
+            iterate over them again! So this will fail::
+
+                 #THIS FAILS
+                 files = Database().get_directory('').get_child_files()
+                 if len(files) > 0:  # this 'exhausts' msgs
+                     # next line raises
+                     # NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)
+                     for file in files: print file
+        """
+        if not self._files_p:
+            raise NotInitializedError()
+
+        i = 0
+        while self._valid(self._files_p):
+            self._move_to_next(self._files_p)
+            i += 1
+        self._files_p = None
+        return i
index 20ba9cb918cbca07d05a4266d63a02898895334d..d17b9bc693c2a4ce6f8e87ef2a955219668cc459 100644 (file)
@@ -36,7 +36,7 @@ from .globals import (
     NotmuchFilenamesP,
 )
 from .tag import Tags
-from .filename import Filenames
+from .filenames import Filenames
 
 import email
 try: