mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-29 14:14:12 +01:00
2dd0cf8f5b
Rather than hardcoding the version in various places, we export it from the module itself. Also improve the README somewhat.
43 lines
1.8 KiB
Python
43 lines
1.8 KiB
Python
"""The :mod:`notmuch` module provides most of the functionality that a user is likely to need.
|
|
|
|
Many of its objects use python's logging module to log some output at DEBUG level.
|
|
|
|
.. note:: The underlying notmuch library is build on a hierarchical
|
|
memory allocator called talloc. All objects derive from a
|
|
top-level :class:`Database` object.
|
|
|
|
This means that as soon as an object is deleted, all underlying
|
|
derived objects such as Queries, Messages, Message, and Tags will
|
|
be freed by the underlying library as well. Accessing these
|
|
objects will then lead to segfaults and other unexpected behavior.
|
|
|
|
We implement reference counting, so that parent objects can be
|
|
automatically freed when they are not needed anymore. For
|
|
example::
|
|
|
|
db = Database('path',create=True)
|
|
msgs = Query(db,'from:myself').search_messages()
|
|
|
|
This returns a :class:`Messages` which internally contains a
|
|
reference to its parent :class:`Query` object. Otherwise the
|
|
Query() would be immediately freed, taking our *msgs* down with
|
|
it.
|
|
|
|
In this case, the above Query() object will be automatically freed
|
|
whenever we delete all derived objects, ie in our case:
|
|
`del(msgs)` would also delete the parent Query. It would not
|
|
delete the parent Database() though, as that is still referenced
|
|
from the variable *db* in which it is stored.
|
|
|
|
Pretty much the same is valid for all other objects in the
|
|
hierarchy, such as :class:`Query`, :class:`Messages`,
|
|
:class:`Message`, and :class:`Tags`.
|
|
|
|
"""
|
|
import ctypes
|
|
from ctypes import c_int, c_char_p
|
|
from database import Database,Tags,Query,Messages,Message,Tags
|
|
from cnotmuch.globals import nmlib,STATUS,NotmuchError
|
|
__LICENSE__="GPL v3+"
|
|
__VERSION__='0.1.1'
|
|
__AUTHOR__ ='Sebastian Spaeth <Sebastian@SSpaeth.de>'
|