1) Fix added .gitignore from commit
dc8a1745 to work on the docs folder
2) Improve in-code developer documentation to produce better
sphinx-generated documentation. No code changes.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
- .. note:: :meth:`__len__` was removed in version 0.6 as it exhausted
+ .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted
the iterator and broke list(Messages()). Use the
:meth:`Query.count_messages` function or use
`len(list(msgs))`.
the iterator and broke list(Messages()). Use the
:meth:`Query.count_messages` function or use
`len(list(msgs))`.
.. autoclass:: Tags
:members:
.. autoclass:: Tags
:members:
- .. automethod:: __len__
+ .. method:: __len__
+
+ .. warning:: :meth:`__len__` was removed in version 0.6 as it
+ exhausted the iterator and broke list(Tags()). Use
+ :meth:`len(list(msgs))` instead if you need to know the
+ number of tags.
def get_path(self):
"""Returns the file path of an open database
def get_path(self):
"""Returns the file path of an open database
- Wraps *notmuch_database_get_path*."""
+ .. ..:: Wraps underlying `notmuch_database_get_path`"""
self._assert_db_is_initialized()
return Database._get_path(self._db).decode('utf-8')
self._assert_db_is_initialized()
return Database._get_path(self._db).decode('utf-8')
"""Returns the database format version
:returns: The database version as positive integer
"""Returns the database format version
:returns: The database version as positive integer
- :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+ :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
the database was not intitialized.
"""
self._assert_db_is_initialized()
the database was not intitialized.
"""
self._assert_db_is_initialized()
etc.) will work unless :meth:`upgrade` is called successfully first.
:returns: `True` or `False`
etc.) will work unless :meth:`upgrade` is called successfully first.
:returns: `True` or `False`
- :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+ :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
the database was not intitialized.
"""
self._assert_db_is_initialized()
the database was not intitialized.
"""
self._assert_db_is_initialized()
transaction, this only ensures atomicity, not durability;
neither begin nor end necessarily flush modifications to disk.
transaction, this only ensures atomicity, not durability;
neither begin nor end necessarily flush modifications to disk.
- :returns: STATUS.SUCCESS or raises
+ :returns: :attr:`STATUS`.SUCCESS or raises
- :exception: :exc:`NotmuchError` STATUS.XAPIAN_EXCEPTION::
+ :exception: :exc:`NotmuchError` :attr:`STATUS`.XAPIAN_EXCEPTION::
A Xapian exception occurred; atomic section not
entered."""
A Xapian exception occurred; atomic section not
entered."""
See :meth:`begin_atomic` for details.
See :meth:`begin_atomic` for details.
- :returns: STATUS.SUCCESS or raises
+ :returns: :attr:`STATUS`.SUCCESS or raises
:exception:
:exc:`NotmuchError`:
:exception:
:exc:`NotmuchError`:
- STATUS.XAPIAN_EXCEPTION
+ :attr:`STATUS`.XAPIAN_EXCEPTION
A Xapian exception occurred; atomic section not
ended.
A Xapian exception occurred; atomic section not
ended.
- STATUS.UNBALANCED_ATOMIC:
+ :attr:`STATUS`.UNBALANCED_ATOMIC:
end_atomic has been called more times than begin_atomic."""
self._assert_db_is_initialized()
status = nmlib.notmuch_database_end_atomic(self._db)
end_atomic has been called more times than begin_atomic."""
self._assert_db_is_initialized()
status = nmlib.notmuch_database_end_atomic(self._db)
(creating it if it does not exist(?))
.. warning:: This call needs a writeable database in
(creating it if it does not exist(?))
.. warning:: This call needs a writeable database in
- Database.MODE.READ_WRITE mode. The underlying library will exit the
+ :attr:`Database.MODE`.READ_WRITE mode. The underlying library will exit the
program if this method is used on a read-only database!
:param path: An unicode string containing the path relative to the path
program if this method is used on a read-only database!
:param path: An unicode string containing the path relative to the path
:returns: :class:`Directory` or raises an exception.
:exception: :exc:`NotmuchError`
:returns: :class:`Directory` or raises an exception.
:exception: :exc:`NotmuchError`
+ :attr:`STATUS`.NOT_INITIALIZED
If the database was not intitialized.
If the database was not intitialized.
+ :attr:`STATUS`.FILE_ERROR
If path is not relative database or absolute with initial
components same as database.
If path is not relative database or absolute with initial
components same as database.
def add_message(self, filename, sync_maildir_flags=False):
"""Adds a new message to the database
def add_message(self, filename, sync_maildir_flags=False):
"""Adds a new message to the database
- :param filename: should be a path relative to the path of the open
- database (see :meth:`get_path`), or else should be an absolute
- filename with initial components that match the path of the
- database.
+ :param filename: should be a path relative to the path of the
+ open database (see :meth:`get_path`), or else should be an
+ absolute filename with initial components that match the
+ path of the database.
- The file should be a single mail message (not a multi-message mbox)
- that is expected to remain at its current location, since the
- notmuch database will reference the filename, and will not copy the
- entire contents of the file.
+ The file should be a single mail message (not a
+ multi-message mbox) that is expected to remain at its
+ current location, since the notmuch database will reference
+ the filename, and will not copy the entire contents of the
+ file.
:param sync_maildir_flags: If the message contains Maildir
flags, we will -depending on the notmuch configuration- sync
:param sync_maildir_flags: If the message contains Maildir
flags, we will -depending on the notmuch configuration- sync
1) a :class:`Message` object that can be used for things
such as adding tags to the just-added message.
1) a :class:`Message` object that can be used for things
such as adding tags to the just-added message.
- 2) one of the following STATUS values:
+ 2) one of the following :attr:`STATUS` values:
Message successfully added to database.
Message successfully added to database.
- STATUS.DUPLICATE_MESSAGE_ID
+ :attr:`STATUS`.DUPLICATE_MESSAGE_ID
Message has the same message ID as another message already
in the database. The new filename was successfully added
to the list of the filenames for the existing message.
Message has the same message ID as another message already
in the database. The new filename was successfully added
to the list of the filenames for the existing message.
- :rtype: 2-tuple(:class:`Message`, STATUS)
+ :rtype: 2-tuple(:class:`Message`, :attr:`STATUS`)
:exception: Raises a :exc:`NotmuchError` with the following meaning.
If such an exception occurs, nothing was added to the database.
:exception: Raises a :exc:`NotmuchError` with the following meaning.
If such an exception occurs, nothing was added to the database.
+ :attr:`STATUS`.FILE_ERROR
An error occurred trying to open the file, (such as
permission denied, or file not found, etc.).
An error occurred trying to open the file, (such as
permission denied, or file not found, etc.).
+ :attr:`STATUS`.FILE_NOT_EMAIL
The contents of filename don't look like an email
message.
The contents of filename don't look like an email
message.
- STATUS.READ_ONLY_DATABASE
+ :attr:`STATUS`.READ_ONLY_DATABASE
Database was opened in read-only mode so no message can
be added.
Database was opened in read-only mode so no message can
be added.
+ :attr:`STATUS`.NOT_INITIALIZED
The database has not been initialized.
"""
self._assert_db_is_initialized()
The database has not been initialized.
"""
self._assert_db_is_initialized()
is removed for a particular message, the database content for that
message will be entirely removed.
is removed for a particular message, the database content for that
message will be entirely removed.
- :returns: A STATUS value with the following meaning:
+ :returns: A :attr:`STATUS` value with the following meaning:
The last filename was removed and the message was removed
from the database.
The last filename was removed and the message was removed
from the database.
- STATUS.DUPLICATE_MESSAGE_ID
+ :attr:`STATUS`.DUPLICATE_MESSAGE_ID
This filename was removed but the message persists in the
database with at least one other filename.
This filename was removed but the message persists in the
database with at least one other filename.
If such an exception occurs, nothing was removed from the
database.
If such an exception occurs, nothing was removed from the
database.
- STATUS.READ_ONLY_DATABASE
+ :attr:`STATUS`.READ_ONLY_DATABASE
Database was opened in read-only mode so no message can be
removed.
Database was opened in read-only mode so no message can be
removed.
+ :attr:`STATUS`.NOT_INITIALIZED
The database has not been initialized.
"""
self._assert_db_is_initialized()
The database has not been initialized.
"""
self._assert_db_is_initialized()
another program in the meantime. A return value of
`None` is therefore no guarantee that the message
does not exist.
another program in the meantime. A return value of
`None` is therefore no guarantee that the message
does not exist.
- :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+ :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
the database was not intitialized.
"""
self._assert_db_is_initialized()
the database was not intitialized.
"""
self._assert_db_is_initialized()
def find_message_by_filename(self, filename):
"""Find a message with the given filename
def find_message_by_filename(self, filename):
"""Find a message with the given filename
+ .. warning:: This call needs a writeable database in
+ :attr:`Database.MODE`.READ_WRITE mode. The underlying library will
+ exit the program if this method is used on a read-only
+ database!
+
:returns: If the database contains a message with the given
filename, then a class:`Message:` is returned. This
function returns None in the following situations:
:returns: If the database contains a message with the given
filename, then a class:`Message:` is returned. This
function returns None in the following situations:
"""Returns :class:`Tags` with a list of all tags found in the database
:returns: :class:`Tags`
"""Returns :class:`Tags` with a list of all tags found in the database
:returns: :class:`Tags`
- :execption: :exc:`NotmuchError` with STATUS.NULL_POINTER on error
+ :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER on error
"""
self._assert_db_is_initialized()
tags_p = Database._get_all_tags(self._db)
"""
self._assert_db_is_initialized()
tags_p = Database._get_all_tags(self._db)
:returns: Nothing
:exception: :exc:`NotmuchError`
:returns: Nothing
:exception: :exc:`NotmuchError`
- * STATUS.NOT_INITIALIZED if db is not inited
- * STATUS.NULL_POINTER if the query creation failed
+ * :attr:`STATUS`.NOT_INITIALIZED if db is not inited
+ * :attr:`STATUS`.NULL_POINTER if the query creation failed
(too little memory)
"""
if db.db_p is None:
(too little memory)
"""
if db.db_p is None:
:param sort: Sort order (see :attr:`Query.SORT`)
:returns: Nothing
:param sort: Sort order (see :attr:`Query.SORT`)
:returns: Nothing
- :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
+ :exception: :exc:`NotmuchError` :attr:`STATUS`.NOT_INITIALIZED if query has not
been initialized.
"""
if self._query is None:
been initialized.
"""
if self._query is None:
:returns: :class:`Threads`
:exception: :exc:`NotmuchError`
:returns: :class:`Threads`
:exception: :exc:`NotmuchError`
- * STATUS.NOT_INITIALIZED if query is not inited
- * STATUS.NULL_POINTER if search_threads failed
+ * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
+ * :attr:`STATUS`.NULL_POINTER if search_threads failed
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
:returns: :class:`Messages`
:exception: :exc:`NotmuchError`
:returns: :class:`Messages`
:exception: :exc:`NotmuchError`
- * STATUS.NOT_INITIALIZED if query is not inited
- * STATUS.NULL_POINTER if search_messages failed
+ * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
+ * :attr:`STATUS`.NULL_POINTER if search_messages failed
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
:returns: :class:`Messages`
:exception: :exc:`NotmuchError`
:returns: :class:`Messages`
:exception: :exc:`NotmuchError`
- * STATUS.NOT_INITIALIZED if query is not inited
+ * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
"""
if self._query is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
_get_child_directories.restype = c_void_p
def _assert_dir_is_initialized(self):
_get_child_directories.restype = c_void_p
def _assert_dir_is_initialized(self):
- """Raises a NotmuchError(STATUS.NOT_INITIALIZED) if dir_p is None"""
+ """Raises a NotmuchError(:attr:`STATUS`.NOT_INITIALIZED) if dir_p is None"""
if self._dir_p is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
if self._dir_p is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
- STATUS.XAPIAN_EXCEPTION
+ :attr:`STATUS`.XAPIAN_EXCEPTION
A Xapian exception occurred, mtime not stored.
A Xapian exception occurred, mtime not stored.
- STATUS.READ_ONLY_DATABASE
+ :attr:`STATUS`.READ_ONLY_DATABASE
Database was opened in read-only mode so directory
mtime cannot be modified.
Database was opened in read-only mode so directory
mtime cannot be modified.
+ :attr:`STATUS`.NOT_INITIALIZED
The directory has not been initialized
"""
self._assert_dir_is_initialized()
The directory has not been initialized
"""
self._assert_dir_is_initialized()
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
:returns: Nothing on success, raising an exception on failure.
:exception: :exc:`NotmuchError`:
+ :attr:`STATUS`.NOT_INITIALIZED
The directory has not been initialized
"""
self._assert_dir_is_initialized()
The directory has not been initialized
"""
self._assert_dir_is_initialized()
#THIS FAILS
files = Database().get_directory('').get_child_files()
if len(files) > 0: #this 'exhausts' msgs
#THIS FAILS
files = Database().get_directory('').get_child_files()
if len(files) > 0: #this 'exhausts' msgs
- # next line raises NotmuchError(STATUS.NOT_INITIALIZED)!!!
+ # next line raises NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)!!!
for file in files: print file
"""
if self._files_p is None:
for file in files: print file
"""
if self._files_p is None:
projects / notmuch / commitdiff