unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: l-m-h@web.de
To: notmuch@notmuchmail.org
Cc: Lucas Hoffmann <l-m-h@web.de>
Subject: [PATCH 5/6] python: Rename get_config_list to get_configs
Date: Thu,  7 Dec 2017 12:40:50 +0100	[thread overview]
Message-ID: <b17296bffaed4e7c7c5d93bcd43c439489333f3e.1512646265.git.l-m-h@web.de> (raw)
In-Reply-To: <cover.1512646265.git.l-m-h@web.de>
In-Reply-To: <cover.1512646265.git.l-m-h@web.de>

[-- Attachment #1: Type: text/plain, Size: 44 bytes --]

This is a multi-part message in MIME format.

[-- Attachment #2: Type: text/plain, Size: 354 bytes --]


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.
---
 bindings/python/notmuch/database.py | 18 ++----------------
 test/T390-python.sh                 | 12 ++++++------
 2 files changed, 8 insertions(+), 22 deletions(-)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0005-python-Rename-get_config_list-to-get_configs.patch --]
[-- Type: text/x-patch; name="0005-python-Rename-get_config_list-to-get_configs.patch", Size: 3382 bytes --]

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))

  parent reply	other threads:[~2017-12-07 11:48 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-04 17:20 [PATCH 1/2] python: add bindings for notmuch_database_get_config{, _list} l-m-h
2017-06-04 17:20 ` [PATCH 2/2] python: add convenience function to get named queries l-m-h
2017-06-10 11:37   ` David Bremner
2017-06-10 11:10 ` [PATCH 1/2] python: add bindings for notmuch_database_get_config{, _list} David Bremner
2017-06-20 20:06   ` Lucas Hoffmann
2017-06-26 23:19     ` David Bremner
2017-12-07 11:40       ` [PATCH 0/6] " l-m-h
2017-12-19 11:13         ` David Bremner
2017-12-07 11:40       ` [PATCH 1/6] python: add bindings to access config l-m-h
2017-12-07 11:40       ` [PATCH 2/6] python: add default arg to get_config_list l-m-h
2017-12-07 11:40       ` [PATCH 3/6] python: turn get_config_list into a generator l-m-h
2017-12-07 11:40       ` [PATCH 4/6] test: Add tests for new python bindings l-m-h
2017-12-07 11:40       ` l-m-h [this message]
2017-12-22 21:59         ` [PATCH 5/6] python: Rename get_config_list to get_configs David Bremner
2017-12-22 22:26           ` [PATCH 0/1] " l-m-h
2017-12-22 22:26           ` [PATCH 1/1] python: Fix method name in docs l-m-h
2017-12-24 14:05             ` David Bremner
2017-12-07 11:40       ` [PATCH 6/6] test: Add test to unset config items with the python bindings l-m-h

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b17296bffaed4e7c7c5d93bcd43c439489333f3e.1512646265.git.l-m-h@web.de \
    --to=l-m-h@web.de \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).