X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=bindings%2Fpython%2Fdocs%2Fsource%2Findex.rst;h=fc3179b46196067d4cf6104c06f1b00c4494639d;hp=d26a050157c9d088c72ae75080b247205ac137ce;hb=fb52083bf7eff44f27b2f2fffcbfbcb4faaeda3c;hpb=eb4cd33e6b5406bf69273be52f88a57dad6e8126 diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index d26a0501..fc3179b4 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -13,7 +13,7 @@ Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide mos :License: This module is covered under the GNU GPL v3 (or later). -This page contains the main API overview of notmuch |release|. +This page contains the main API overview of notmuch |release|. Notmuch can be imported as:: @@ -21,7 +21,13 @@ Notmuch can be imported as:: or:: - from notmuch import Query,Database + from notmuch import Query, Database + + db = Database('path',create=True) + msgs = Query(db,'from:myself').search_messages() + + for msg in msgs: + print (msg) More information on specific topics can be found on the following pages: @@ -29,19 +35,17 @@ More information on specific topics can be found on the following pages: :maxdepth: 1 status_and_errors - notmuch + notmuch :mod:`notmuch` -- The Notmuch interface ================================================= .. automodule:: notmuch -:todo: Document nmlib,STATUS - -:class:`notmuch.Database` -- The underlying notmuch database +:class:`Database` -- The underlying notmuch database --------------------------------------------------------------------- -.. autoclass:: notmuch.Database([path=None[, create=False[, mode=MODE.READ_ONLY]]]) +.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]]) .. automethod:: create @@ -55,6 +59,10 @@ More information on specific topics can be found on the following pages: .. automethod:: upgrade + .. automethod:: begin_atomic + + .. automethod:: end_atomic + .. automethod:: get_directory .. automethod:: add_message @@ -63,13 +71,12 @@ More information on specific topics can be found on the following pages: .. automethod:: find_message + .. automethod:: find_message_by_filename + .. automethod:: get_all_tags .. automethod:: create_query - .. note:: :meth:`create_query` was broken in release - 0.1 and is fixed since 0.1.1. - .. attribute:: Database.MODE Defines constants that are used as the mode in which to open a database. @@ -82,10 +89,11 @@ More information on specific topics can be found on the following pages: .. autoattribute:: db_p -:class:`notmuch.Query` -- A search query + +:class:`Query` -- A search query ------------------------------------------------- -.. autoclass:: notmuch.Query +.. autoclass:: Query .. automethod:: create @@ -103,8 +111,8 @@ More information on specific topics can be found on the following pages: Sort by email message ID. SORT.UNSORTED - Do not apply a special sort order (returns results in document id - order). + Do not apply a special sort order (returns results in document id + order). .. automethod:: set_sort @@ -120,6 +128,8 @@ More information on specific topics can be found on the following pages: .. automethod:: count_messages + .. automethod:: count_threads + :class:`Messages` -- A bunch of messages ---------------------------------------- @@ -130,10 +140,10 @@ More information on specific topics can be found on the following pages: .. method:: __len__() - .. 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))`. + .. 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))`. :class:`Message` -- A single message ---------------------------------------- @@ -152,7 +162,7 @@ More information on specific topics can be found on the following pages: .. attribute:: FLAG - FLAG.MATCH + FLAG.MATCH This flag is automatically set by a Query.search_threads on those messages that match the query. This allows us to distinguish matches from the rest @@ -161,7 +171,7 @@ More information on specific topics can be found on the following pages: .. automethod:: get_flag .. automethod:: set_flag - + .. automethod:: get_date .. automethod:: get_header @@ -197,18 +207,19 @@ More information on specific topics can be found on the following pages: .. 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. + .. 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. .. automethod:: __str__ -:class:`notmuch.Threads` -- Threads iterator +:class:`Threads` -- Threads iterator ----------------------------------------------------- -.. autoclass:: notmuch.Threads +.. autoclass:: Threads .. automethod:: __len__ @@ -243,26 +254,28 @@ More information on specific topics can be found on the following pages: :class:`Filenames` -- An iterator over filenames ------------------------------------------------ -.. autoclass:: notmuch.database.Filenames +.. autoclass:: Filenames + + .. automethod:: Filenames.__len__ - .. automethod:: notmuch.database.Filenames.__len__ + .. automethod:: Filenames.as_generator -:class:`notmuch.database.Directoy` -- A directory entry in the database +:class:`Directoy` -- A directory entry in the database ------------------------------------------------------------------------ -.. autoclass:: notmuch.database.Directory +.. autoclass:: Directory - .. automethod:: notmuch.database.Directory.get_child_files + .. automethod:: Directory.get_child_files - .. automethod:: notmuch.database.Directory.get_child_directories + .. automethod:: Directory.get_child_directories - .. automethod:: notmuch.database.Directory.get_mtime + .. automethod:: Directory.get_mtime - .. automethod:: notmuch.database.Directory.set_mtime + .. automethod:: Directory.set_mtime - .. autoattribute:: notmuch.database.Directory.mtime + .. autoattribute:: Directory.mtime - .. autoattribute:: notmuch.database.Directory.path + .. autoattribute:: Directory.path The `next page `_ contains information on possible Status and Error values.