1 """The :mod:`notmuch` module provides most of the functionality that a user is
4 .. note:: The underlying notmuch library is build on a hierarchical
5 memory allocator called talloc. All objects derive from a
6 top-level :class:`Database` object.
8 This means that as soon as an object is deleted, all underlying
9 derived objects such as Queries, Messages, Message, and Tags will
10 be freed by the underlying library as well. Accessing these
11 objects will then lead to segfaults and other unexpected behavior.
13 We implement reference counting, so that parent objects can be
14 automatically freed when they are not needed anymore. For
17 db = Database('path',create=True)
18 msgs = Query(db,'from:myself').search_messages()
20 This returns a :class:`Messages` which internally contains a
21 reference to its parent :class:`Query` object. Otherwise the
22 Query() would be immediately freed, taking our *msgs* down with
25 In this case, the above Query() object will be automatically freed
26 whenever we delete all derived objects, ie in our case:
27 `del(msgs)` would also delete the parent Query. It would not
28 delete the parent Database() though, as that is still referenced
29 from the variable *db* in which it is stored.
31 Pretty much the same is valid for all other objects in the
32 hierarchy, such as :class:`Query`, :class:`Messages`,
33 :class:`Message`, and :class:`Tags`.
38 This file is part of notmuch.
40 Notmuch is free software: you can redistribute it and/or modify it
41 under the terms of the GNU General Public License as published by the
42 Free Software Foundation, either version 3 of the License, or (at your
43 option) any later version.
45 Notmuch is distributed in the hope that it will be useful, but WITHOUT
46 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
47 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
50 You should have received a copy of the GNU General Public License
51 along with notmuch. If not, see <http://www.gnu.org/licenses/>.
53 Copyright 2010-2011 Sebastian Spaeth <Sebastian@SSpaeth.de>
55 from notmuch.database import Database, Query
56 from notmuch.message import Messages, Message
57 from notmuch.thread import Threads, Thread
58 from notmuch.tag import Tags
59 from notmuch.globals import (
64 ReadOnlyDatabaseError,
68 DuplicateMessageIdError,
71 UnbalancedFreezeThawError,
72 UnbalancedAtomicError,
75 from notmuch.version import __VERSION__
76 __LICENSE__ = "GPL v3+"
77 __AUTHOR__ = 'Sebastian Spaeth <Sebastian@SSpaeth.de>'