Factor out rc-handling and listify

djmitche · crobinso · commit 3776bf33fbe1 · 2019-12-31T18:02:26.000-05:00
This is in preparation for #75. Reviewed-by: Cole Robinson <crobinso@redhat.com>
diff --git a/bugzilla/_cli.py b/bugzilla/_cli.py
@@ -101,8 +101,8 @@ def get_default_url():
     """
     Grab a default URL from bugzillarc [DEFAULT] url=X
     """
-    from bugzilla.base import _open_bugzillarc
-    cfg = _open_bugzillarc()
+    from bugzilla._rc import open_bugzillarc
+    cfg = open_bugzillarc()
     if cfg:
         cfgurl = cfg.defaults().get("url", None)
         if cfgurl is not None:
diff --git a/bugzilla/_rc.py b/bugzilla/_rc.py
@@ -0,0 +1,43 @@
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
+# the full text of the license.
+
+import os
+import sys
+from logging import getLogger
+
+# pylint: disable=import-error,no-name-in-module,ungrouped-imports
+if sys.version_info[0] >= 3:
+    from configparser import ConfigParser
+else:
+    from ConfigParser import SafeConfigParser as ConfigParser
+# pylint: enable=import-error,no-name-in-module,ungrouped-imports
+
+from ._util import listify
+
+log = getLogger(__name__)
+
+DEFAULT_CONFIGPATHS = [
+    '/etc/bugzillarc',
+    '~/.bugzillarc',
+    '~/.config/python-bugzilla/bugzillarc',
+]
+
+
+def open_bugzillarc(configpaths=-1):
+    if configpaths == -1:
+        configpaths = DEFAULT_CONFIGPATHS[:]
+
+    # pylint: disable=protected-access
+    configpaths = [os.path.expanduser(p) for p in
+                   listify(configpaths)]
+    # pylint: enable=protected-access
+    cfg = ConfigParser()
+    read_files = cfg.read(configpaths)
+    if not read_files:
+        return
+
+    log.info("Found bugzillarc files: %s", read_files)
+    return cfg
diff --git a/bugzilla/_util.py b/bugzilla/_util.py
@@ -0,0 +1,15 @@
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
+# the full text of the license.
+
+
+def listify(val):
+    """Ensure that value is either None or a list, converting single values
+    into 1-element lists"""
+    if val is None:
+        return val
+    if isinstance(val, list):
+        return val
+    return [val]
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -34,6 +34,8 @@
 # pylint: enable=import-error,no-name-in-module,ungrouped-imports
 
 
+from ._util import listify
+from ._rc import DEFAULT_CONFIGPATHS, open_bugzillarc
 from .apiversion import __version__
 from .bug import Bug, User
 from .transport import BugzillaError, _BugzillaServerProxy, _RequestsTransport
@@ -105,30 +107,6 @@ def _build_cookiejar(cookiefile):
                             cookiefile)
 
 
-_default_configpaths = [
-    '/etc/bugzillarc',
-    '~/.bugzillarc',
-    '~/.config/python-bugzilla/bugzillarc',
-]
-
-
-def _open_bugzillarc(configpaths=-1):
-    if configpaths == -1:
-        configpaths = _default_configpaths[:]
-
-    # pylint: disable=protected-access
-    configpaths = [os.path.expanduser(p) for p in
-                   Bugzilla._listify(configpaths)]
-    # pylint: enable=protected-access
-    cfg = ConfigParser()
-    read_files = cfg.read(configpaths)
-    if not read_files:
-        return
-
-    log.info("Found bugzillarc files: %s", read_files)
-    return cfg
-
-
 def _save_api_key(url, api_key):
     """
     Save the API_KEY in the config file.
@@ -275,15 +253,6 @@ def fix_url(url):
             log.debug("Generated fixed URL: %s", newurl)
         return newurl
 
-    @staticmethod
-    def _listify(val):
-        if val is None:
-            return val
-        if isinstance(val, list):
-            return val
-        return [val]
-
-
     def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
                  sslverify=True, tokenfile=-1, use_creds=True, api_key=None,
                  cert=None, configpaths=-1, basic_auth=False):
@@ -348,7 +317,7 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         if tokenfile == -1:
             tokenfile = _default_cache_location("bugzillatoken")
         if configpaths == -1:
-            configpaths = _default_configpaths[:]
+            configpaths = DEFAULT_CONFIGPATHS[:]
 
         log.debug("Using tokenfile=%s", tokenfile)
         self.cookiefile = cookiefile
@@ -512,7 +481,7 @@ def readconfig(self, configpath=None, overwrite=True):
         :param overwrite: If True, bugzillarc will clobber any already
             set self.user/password/api_key/cert value.
         """
-        cfg = _open_bugzillarc(configpath or self.configpath)
+        cfg = open_bugzillarc(configpath or self.configpath)
         if not cfg:
             return
 
@@ -826,9 +795,9 @@ def product_get(self, ids=None, names=None,
 
         kwargs = {}
         if ids:
-            kwargs["ids"] = self._listify(ids)
+            kwargs["ids"] = listify(ids)
         if names:
-            kwargs["names"] = self._listify(names)
+            kwargs["names"] = listify(names)
         if include_fields:
             kwargs["include_fields"] = include_fields
         if exclude_fields:
@@ -1097,7 +1066,7 @@ def _getbugs(self, idlist, permissive,
                 # String aliases can be passed as well
                 idlist.append(i)
 
-        extra_fields = self._listify(extra_fields or [])
+        extra_fields = listify(extra_fields or [])
         extra_fields += self._getbug_extra_fields
 
         getbugdata = {"ids": idlist}
@@ -1122,7 +1091,7 @@ def _getbugs(self, idlist, permissive,
             else:
                 # Need to map an alias
                 for valdict in bugdict.values():
-                    if i in self._listify(valdict.get("alias", None) or []):
+                    if i in listify(valdict.get("alias", None) or []):
                         found = valdict
                         break
 
@@ -1243,8 +1212,8 @@ def build_query(self,
 
         query = {
             "alias": alias,
-            "product": self._listify(product),
-            "component": self._listify(component),
+            "product": listify(product),
+            "component": listify(component),
             "version": version,
             "id": bug_id,
             "short_desc": short_desc,
@@ -1253,17 +1222,17 @@ def build_query(self,
             "priority": priority,
             "target_release": target_release,
             "target_milestone": target_milestone,
-            "tag": self._listify(tags),
+            "tag": listify(tags),
             "quicksearch": quicksearch,
             "savedsearch": savedsearch,
             "sharer_id": savedsearch_sharer_id,
 
             # RH extensions... don't add any more. See comment below
-            "sub_components": self._listify(sub_component),
+            "sub_components": listify(sub_component),
         }
 
         def add_bool(bzkey, value, bool_id, booltype=None):
-            value = self._listify(value)
+            value = listify(value)
             if value is None:
                 return bool_id
 
@@ -1394,7 +1363,7 @@ def update_bugs(self, ids, updates):
         build_update(), otherwise we cannot guarantee back compatibility.
         """
         tmp = updates.copy()
-        tmp["ids"] = self._listify(ids)
+        tmp["ids"] = listify(ids)
 
         return self._proxy.Bug.update(tmp)
 
@@ -1404,12 +1373,12 @@ def update_tags(self, idlist, tags_add=None, tags_remove=None):
         """
         tags = {}
         if tags_add:
-            tags["add"] = self._listify(tags_add)
+            tags["add"] = listify(tags_add)
         if tags_remove:
-            tags["remove"] = self._listify(tags_remove)
+            tags["remove"] = listify(tags_remove)
 
         d = {
-            "ids": self._listify(idlist),
+            "ids": listify(idlist),
             "tags": tags,
         }
 
@@ -1506,7 +1475,7 @@ def add_dict(key, add, remove, _set=None, convert=None):
                 return
 
             def c(val):
-                val = self._listify(val)
+                val = listify(val)
                 if convert:
                     val = [convert(v) for v in val]
                 return val
@@ -1548,7 +1517,7 @@ def c(val):
         s("whiteboard", whiteboard)
         s("work_time", work_time, float)
         s("flags", flags)
-        s("comment_tags", comment_tags, self._listify)
+        s("comment_tags", comment_tags, listify)
 
         add_dict("blocks", blocks_add, blocks_remove, blocks_set,
                  convert=int)
@@ -1629,7 +1598,7 @@ def attachfile(self, idlist, attachfile, description, **kwargs):
             data = data.encode(locale.getpreferredencoding())
         kwargs['data'] = Binary(data)
 
-        kwargs['ids'] = self._listify(idlist)
+        kwargs['ids'] = listify(idlist)
 
         if 'file_name' not in kwargs and hasattr(f, "name"):
             kwargs['file_name'] = os.path.basename(f.name)
@@ -1697,13 +1666,13 @@ def get_attachments(self, ids, attachment_ids,
         https://bugzilla.readthedocs.io/en/latest/api/core/v1/attachment.html#get-attachment
         """
         params = {
-            "ids": self._listify(ids) or [],
-            "attachment_ids": self._listify(attachment_ids) or [],
+            "ids": listify(ids) or [],
+            "attachment_ids": listify(attachment_ids) or [],
         }
         if include_fields:
-            params["include_fields"] = self._listify(include_fields)
+            params["include_fields"] = listify(include_fields)
         if exclude_fields:
-            params["exclude_fields"] = self._listify(exclude_fields)
+            params["exclude_fields"] = listify(exclude_fields)
 
         return self._proxy.Bug.attachments(params)
 
@@ -1751,15 +1720,15 @@ def build_createbug(self,
 
         localdict = {}
         if blocks:
-            localdict["blocks"] = self._listify(blocks)
+            localdict["blocks"] = listify(blocks)
         if cc:
-            localdict["cc"] = self._listify(cc)
+            localdict["cc"] = listify(cc)
         if depends_on:
-            localdict["depends_on"] = self._listify(depends_on)
+            localdict["depends_on"] = listify(depends_on)
         if groups:
-            localdict["groups"] = self._listify(groups)
+            localdict["groups"] = listify(groups)
         if keywords:
-            localdict["keywords"] = self._listify(keywords)
+            localdict["keywords"] = listify(keywords)
         if description:
             localdict["description"] = description
             if comment_private:
@@ -1845,11 +1814,11 @@ def _getusers(self, ids=None, names=None, match=None):
         """
         params = {}
         if ids:
-            params['ids'] = self._listify(ids)
+            params['ids'] = listify(ids)
         if names:
-            params['names'] = self._listify(names)
+            params['names'] = listify(names)
         if match:
-            params['match'] = self._listify(match)
+            params['match'] = listify(match)
         if not params:
             raise BugzillaError('_get() needs one of ids, '
                                 ' names, or match kwarg.')
@@ -1925,14 +1894,14 @@ def updateperms(self, user, action, groups):
         :arg action: add, remove, or set
         :arg groups: list of groups to be added to (i.e. ['fedora_contrib'])
         """
-        groups = self._listify(groups)
+        groups = listify(groups)
         if action == "rem":
             action = "remove"
         if action not in ["add", "remove", "set"]:
             raise BugzillaError("Unknown user permission action '%s'" % action)
 
         update = {
-            "names": self._listify(user),
+            "names": listify(user),
             "groups": {
                 action: groups,
             }
diff --git a/bugzilla/rhbugzilla.py b/bugzilla/rhbugzilla.py
