import os
from ctypes import c_int, c_char_p, c_void_p, c_uint, c_long, byref
-from notmuch.globals import nmlib, STATUS, NotmuchError, Enum, _str
+from notmuch.globals import (nmlib, STATUS, NotmuchError, NotInitializedError,
+ NullPointerError, OutOfMemoryError, XapianError, Enum, _str)
from notmuch.thread import Threads
from notmuch.message import Messages, Message
from notmuch.tag import Tags
class Database(object):
- """Represents a notmuch database (wraps notmuch_database_t)
-
- .. note:: Do remember that as soon as we tear down this object,
- all underlying derived objects such as queries, threads,
- messages, tags etc will be freed by the underlying library
- as well. Accessing these objects will lead to segfaults and
- other unexpected behavior. See above for more details.
+ """The :class:`Database` is the highest-level object that notmuch
+ provides. It references a notmuch database, and can be opened in
+ read-only or read-write mode. A :class:`Query` can be derived from
+ or be applied to a specific database to find messages. Also adding
+ and removing messages to the database happens via this
+ object. Modifications to the database are not atmic by default (see
+ :meth:`begin_atomic`) and once a database has been modified, all
+ other database objects pointing to the same data-base will throw an
+ :exc:`XapianError` as the underlying database has been
+ modified. Close and reopen the database to continue working with it.
+
+ .. note:: Any function in this class can and will throw an
+ :exc:`NotInitializedError` if the database was not
+ intitialized properly.
+
+ .. note:: Do remember that as soon as we tear down (e.g. via `del
+ db`) this object, all underlying derived objects such as
+ queries, threads, messages, tags etc will be freed by the
+ underlying library as well. Accessing these objects will lead
+ to segfaults and other unexpected behavior. See above for
+ more details.
"""
_std_db_path = None
"""Class attribute to cache user's default database"""
""" notmuch_database_find_message"""
_find_message = nmlib.notmuch_database_find_message
- _find_message.restype = c_void_p
"""notmuch_database_find_message_by_filename"""
_find_message_by_filename = nmlib.notmuch_database_find_message_by_filename
- _find_message_by_filename.restype = c_void_p
"""notmuch_database_get_all_tags"""
_get_all_tags = nmlib.notmuch_database_get_all_tags
:param mode: Mode to open a database in. Is always
:attr:`MODE`.READ_WRITE when creating a new one.
:type mode: :attr:`MODE`
- :returns: Nothing
- :exception: :exc:`NotmuchError` in case of failure.
+ :exception: :exc:`NotmuchError` or derived exception in case of
+ failure.
"""
self._db = None
if path is None:
self.create(path)
def _assert_db_is_initialized(self):
- """Raises a NotmuchError in case self._db is still None"""
+ """Raises :exc:`NotInitializedError` if self._db is `None`"""
if self._db is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ raise NotInitializedError()
def create(self, path):
"""Creates a new notmuch database
:type path: str
:returns: Nothing
:exception: :exc:`NotmuchError` in case of any failure
- (after printing an error message on stderr).
+ (possibly after printing an error message on stderr).
"""
if self._db is not None:
raise NotmuchError(message="Cannot create db, this Database() "
:type status: :attr:`MODE`
:returns: Nothing
:exception: Raises :exc:`NotmuchError` in case
- of any failure (after printing an error message on stderr).
+ of any failure (possibly after printing an error message on stderr).
"""
res = Database._open(_str(path), mode)
if res is None:
- raise NotmuchError(
- message="Could not open the specified database")
+ raise NotmuchError(message="Could not open the specified database")
self._db = res
def get_path(self):
- """Returns the file path of an open database
-
- .. ..:: Wraps underlying `notmuch_database_get_path`"""
+ """Returns the file path of an open database"""
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
- :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
- the database was not intitialized.
"""
self._assert_db_is_initialized()
return Database._get_version(self._db)
etc.) will work unless :meth:`upgrade` is called successfully first.
:returns: `True` or `False`
- :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
- the database was not intitialized.
"""
self._assert_db_is_initialized()
return nmlib.notmuch_database_needs_upgrade(self._db)
of database (see :meth:`get_path`), or else should be an absolute path
with initial components that match the path of 'database'.
:returns: :class:`Directory` or raises an exception.
- :exception: :exc:`NotmuchError`
-
- :attr:`STATUS`.NOT_INITIALIZED
- If the database was not intitialized.
-
- :attr:`STATUS`.FILE_ERROR
+ :exception:
+ :exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
If path is not relative database or absolute with initial
components same as database.
-
"""
self._assert_db_is_initialized()
# sanity checking if path is valid, and make path absolute
:attr:`STATUS`.READ_ONLY_DATABASE
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()
msg_p = c_void_p()
:attr:`STATUS`.READ_ONLY_DATABASE
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()
return nmlib.notmuch_database_remove_message(self._db,
Wraps the underlying *notmuch_database_find_message* function.
:param msgid: The message ID
- :type msgid: string
- :returns: :class:`Message` or `None` if no message is found or
- if any xapian exception or out-of-memory situation
- occurs. Do note that Xapian Exceptions include
- "Database modified" situations, e.g. when the
- notmuch database has been modified by
- another program in the meantime. A return value of
- `None` is therefore no guarantee that the message
- does not exist.
- :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if
- the database was not intitialized.
+ :type msgid: unicode or str
+ :returns: :class:`Message` or `None` if no message is found.
+ :exception:
+ :exc:`OutOfMemoryError`
+ If an Out-of-memory occured while constructing the message.
+ :exc:`XapianError`
+ In case of a Xapian Exception. These exceptions
+ include "Database modified" situations, e.g. when the
+ notmuch database has been modified by another program
+ in the meantime. In this case, you should close and
+ reopen the database and retry.
+ :exc:`NotInitializedError` if
+ the database was not intitialized.
"""
self._assert_db_is_initialized()
- msg_p = Database._find_message(self._db, _str(msgid))
+ msg_p = c_void_p()
+ status = Database._find_message(self._db, _str(msgid), byref(msg_p))
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
return msg_p and Message(msg_p, self) or None
def find_message_by_filename(self, filename):
: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:
+ function returns None if no message is found with the given
+ filename.
- * No message is found with the given filename
- * An out-of-memory situation occurs
- * A Xapian exception occurs
+ :exception:
+ :exc:`OutOfMemoryError`
+ If an Out-of-memory occured while constructing the message.
+ :exc:`XapianError`
+ In case of a Xapian Exception. These exceptions
+ include "Database modified" situations, e.g. when the
+ notmuch database has been modified by another program
+ in the meantime. In this case, you should close and
+ reopen the database and retry.
+ :exc:`NotInitializedError` if
+ the database was not intitialized.
*Added in notmuch 0.9*"""
self._assert_db_is_initialized()
- msg_p = Database._find_message_by_filename(self._db, _str(filename))
+ msg_p = c_void_p()
+ status = Database._find_message_by_filename(self._db, _str(filename),
+ byref(msg_p))
+ if status != STATUS.SUCCESS:
+ raise NotmuchError(status)
return msg_p and Message(msg_p, self) or None
def get_all_tags(self):
This function is a python extension and not in the underlying C API.
"""
- self._assert_db_is_initialized()
return Query(self, querystring)
def __repr__(self):
A query selects and filters a subset of messages from the notmuch
database we derive from.
- Query() provides an instance attribute :attr:`sort`, which
+ :class:`Query` provides an instance attribute :attr:`sort`, which
contains the sort order (if specified via :meth:`set_sort`) or
`None`.
- Technically, it wraps the underlying *notmuch_query_t* struct.
+ Any function in this class may throw an :exc:`NotInitializedError`
+ in case the underlying query object was not set up correctly.
.. note:: Do remember that as soon as we tear down this object,
all underlying derived objects such as threads,
self.sort = None
self.create(db, querystr)
+ def _assert_query_is_initialized(self):
+ """Raises :exc:`NotInitializedError` if self._query is `None`"""
+ if self._query is None:
+ raise NotInitializedError()
+
def create(self, db, querystr):
"""Creates a new query derived from a Database
:param querystr: The query string
:type querystr: utf-8 encoded str or unicode
:returns: Nothing
- :exception: :exc:`NotmuchError`
-
- * :attr:`STATUS`.NOT_INITIALIZED if db is not inited
- * :attr:`STATUS`.NULL_POINTER if the query creation failed
- (too little memory)
+ :exception:
+ :exc:`NullPointerError` if the query creation failed
+ (e.g. too little memory).
+ :exc:`NotInitializedError` if the underlying db was not
+ intitialized.
"""
- if db.db_p is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
+ db._assert_db_is_initialized()
# create reference to parent db to keep it alive
self._db = db
# create query, return None if too little mem available
query_p = Query._create(db.db_p, _str(querystr))
if query_p is None:
- raise NotmuchError(STATUS.NULL_POINTER)
+ raise NullPointerError
self._query = query_p
def set_sort(self, sort):
"""Set the sort order future results will be delivered in
- Wraps the underlying *notmuch_query_set_sort* function.
-
:param sort: Sort order (see :attr:`Query.SORT`)
- :returns: Nothing
- :exception: :exc:`NotmuchError` :attr:`STATUS`.NOT_INITIALIZED if query has not
- been initialized.
"""
- if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+ self._assert_query_is_initialized()
self.sort = sort
nmlib.notmuch_query_set_sort(self._query, sort)
match the query. The method :meth:`Message.get_flag` allows us
to get the value of this flag.
- Technically, it wraps the underlying
- *notmuch_query_search_threads* function.
-
:returns: :class:`Threads`
- :exception: :exc:`NotmuchError`
-
- * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
- * :attr:`STATUS`.NULL_POINTER if search_threads failed
+ :exception: :exc:`NullPointerError` if search_threads failed
"""
- if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+ self._assert_query_is_initialized()
threads_p = Query._search_threads(self._query)
if threads_p is None:
- raise NotmuchError(STATUS.NULL_POINTER)
-
+ raise NullPointerError
return Threads(threads_p, self)
def search_messages(self):
"""Filter messages according to the query and return
:class:`Messages` in the defined sort order
- Technically, it wraps the underlying
- *notmuch_query_search_messages* function.
-
:returns: :class:`Messages`
- :exception: :exc:`NotmuchError`
-
- * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
- * :attr:`STATUS`.NULL_POINTER if search_messages failed
+ :exception: :exc:`NullPointerError` if search_messages failed
"""
- if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+ self._assert_query_is_initialized()
msgs_p = Query._search_messages(self._query)
if msgs_p is None:
- raise NotmuchError(STATUS.NULL_POINTER)
-
+ raise NullPointerError
return Messages(msgs_p, self)
def count_messages(self):
*notmuch_query_count_messages* function.
:returns: :class:`Messages`
- :exception: :exc:`NotmuchError`
-
- * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
"""
- if self._query is None:
- raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+ self._assert_query_is_initialized()
return Query._count_messages(self._query)
def __del__(self):
projects / notmuch / blobdiff