summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorl-m-h@web.de <l-m-h@web.de>2017-12-07 12:40:50 +0100
committerDavid Bremner <david@tethera.net>2017-12-19 06:42:11 -0400
commit3444c731d27fd42bbbdaae00af6ca48b4525b03b (patch)
tree570bad6704a3ed3b945f10932cbde1e686346699
parent7a07fd8625e55d425a72af9abe45d99a1d0198cf (diff)
python: Rename get_config_list to get_configs
The old name has a bit of a feeling of hungarian notation. Also many generators in the core are named with the suffix "s" to indicate iterables: dict.items, dict.keys for example.
-rw-r--r--bindings/python/notmuch/database.py18
-rwxr-xr-xtest/T390-python.sh12
2 files changed, 8 insertions, 22 deletions
diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index 32566620..fe09b330 100644
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -689,7 +689,7 @@ class Database(object):
_config_list_destroy.argtypes = [NotmuchConfigListP]
_config_list_destroy.restype = None
- def get_config_list(self, prefix=''):
+ def get_configs(self, prefix=''):
"""Return a generator of key, value pairs where the start of key
matches the given prefix
@@ -699,7 +699,7 @@ class Database(object):
This could be used to get all named queries into a dict for example::
- queries = {k[6:]: v for k, v in db.get_config_list('query.')}
+ queries = {k[6:]: v for k, v in db.get_configs('query.')}
:param prefix: a string by which the keys should be selected
:type prefix: str
@@ -721,20 +721,6 @@ class Database(object):
yield key, value
self._config_list_move_to_next(config_list_p)
- def get_configs(self, prefix=''):
- """Return a dict of key, value pairs where the start of key matches the
- given prefix
-
- :param prefix: a string by which the keys should be selected
- :type prefix: str
- :returns: all key-value pairs where `prefix` matches the beginning
- of the key
- :rtype: a dict of str: str
- :raises: :exc:`NotmuchError` in case of failure.
-
- """
- return dict(self.get_config_list(prefix))
-
"""notmuch_database_set_config"""
_set_config = nmlib.notmuch_database_set_config
_set_config.argtypes = [NotmuchDatabaseP, c_char_p, c_char_p]
diff --git a/test/T390-python.sh b/test/T390-python.sh
index 725a00c9..c6f395e4 100755
--- a/test/T390-python.sh
+++ b/test/T390-python.sh
@@ -97,22 +97,22 @@ testkey2 = testvalue2
EOF
test_expect_equal_file EXPECTED OUTPUT
-test_begin_subtest "get_config_list with no match returns empty generator"
+test_begin_subtest "get_configs with no match returns empty generator"
test_python <<'EOF'
import notmuch
db = notmuch.Database()
-v = db.get_config_list('nonexistent')
+v = db.get_configs('nonexistent')
print(list(v) == [])
EOF
test_expect_equal "$(cat OUTPUT)" "True"
-test_begin_subtest "get_config_list with no arguments returns all pairs"
+test_begin_subtest "get_configs with no arguments returns all pairs"
test_python <<'EOF'
import notmuch
db = notmuch.Database(mode=notmuch.Database.MODE.READ_WRITE)
db.set_config("zzzafter", "afterval")
db.set_config("aaabefore", "beforeval")
-v = db.get_config_list()
+v = db.get_configs()
for index, keyval in enumerate(v):
key, val = keyval
print('{}: {} => {}'.format(index, key, val))
@@ -125,13 +125,13 @@ cat <<'EOF' >EXPECTED
EOF
test_expect_equal_file EXPECTED OUTPUT
-test_begin_subtest "get_config_list prefix is used to match keys"
+test_begin_subtest "get_configs prefix is used to match keys"
test_python <<'EOF'
import notmuch
db = notmuch.Database(mode=notmuch.Database.MODE.READ_WRITE)
db.set_config('testkey1', 'testvalue1')
db.set_config('testkey2', 'testvalue2')
-v = db.get_config_list('testkey')
+v = db.get_configs('testkey')
for index, keyval in enumerate(v):
key, val = keyval
print('{}: {} => {}'.format(index, key, val))