mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-22 19:08:09 +01:00
1bca41698a
This fixes some minor style/pep8 things and adds tests for the new config support. Also fixes a bug where KeyError was never raised on a missing key.
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
import collections.abc
|
|
|
|
import notmuch2._base as base
|
|
import notmuch2._capi as capi
|
|
import notmuch2._errors as errors
|
|
|
|
|
|
__all__ = ['ConfigMapping']
|
|
|
|
|
|
class ConfigIter(base.NotmuchIter):
|
|
|
|
def __init__(self, parent, iter_p):
|
|
super().__init__(
|
|
parent, iter_p,
|
|
fn_destroy=capi.lib.notmuch_config_list_destroy,
|
|
fn_valid=capi.lib.notmuch_config_list_valid,
|
|
fn_get=capi.lib.notmuch_config_list_key,
|
|
fn_next=capi.lib.notmuch_config_list_move_to_next)
|
|
|
|
def __next__(self):
|
|
item = super().__next__()
|
|
return base.BinString.from_cffi(item)
|
|
|
|
|
|
class ConfigMapping(base.NotmuchObject, collections.abc.MutableMapping):
|
|
"""The config key/value pairs stored in the database.
|
|
|
|
The entries are exposed as a :class:`collections.abc.MutableMapping` object.
|
|
Note that setting a value to an empty string is the same as deleting it.
|
|
|
|
:param parent: the parent object
|
|
:param ptr_name: the name of the attribute on the parent which will
|
|
return the memory pointer. This allows this object to
|
|
access the pointer via the parent's descriptor and thus
|
|
trigger :class:`MemoryPointer`'s memory safety.
|
|
"""
|
|
|
|
def __init__(self, parent, ptr_name):
|
|
self._parent = parent
|
|
self._ptr = lambda: getattr(parent, ptr_name)
|
|
|
|
@property
|
|
def alive(self):
|
|
return self._parent.alive
|
|
|
|
def _destroy(self):
|
|
pass
|
|
|
|
def __getitem__(self, key):
|
|
if isinstance(key, str):
|
|
key = key.encode('utf-8')
|
|
val_pp = capi.ffi.new('char**')
|
|
ret = capi.lib.notmuch_database_get_config(self._ptr(), key, val_pp)
|
|
if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
|
|
raise errors.NotmuchError(ret)
|
|
val = base.BinString.from_cffi(val_pp[0])
|
|
capi.lib.free(val_pp[0])
|
|
if val == '':
|
|
raise KeyError
|
|
return val
|
|
|
|
def __setitem__(self, key, val):
|
|
if isinstance(key, str):
|
|
key = key.encode('utf-8')
|
|
if isinstance(val, str):
|
|
val = val.encode('utf-8')
|
|
ret = capi.lib.notmuch_database_set_config(self._ptr(), key, val)
|
|
if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
|
|
raise errors.NotmuchError(ret)
|
|
|
|
def __delitem__(self, key):
|
|
self[key] = ""
|
|
|
|
def __iter__(self):
|
|
"""Return an iterator over the config items.
|
|
|
|
:raises NullPointerError: If the iterator can not be created.
|
|
"""
|
|
configlist_pp = capi.ffi.new('notmuch_config_list_t**')
|
|
ret = capi.lib.notmuch_database_get_config_list(self._ptr(), b'', configlist_pp)
|
|
if ret != capi.lib.NOTMUCH_STATUS_SUCCESS:
|
|
raise errors.NotmuchError(ret)
|
|
return ConfigIter(self._parent, configlist_pp[0])
|
|
|
|
def __len__(self):
|
|
return sum(1 for t in self)
|