debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 02:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: add default arg to get_config_list

Browse source 
It makes the function a little more intuitive to use and does not
diverge much from the original function signature.

Also an example is added to the docstring.
This commit is contained in:
l-m-h@web.de 2017-12-07 12:40:47 +01:00 committed by David Bremner
parent 6c6b0f13ff
commit c536de3afb
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
bindings/python/notmuch/database.py
View file

@ -313,7 +313,7 @@ class Database(object):
""" """
self._assert_db_is_initialized() self._assert_db_is_initialized()
status = Database._upgrade(self._db, None, None) status = Database._upgrade(self._db, None, None)
#TODO: catch exceptions, document return values and etc # TODO: catch exceptions, document return values and etc
return status return status
_begin_atomic = nmlib.notmuch_database_begin_atomic _begin_atomic = nmlib.notmuch_database_begin_atomic
@ -689,12 +689,19 @@ class Database(object):
_config_list_destroy.argtypes = [NotmuchConfigListP] _config_list_destroy.argtypes = [NotmuchConfigListP]
_config_list_destroy.restype = None _config_list_destroy.restype = None
def get_config_list(self, prefix): def get_config_list(self, prefix=''):
"""Return a list of key, value pairs where the start of key matches the """Return a list of key, value pairs where the start of key matches the
given prefix given prefix
Note that only config values that are stored in the database are Note that only config values that are stored in the database are
searched and returned. The config file is not read. searched and returned. The config file is not read. If no `prefix` is
given all config values are returned.
This could be used to get all config values or all named queries into a
dict for example::
config = {k: v for k, v in db.get_config_list()}
queries = {k[6:]: v for k, v in db.get_config_list('query.')}
:param prefix: a string by which the keys should be selected :param prefix: a string by which the keys should be selected
:type prefix: str :type prefix: str