summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWill Woods <wwoods@redhat.com>2008-08-26 16:21:36 -0400
committerWill Woods <wwoods@redhat.com>2008-08-26 16:21:36 -0400
commite22c1f4fbfb268cf4970ae874e8d5988cb5f834f (patch)
tree8f26a2f7ec840664025bb6c37779896c193dd653
parented5255764779dbbee7d6fba22d6b24b04e7853bd (diff)
downloadpython-bugzilla-e22c1f4fbfb268cf4970ae874e8d5988cb5f834f.zip
python-bugzilla-e22c1f4fbfb268cf4970ae874e8d5988cb5f834f.tar.gz
python-bugzilla-e22c1f4fbfb268cf4970ae874e8d5988cb5f834f.tar.xz
Move multicall methods to RHBugzilla, since they're RH-specific
-rw-r--r--bugzilla/base.py61
-rw-r--r--bugzilla/rhbugzilla.py66
2 files changed, 65 insertions, 62 deletions
diff --git a/bugzilla/base.py b/bugzilla/base.py
index 6b7aa0d..eb53f46 100644
--- a/bugzilla/base.py
+++ b/bugzilla/base.py
@@ -55,9 +55,6 @@ class BugzillaBase(object):
Be sure to set appropriate permissions on bugzillarc if you choose to
store your password in it!
- The methods which start with a single underscore are thin wrappers around
- xmlrpc calls; those should be safe for multicall usage.
-
This is an abstract class; it must be implemented by a concrete subclass
which actually connects the methods provided here to the appropriate
methods on the bugzilla instance.
@@ -220,41 +217,6 @@ class BugzillaBase(object):
#---- Methods and properties with basic bugzilla info
- # FIXME MultiCall support is a RHism, so this should move into rhbugzilla
- def _multicall(self):
- '''This returns kind of a mash-up of the Bugzilla object and the
- xmlrpclib.MultiCall object. Methods you call on this object will be added
- to the MultiCall queue, but they will return None. When you're ready, call
- the run() method and all the methods in the queue will be run and the
- results of each will be returned in a list. So, for example:
-
- mc = bz._multicall()
- mc._getbug(1)
- mc._getbug(1337)
- mc._query({'component':'glibc','product':'Fedora','version':'devel'})
- (bug1, bug1337, queryresult) = mc.run()
-
- Note that you should only use the raw xmlrpc calls (mostly the methods
- starting with an underscore). Normal getbug(), for example, tries to
- return a Bug object, but with the multicall object it'll end up empty
- and, therefore, useless.
-
- Further note that run() returns a list of raw xmlrpc results; you'll
- need to wrap the output in Bug objects yourself if you're doing that
- kind of thing. For example, Bugzilla.getbugs() could be implemented:
-
- mc = self._multicall()
- for id in idlist:
- mc._getbug(id)
- rawlist = mc.run()
- return [Bug(self,dict=b) for b in rawlist]
- '''
- mc = copy.copy(self)
- mc._proxy = xmlrpclib.MultiCall(self._proxy)
- def run(): return mc._proxy().results
- mc.run = run
- return mc
-
def _getbugfields(self):
'''IMPLEMENT ME: Get bugfields from Bugzilla.'''
raise NotImplementedError
@@ -366,29 +328,6 @@ class BugzillaBase(object):
d = self.getcomponentsdetails(product,force_refresh)
return d[component]
- def _get_info(self,product=None):
- '''This is a convenience method that does getqueryinfo, getproducts,
- and (optionally) getcomponents in one big fat multicall. This is a bit
- faster than calling them all separately.
-
- If you're doing interactive stuff you should call this, with the
- appropriate product name, after connecting to Bugzilla. This will
- cache all the info for you and save you an ugly delay later on.'''
- mc = self._multicall()
- mc._getqueryinfo()
- mc._getproducts()
- mc._getbugfields()
- if product:
- mc._getcomponents(product)
- mc._getcomponentsdetails(product)
- r = mc.run()
- (self._querydata,self._querydefaults) = r.pop(0)
- self._products = r.pop(0)
- self._bugfields = r.pop(0)
- if product:
- self._components[product] = r.pop(0)
- self._components_details[product] = r.pop(0)
-
#---- Methods for reading bugs and bug info
def _getbug(self,id):
diff --git a/bugzilla/rhbugzilla.py b/bugzilla/rhbugzilla.py
index 3cbc83c..d7d6295 100644
--- a/bugzilla/rhbugzilla.py
+++ b/bugzilla/rhbugzilla.py
@@ -14,7 +14,15 @@ from bugzilla3 import Bugzilla32
class RHBugzilla(bugzilla.base.BugzillaBase):
'''Concrete implementation of the Bugzilla protocol. This one uses the
- methods provided by Red Hat's Bugzilla 2.18 variant.'''
+ methods provided by Red Hat's Bugzilla 2.18 variant.
+
+ RHBugzilla supports XMLRPC MultiCall. The methods which start with a
+ single underscore are thin wrappers around XMLRPC methods and should thus
+ be safe for multicall use.
+
+ Documentation for most of these methods can be found here:
+ https://bugzilla.redhat.com/docs/en/html/api/extensions/compat_xmlrpc/code/webservice.html
+ '''
version = '0.2'
user_agent = bugzilla.base.user_agent + ' RHBugzilla/%s' % version
@@ -36,6 +44,40 @@ class RHBugzilla(bugzilla.base.BugzillaBase):
#---- Methods and properties with basic bugzilla info
+ def _multicall(self):
+ '''This returns kind of a mash-up of the Bugzilla object and the
+ xmlrpclib.MultiCall object. Methods you call on this object will be
+ added to the MultiCall queue, but they will return None. When you're
+ ready, call the run() method and all the methods in the queue will be
+ run and the results of each will be returned in a list. So, for example:
+
+ mc = bz._multicall()
+ mc._getbug(1)
+ mc._getbug(1337)
+ mc._query({'component':'glibc','product':'Fedora','version':'devel'})
+ (bug1, bug1337, queryresult) = mc.run()
+
+ Note that you should only use the raw xmlrpc calls (mostly the methods
+ starting with an underscore). Normal getbug(), for example, tries to
+ return a Bug object, but with the multicall object it'll end up empty
+ and, therefore, useless.
+
+ Further note that run() returns a list of raw xmlrpc results; you'll
+ need to wrap the output in Bug objects yourself if you're doing that
+ kind of thing. For example, Bugzilla.getbugs() could be implemented:
+
+ mc = self._multicall()
+ for id in idlist:
+ mc._getbug(id)
+ rawlist = mc.run()
+ return [Bug(self,dict=b) for b in rawlist]
+ '''
+ mc = copy.copy(self)
+ mc._proxy = xmlrpclib.MultiCall(self._proxy)
+ def run(): return mc._proxy().results
+ mc.run = run
+ return mc
+
# Connect the backend methods to the XMLRPC methods
def _getbugfields(self):
return self._proxy.bugzilla.getBugFields()
@@ -61,6 +103,28 @@ class RHBugzilla(bugzilla.base.BugzillaBase):
if type(product) == int:
product = self._product_id_to_name(product)
return self._proxy.bugzilla.getProdCompDetails(product)
+ def _get_info(self,product=None):
+ '''This is a convenience method that does getqueryinfo, getproducts,
+ and (optionally) getcomponents in one big fat multicall. This is a bit
+ faster than calling them all separately.
+
+ If you're doing interactive stuff you should call this, with the
+ appropriate product name, after connecting to Bugzilla. This will
+ cache all the info for you and save you an ugly delay later on.'''
+ mc = self._multicall()
+ mc._getqueryinfo()
+ mc._getproducts()
+ mc._getbugfields()
+ if product:
+ mc._getcomponents(product)
+ mc._getcomponentsdetails(product)
+ r = mc.run()
+ (self._querydata,self._querydefaults) = r.pop(0)
+ self._products = r.pop(0)
+ self._bugfields = r.pop(0)
+ if product:
+ self._components[product] = r.pop(0)
+ self._components_details[product] = r.pop(0)
#---- Methods for reading bugs and bug info