Specify all logging string format args as function parameters

As warned about by pylint.

Author: crobinso

tests/clonetest.py

@@ -180,7 +180,7 @@ def testRemoteWithStorage(self):
                                          "when it shouldn't.")
                 except (ValueError, RuntimeError), e:
                     # Exception expected
-                    logging.debug("Received expected exception: %s" % str(e))
+                    logging.debug("Received expected exception: %s", str(e))
         finally:
             CloneManager._util.is_uri_remote = oldfunc
 
@@ -229,4 +229,4 @@ def testCloneManagedToUnmanaged(self):
             raise AssertionError("Managed to unmanaged succeeded, expected "
                                  "failure.")
         except (ValueError, RuntimeError), e:
-            logging.debug("Received expected exception: %s" % str(e))
+            logging.debug("Received expected exception: %s", str(e))

tests/interface.py

@@ -71,7 +71,7 @@ def define_xml(self, obj, compare=True):
         iface = obj.install()
 
         newxml = iface.XMLDesc(0)
-        logging.debug("Defined XML:\n%s" % newxml)
+        logging.debug("Defined XML:\n%s", newxml)
 
         iface.undefine()
 

tests/pylint-virtinst.sh

@@ -97,6 +97,7 @@ addchecker() {
 addmsg_support() {
     out=`pylint --list-msgs 2>&1`
     if `echo $out | grep -q $1` ; then
+        echo "adding!"
         addmsg "$1"
     fi
 }
@@ -114,20 +115,18 @@ addmsg "W0703"  # W0703: Catch 'Exception'
 addmsg "W0704"  # W0704: Exception doesn't do anything
 addmsg "W0702"  # W0702: No exception type specified
 addmsg "R0201"  # R0201: Method could be a function
+addchecker "Design" # Things like "Too many func arguments",
+                    #             "Too man public methods"
 
 # Possibly useful at some point
 addmsg "W0403"  # W0403: Relative imports
-addmsg "W0511"  # W0511: FIXME and XXX: messages (useful in the future)
+addmsg "W0511"  # W0511: FIXME and XXX: messages
 addmsg "R0401"  # R0401: Cyclic imports
+addchecker "Similarities"   # Finds duplicate code
 
 # Not supported in many pylint versions
-addmsg_support "W6501"  # W6501: Using string formatters in logging message
-                        #        (see help message for info)
+# Put new messages here with addmsg_support
 
-# Disabled Checkers:
-addchecker "Design"         # Things like "Too many func arguments",
-                            #             "Too man public methods"
-addchecker "Similarities"   # Finds duplicate code (enable this later?)
 
 AWK=awk
 [ `uname -s` = 'SunOS' ] && AWK=nawk

tests/urltest.py

@@ -242,22 +242,22 @@ def _fetchLocalMedia(self, mediapath):
 
             # Make sure we detect _a_ distro
             hvmstore = self._getStore(fetcher, mediapath, "hvm", arch)
-            logging.debug("Local distro detected as: %s" % hvmstore)
+            logging.debug("Local distro detected as: %s", hvmstore)
         finally:
             fetcher.cleanupLocation()
 
 
     def _fetchFromURLDict(self, distname, url, arch, distro_info, check_xen):
-        logging.debug("\nDistro='%s' arch='%s' url=%s" % \
-                      (distname, arch, url))
+        logging.debug("\nDistro='%s' arch='%s' url=%s",
+                      distname, arch, url)
 
         fetcher = OSDistro._fetcherForURI(url, "/tmp")
         try:
             fetcher.prepareLocation()
         except Exception, e:
             # Don't raise an error here: the site might be down atm
-            logging.error("%s-%s: Couldn't access url %s: %s. Skipping." % \
-                          (distname, arch, fetcher.location, str(e)))
+            logging.error("%s-%s: Couldn't access url %s: %s. Skipping.",
+                          distname, arch, fetcher.location, str(e))
             fetcher.cleanupLocation()
             return
 
@@ -303,8 +303,8 @@ def _grabURLMedia(self, fetcher, distname, url, arch, distro_info,
         exp_store = distroClass(distname)
         for s in [hvmstore, xenstore]:
             if s and not isinstance(s, exp_store):
-                logging.error("(%s): expected store %s, was %s" % \
-                              (distname, exp_store, s))
+                logging.error("(%s): expected store %s, was %s",
+                              distname, exp_store, s)
                 self.fail()
 
         # Make sure the stores are reporting correct distro name/variant
@@ -318,7 +318,7 @@ def fakeAcquireFile(filename, meter):
             if not isinstance(meter, urlgrabber.progress.BaseMeter):
                 raise ValueError("passed meter is '%s' not an"
                                  " actual meter." % meter)
-            logging.debug("Fake acquiring %s" % filename)
+            logging.debug("Fake acquiring %s", filename)
             return fetcher.hasFile(filename)
 
         # Replace acquireFile with hasFile, so we don't actually have to fetch
@@ -328,47 +328,47 @@ def fakeAcquireFile(filename, meter):
         # Fetch boot iso
         try:
             if re.match(r"%s" % NOBOOTISO_FILTER, distname):
-                logging.debug("Known lack of boot.iso in %s tree. Skipping." \
-                              % distname)
+                logging.debug("Known lack of boot.iso in %s tree. Skipping.",
+                              distname)
             else:
                 boot = hvmstore.acquireBootDisk(testguest, fetcher, self.meter)
-                logging.debug("acquireBootDisk: %s" % str(boot))
+                logging.debug("acquireBootDisk: %s", str(boot))
 
                 if boot != True:
                     raise RuntimeError("Didn't fetch any boot iso.")
         except Exception, e:
-            logging.exception("%s-%s: bootdisk fetching: %s" %
-                              (distname, arch, str(e)))
+            logging.exception("%s-%s: bootdisk fetching: %s",
+                              distname, arch, str(e))
             self.fail()
 
         # Fetch regular kernel
         try:
             kern = hvmstore.acquireKernel(testguest, fetcher, self.meter)
-            logging.debug("acquireKernel (hvm): %s" % str(kern))
+            logging.debug("acquireKernel (hvm): %s", str(kern))
 
             if kern[0] is not True or kern[1] is not True:
                 raise RuntimeError("Didn't fetch any hvm kernel.")
         except Exception, e:
-            logging.exception("%s-%s: hvm kernel fetching: %s" %
-                              (distname, arch, str(e)))
+            logging.exception("%s-%s: hvm kernel fetching: %s",
+                              distname, arch, str(e))
             self.fail()
 
         # Fetch xen kernel
         try:
             if xenstore and check_xen:
                 kern = xenstore.acquireKernel(testguest, fetcher, self.meter)
-                logging.debug("acquireKernel (xen): %s" % str(kern))
+                logging.debug("acquireKernel (xen): %s", str(kern))
 
                 if kern[0] is not True or kern[1] is not True:
                     raise RuntimeError("Didn't fetch any xen kernel.")
             else:
                 logging.debug("acquireKernel (xen): Hardcoded skipping.")
         except Exception, e:
             if re.match(r"%s" % EXPECT_XEN_FAIL, distname):
-                logging.debug("%s: anticipated xen failure." % distname)
+                logging.debug("%s: anticipated xen failure.", distname)
             else:
-                logging.exception("%s-%s: xen kernel fetching: %s" %
-                                  (distname, arch, str(e)))
+                logging.exception("%s-%s: xen kernel fetching: %s",
+                                  distname, arch, str(e))
                 self.fail()
 
     def _getStore(self, fetcher, url, _type, arch):
@@ -379,7 +379,7 @@ def _getStore(self, fetcher, url, _type, arch):
                                                 arch=arch, typ=_type)
             except Exception, e:
                 if str(e).count("502"):
-                    logging.debug("Caught proxy error: %s" % str(e))
+                    logging.debug("Caught proxy error: %s", str(e))
                     time.sleep(.5)
                     continue
                 raise
@@ -397,7 +397,7 @@ def testURLFetch(self):
         for label in keys:
             distro_info = None
             if MATCH_FILTER and not re.match(r"%s" % MATCH_FILTER, label):
-                logging.debug("Excluding '%s' from exclude filter." % label)
+                logging.debug("Excluding '%s' from exclude filter.", label)
                 continue
 
             check_xen = not bool(urls[label].get("noxen"))
@@ -430,7 +430,7 @@ def testLocalMedia(self):
                 try:
                     self._fetchLocalMedia(p)
                 except Exception, e:
-                    logging.exception("Local path '%s' failed: %s" % (p, e))
+                    logging.exception("Local path '%s' failed: %s", p, e)
                     print "Local path FAILED."
                     assertions += 1
 

tests/utils.py

@@ -72,7 +72,7 @@ def get_conn():
 
 # Register libvirt handler
 def libvirt_callback(ignore, err):
-    logging.warn("libvirt errmsg: %s" % err[2])
+    logging.warn("libvirt errmsg: %s", err[2])
 libvirt.registerErrorHandler(f=libvirt_callback, ctx=None)
 
 def sanitize_xml_for_define(xml):

tests/validation.py

@@ -421,7 +421,7 @@ def _testArgs(self, obj, testclass, name, exception_check=None,
         """@obj Object to test parameters against
            @testclass Full class to test initialization against
            @name String name indexing args"""
-        logging.debug("Testing '%s'" % name)
+        logging.debug("Testing '%s'", name)
         testdict = args[name]
         if manual_dict != None:
             testdict = manual_dict

tests/xmlconfig.py

@@ -53,7 +53,7 @@ class TestXMLConfig(unittest.TestCase):
 
     def setUp(self):
         utils.reset_conn()
-        logging.debug("Running %s" % self.id())
+        logging.debug("Running %s", self.id())
 
     def tearDown(self):
         if os.path.exists(utils.scratch):

virt-clone

@@ -38,7 +38,7 @@ def get_clone_name(new_name, auto_clone, design):
     if not new_name and auto_clone:
         # Generate a name to use
         new_name = clmgr.generate_clone_name(design)
-        logging.debug("Auto-generated clone name '%s'." % new_name)
+        logging.debug("Auto-generated clone name '%s'", new_name)
 
     prompt_txt = _("What is the name for the cloned virtual machine?")
     err_txt = _("A name is required for the new virtual machine.")

virt-convert

@@ -207,23 +207,23 @@ def main():
     if not options.output_dir:
         options.output_dir = unixname
     try:
-        logging.debug("Creating directory %s" % options.output_dir)
+        logging.debug("Creating directory %s", options.output_dir)
         if options.nodry:
             os.mkdir(options.output_dir)
         clean += [ options.output_dir ]
     except OSError, e:
         if (e.errno != errno.EEXIST):
-            fail("Could not create directory %s: %s" %
+            fail("Could not create directory %s: %s", 
                 (options.output_dir, e.strerror))
 
     if not options.output_file:
         options.output_file = os.path.join(options.output_dir,
            "%s%s" % (unixname, outp.suffix))
 
-    logging.debug("input_file: %s" % options.input_file)
-    logging.debug("input_dir: %s" % options.input_dir)
-    logging.debug("output_file: %s" % options.output_file)
-    logging.debug("output_dir: %s" % options.output_dir)
+    logging.debug("input_file: %s", options.input_file)
+    logging.debug("input_dir: %s", options.input_dir)
+    logging.debug("output_file: %s", options.output_file)
+    logging.debug("output_dir: %s", options.output_dir)
 
     print_stdout(_("Generating output in '%(format)s' format to %(dir)s/") %
         {"format": options.output_format, "dir": options.output_dir})
@@ -260,7 +260,7 @@ def main():
 
     try:
         output = outp.export(vmdef)
-        logging.debug("Output VM config:\n%s" % output)
+        logging.debug("Output VM config:\n%s", output)
 
         if options.nodry:
             outfile = open(options.output_file, "w")

virt-install

@@ -254,9 +254,9 @@ def get_virt_type(conn, options):
         req_virt_type, req_accel = prompt_virt(capabilities, options.arch,
                                                req_virt_type, req_accel)
 
-    logging.debug("Requesting virt method '%s', hv type '%s'." %
-                  ((req_virt_type and req_virt_type or _("default")),
-                   (req_hv_type and req_hv_type or _("default"))))
+    logging.debug("Requesting virt method '%s', hv type '%s'.",
+                  (req_virt_type and req_virt_type or _("default")),
+                  (req_hv_type and req_hv_type or _("default")))
 
     arch = options.arch
     if re.match("i.86", arch or ""):
@@ -280,7 +280,7 @@ def get_virt_type(conn, options):
         _util.is_qemu(conn) and
         capsguest.arch in ["i686", "x86_64"] and
         not capsdomain.is_accelerated()):
-        logging.warn("KVM acceleration not available, using '%s'" %
+        logging.warn("KVM acceleration not available, using '%s'",
                      capsdomain.hypervisor_type)
 
     return (capsguest, capsdomain)
@@ -466,8 +466,8 @@ def build_guest_instance(conn, options):
 
     virt_type = capsguest.os_type
     hv_name = capsdomain.hypervisor_type
-    logging.debug("Received virt method '%s'" % virt_type)
-    logging.debug("Hypervisor name is '%s'" % hv_name)
+    logging.debug("Received virt method '%s'", virt_type)
+    logging.debug("Hypervisor name is '%s'", hv_name)
 
     # Get Guest instance from installer parameters.
     installer = build_installer(options, conn, virt_type, hv_name,
@@ -580,11 +580,11 @@ def start_install(guest, continue_inst, options):
             gtype = guest.graphics_dev.type
             if gtype in [virtinst.VirtualGraphics.TYPE_VNC,
                          virtinst.VirtualGraphics.TYPE_SPICE]:
-                logging.debug("Launching virt-viewer for graphics type '%s'" %
+                logging.debug("Launching virt-viewer for graphics type '%s'",
                               gtype)
                 return vnc_console(dom, guest.get_uri())
             else:
-                logging.debug("No viewer to launch for graphics type '%s'" %
+                logging.debug("No viewer to launch for graphics type '%s'",
                               gtype)
                 return None # SDL needs no viewer app
         else:
@@ -619,7 +619,7 @@ def start_install(guest, continue_inst, options):
     meter = (options.quiet and
              progress.BaseMeter() or
              progress.TextMeter(fo=sys.stdout))
-    logging.debug("Guest.has_install_phase: %s" %
+    logging.debug("Guest.has_install_phase: %s",
                   guest.installer.has_install_phase())
 
     # we've got everything -- try to start the install
@@ -704,7 +704,7 @@ def check_domain(guest, dom, conscb, wait_for_install, wait_time, start_time):
         return ret
 
     # Domain seems to be running
-    logging.debug("Domain state after install: %s" % state)
+    logging.debug("Domain state after install: %s", state)
 
     if not wait_for_install or wait_time == 0:
         # User either: