Try and clarify the official API bits in __init__

crobinso · crobinso · commit 6a16ed538584 · 2012-12-28T17:09:21.000-05:00
Export BugzillaError but remove the other exceptions which were barely
used.
diff --git a/bugzilla/__init__.py b/bugzilla/__init__.py
@@ -18,18 +18,12 @@
 log = logging.getLogger("bugzilla")
 
 
+from bugzilla.base import BugzillaError
 from bugzilla.bugzilla3 import Bugzilla3, Bugzilla32, Bugzilla34, Bugzilla36
-from bugzilla.bugzilla4 import Bugzilla4
+from bugzilla.bugzilla4 import Bugzilla4, Bugzilla42, Bugzilla44
 from bugzilla.nvlbugzilla import NovellBugzilla
 from bugzilla.rhbugzilla import RHBugzilla, RHBugzilla3, RHBugzilla4
 
-# advertised class list
-classlist = ['Bugzilla3', 'Bugzilla32', 'Bugzilla34',
-             'Bugzilla36', 'Bugzilla4', 'RHBugzilla3', 'RHBugzilla4',
-             'NovellBugzilla']
-
-
-
 
 def getBugzillaClassForURL(url):
     log.debug("Choosing subclass for %s" % url)
@@ -60,10 +54,16 @@ def getBugzillaClassForURL(url):
     # note preference order: RHBugzilla* wins if available
     if rhbz:
         c = RHBugzilla
-    else:
-        if bzversion.startswith("4."):
+    elif bzversion.startswith("4."):
+        if bzversion.startswith("4.0"):
             c = Bugzilla4
-        elif bzversion.startswith('3.6'):
+        elif bzversion.startswith("4.2"):
+            c = Bugzilla42
+        else:
+            log.debug("No explicit match for %s, using latest bz4" % bzversion)
+            c = Bugzilla44
+    else:
+        if bzversion.startswith('3.6'):
             c = Bugzilla36
         elif bzversion.startswith('3.4'):
             c = Bugzilla34
@@ -77,9 +77,11 @@ def getBugzillaClassForURL(url):
 
 
 class Bugzilla(object):
-    '''Magical Bugzilla class that figures out which Bugzilla implementation
+    '''
+    Magical Bugzilla class that figures out which Bugzilla implementation
     to use and uses that. Requires 'url' parameter so we can check available
-    XMLRPC methods to determine the Bugzilla version.'''
+    XMLRPC methods to determine the Bugzilla version.
+    '''
     def __init__(self, **kwargs):
         log.info("Bugzilla v%s initializing" % __version__)
         if 'url' not in kwargs:
@@ -89,10 +91,28 @@ def __init__(self, **kwargs):
         # Use of __init__ of non parent class
 
         c = getBugzillaClassForURL(kwargs['url'])
+        if not c:
+            raise ValueError("Couldn't determine Bugzilla version for %s" %
+                             kwargs['url'])
+
         if c:
             self.__class__ = c
             c.__init__(self, **kwargs)
             log.info("Chose subclass %s v%s" % (c.__name__, c.version))
-        else:
-            raise ValueError("Couldn't determine Bugzilla version for %s" %
-                             kwargs['url'])
+
+# This is the list of possible Bugzilla instances an app can use,
+# bin/bugzilla uses it for the --bztype field
+classlist = [
+    "Bugzilla3", "Bugzilla32", "Bugzilla34", "Bugzilla36",
+    "Bugzilla4", "Bugzilla42", "Bugzilla44",
+    "RHBugzilla3", "RHBugzilla4", "RHBugzilla",
+    "NovellBugzilla",
+]
+
+# This is the public API. If you are explicitly instantiating any other
+# class, using some function, or poking into internal files, don't complain
+# if things break on you.
+__all__ = classlist + [
+    'BugzillaError',
+    'Bugzilla',
+]
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -25,22 +25,6 @@ class BugzillaError(Exception):
     pass
 
 
-class NeedSyncError(BugzillaError):
-    '''Must save data from this class to the bugzilla server before using this.
-    '''
-    pass
-
-
-class NeedParamError(BugzillaError):
-    '''A necessary parameter was left out.'''
-    pass
-
-
-class LoadError(BugzillaError):
-    '''Error loading credentials'''
-    pass
-
-
 def replace_getbug_errors_with_None(rawlist):
     '''r is a raw xmlrpc response.
     If it represents an error, None is returned.
@@ -1370,7 +1354,7 @@ def updateperms(self, action, groups):
         :arg groups: list of groups to be added to (i.e. ['fedora_contrib'])
         '''
         if self._name_dirty:
-            raise NeedSyncError('name has been changed.  run update() before'
+            raise BugzillaError('name has been changed.  run update() before'
                     ' updating perms.')
         self.bugzilla._updateperms(self.name, action, groups)
 
diff --git a/bugzilla/bugzilla3.py b/bugzilla/bugzilla3.py
@@ -9,10 +9,11 @@
 # option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
 # the full text of the license.
 
-import bugzilla.base
+from bugzilla import BugzillaError
+from bugzilla.base import BugzillaBase
 
 
-class Bugzilla3(bugzilla.base.BugzillaBase):
+class Bugzilla3(BugzillaBase):
     '''Concrete implementation of the Bugzilla protocol. This one uses the
     methods provided by standard Bugzilla 3.0.x releases.'''
 
@@ -21,7 +22,7 @@ class Bugzilla3(bugzilla.base.BugzillaBase):
     bz_ver_minor = 0
 
     def __init__(self, **kwargs):
-        bugzilla.base.BugzillaBase.__init__(self, **kwargs)
+        BugzillaBase.__init__(self, **kwargs)
 
     def _login(self, user, password):
         '''Backend login method for Bugzilla3'''
@@ -177,8 +178,8 @@ def _getusers(self, ids=None, names=None, match=None):
         if match:
             params['match'] = match
         if not params:
-            raise bugzilla.base.NeedParamError('_get() needs one of ids, '
-                    ' names, or match kwarg.')
+            raise BugzillaError('_get() needs one of ids, '
+                                ' names, or match kwarg.')
 
         return self._proxy.User.get(params)
 
diff --git a/bugzilla/nvlbugzilla.py b/bugzilla/nvlbugzilla.py
@@ -17,8 +17,7 @@
 import urllib2
 import urlparse
 
-from bugzilla import Bugzilla32, log
-from bugzilla.base import BugzillaError
+from bugzilla import BugzillaError, Bugzilla32, log
 
 
 class NovellBugzilla(Bugzilla32):
