python-cffi: fix typos in docstring for Database.default_path

[notmuch] / bindings / python-cffi / notmuch2 / _database.py

diff --git a/bindings/python-cffi/notmuch2/_database.py b/bindings/python-cffi/notmuch2/_database.py
index 3c06402dcc35ed356850bc2d5c2cff59f5542094..c1fb88eb35c2e956fb7356559bc3041d8772a524 100644 (file)
--- a/bindings/python-cffi/notmuch2/_database.py
+++ b/bindings/python-cffi/notmuch2/_database.py
@@ -187,8 +187,8 @@ class Database(base.NotmuchObject):
 
         :param cfg_path: The pathname of the notmuch configuration file.
            If not specified tries to use the pathname provided in the
-           :env:`NOTMUCH_CONFIG` environment variable and falls back
-           to :file:`~/.notmuch-config.
+           :envvar:`NOTMUCH_CONFIG` environment variable and falls back
+           to :file:`~/.notmuch-config`.
         :type cfg_path: str, bytes, os.PathLike or pathlib.Path.
 
         :returns: The path of the database, which does not necessarily
@@ -198,7 +198,7 @@ class Database(base.NotmuchObject):
            be opened.
         :raises configparser.Error: or subclasses if the configuration
            file can not be parsed.
-        :raises NotmuchError if the config file does not have the
+        :raises NotmuchError: if the config file does not have the
            database.path setting.
         """
         if not cfg_path:
@@ -422,7 +422,7 @@ class Database(base.NotmuchObject):
            of it as ``dup = db.remove_message(name); if dup: ...``.
         :rtype: bool
 
-        :raises XapianError: A Xapian exception ocurred.
+        :raises XapianError: A Xapian exception occurred.
         :raises ReadOnlyDatabaseError: The database is opened in
            READ_ONLY mode.
         :raises UpgradeRequiredError: The database must be upgraded
@@ -458,7 +458,7 @@ class Database(base.NotmuchObject):
         :raises LookupError: If no message was found.
         :raises OutOfMemoryError: When there is no memory to allocate
            the message instance.
-        :raises XapianError: A Xapian exception ocurred.
+        :raises XapianError: A Xapian exception occurred.
         :raises ObjectDestroyedError: if used after destroyed.
         """
         msg_pp = capi.ffi.new('notmuch_message_t **')
@@ -489,7 +489,7 @@ class Database(base.NotmuchObject):
            a subclass of :exc:`KeyError`.
         :raises OutOfMemoryError: When there is no memory to allocate
            the message instance.
-        :raises XapianError: A Xapian exception ocurred.
+        :raises XapianError: A Xapian exception occurred.
         :raises ObjectDestroyedError: if used after destroyed.
         """
         if not hasattr(os, 'PathLike') and isinstance(filename, pathlib.Path):
@@ -578,7 +578,7 @@ class Database(base.NotmuchObject):
         if exclude_tags is not None:
             for tag in exclude_tags:
                 if isinstance(tag, str):
-                    tag = str.encode('utf-8')
+                    tag = tag.encode('utf-8')
                 capi.lib.notmuch_query_add_tag_exclude(query_p, tag)
         return querymod.Query(self, query_p)
 
@@ -664,6 +664,7 @@ class AtomicContext:
     def __init__(self, db, ptr_name):
         self._db = db
         self._ptr = lambda: getattr(db, ptr_name)
+        self._exit_fn = lambda: None
 
     def __del__(self):
         self._destroy()
@@ -679,18 +680,22 @@ class AtomicContext:
         ret = capi.lib.notmuch_database_begin_atomic(self._ptr())
         if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
             raise errors.NotmuchError(ret)
+        self._exit_fn = self._end_atomic
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def _end_atomic(self):
         ret = capi.lib.notmuch_database_end_atomic(self._ptr())
         if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
             raise errors.NotmuchError(ret)
 
+    def __exit__(self, exc_type, exc_value, traceback):
+        self._exit_fn()
+
     def force_end(self):
         """Force ending the atomic section.
 
         This can only be called once __exit__ has been called.  It
-        will attept to close the atomic section (again).  This is
+        will attempt to close the atomic section (again).  This is
         useful if the original exit raised an exception and the atomic
         section is still open.  But things are pretty ugly by now.
 
@@ -704,6 +709,15 @@ class AtomicContext:
         if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
             raise errors.NotmuchError(ret)
 
+    def abort(self):
+        """Abort the transaction.
+
+        Aborting a transaction will not commit any of the changes, but
+        will also implicitly close the database.
+        """
+        self._exit_fn = lambda: None
+        self._db.close()
+
 
 @functools.total_ordering
 class DbRevision: