Define debug_callback code once, rather than in every script

Author: Jonathan Kamens

delete

@@ -13,22 +13,6 @@ logger = logging.getLogger('delete')
 whoami = os.path.basename(sys.argv[0])
 
 
-def debug_callback(option, opt_str, value, parser):
-    """
-    An OptionParser callback that enables debugging.
-    """
-    all_loggers = [logger.name, 'libdelete']
-    loggers = [x.strip() for x in value.split(',')]
-    if value.lower() == 'all':
-        loggers = all_loggers
-    else:
-        if not set(loggers) <= set(all_loggers):
-            parser.error('Valid debug targets: {0}'.format(
-                    ", ".join(all_loggers)))
-    for l in loggers:
-        logging.getLogger(l).setLevel(logging.DEBUG)
-
-
 def ask(question, *args, **kwargs):
     """
     Ask a question, possibly prepended with the name of the program
@@ -162,7 +146,7 @@ def main():
     parser.add_option(
         "--debug", action="callback", type='string',
         help="Enable debugging (logger target or 'all')",
-        callback=debug_callback, metavar='target')
+        callback=libdelete.make_debug_callback(logger), metavar='target')
     (options, args) = parser.parse_args()
     if options.filesonly and options.directoriesonly:
         parser.error("-F and -D are mutually exclusive")

expunge

@@ -19,22 +19,6 @@ logger = logging.getLogger('expunge')
 whoami = os.path.basename(sys.argv[0])
 
 
-def debug_callback(option, opt_str, value, parser):
-    """
-    An OptionParser callback that enables debugging.
-    """
-    all_loggers = [logger.name, 'libdelete']
-    loggers = [x.strip() for x in value.split(',')]
-    if value.lower() == 'all':
-        loggers = all_loggers
-    else:
-        if not set(loggers) <= set(all_loggers):
-            parser.error('Valid debug targets: {0}'.format(
-                    ", ".join(all_loggers)))
-    for l in loggers:
-        logging.getLogger(l).setLevel(logging.DEBUG)
-
-
 def ask(question, *args, **kwargs):
     """
     Ask a question, possibly prepended with the name of the program
@@ -144,7 +128,7 @@ def parse_options():
     parser.add_option(
         "--debug", action="callback", type='string',
         help="Enable debugging (logger target or 'all')",
-        callback=debug_callback, metavar='target')
+        callback=libdelete.make_debug_callback(logger), metavar='target')
     (options, args) = parser.parse_args()
     if options.noop:
         # -n implies -v

libdelete.py

@@ -23,6 +23,25 @@ class DeleteError(Exception):
     pass
 
 
+def make_debug_callback(logger):
+    def debug_callback(option, opt_str, value, parser):
+        """
+        An OptionParser callback that enables debugging.
+        """
+        all_loggers = [logger.name, 'libdelete']
+        loggers = [x.strip() for x in value.split(',')]
+        if value.lower() == 'all':
+            loggers = all_loggers
+        else:
+            if not set(loggers) <= set(all_loggers):
+                parser.error('Valid debug targets: {0}'.format(
+                        ", ".join(all_loggers)))
+        for l in loggers:
+            logging.getLogger(l).setLevel(logging.DEBUG)
+
+    return debug_callback
+
+
 def perror(message, **kwargs):
     """
     Format an error message, log it in the debug log

lsdel

@@ -12,22 +12,6 @@ logger = logging.getLogger('lsdel')
 whoami = os.path.basename(sys.argv[0])
 
 
-def debug_callback(option, opt_str, value, parser):
-    """
-    An OptionParser callback that enables debugging.
-    """
-    all_loggers = [logger.name, 'libdelete']
-    loggers = [x.strip() for x in value.split(',')]
-    if value.lower() == 'all':
-        loggers = all_loggers
-    else:
-        if not set(loggers) <= set(all_loggers):
-            parser.error('Valid debug targets: {0}'.format(
-                    ", ".join(all_loggers)))
-    for l in loggers:
-        logging.getLogger(l).setLevel(logging.DEBUG)
-
-
 def parse_options():
     parser = optparse.OptionParser(usage="%prog [options] filename ...")
     parser.add_option(
@@ -57,7 +41,7 @@ def parse_options():
     parser.add_option(
         "--debug", action="callback", type='string',
         help="Enable debugging (logger target or 'all')",
-        callback=debug_callback, metavar='target')
+        callback=libdelete.make_debug_callback(logger), metavar='target')
     (options, args) = parser.parse_args()
     if options.singlecolumn and options.multicolumn:
         parser.error("-C and -1 are mutually exclusive")

undelete

@@ -13,22 +13,6 @@ logger = logging.getLogger('undelete')
 whoami = os.path.basename(sys.argv[0])
 
 
-def debug_callback(option, opt_str, value, parser):
-    """
-    An OptionParser callback that enables debugging.
-    """
-    all_loggers = [logger.name, 'libdelete']
-    loggers = [x.strip() for x in value.split(',')]
-    if value.lower() == 'all':
-        loggers = all_loggers
-    else:
-        if not set(loggers) <= set(all_loggers):
-            parser.error('Valid debug targets: {0}'.format(
-                    ", ".join(all_loggers)))
-    for l in loggers:
-        logging.getLogger(l).setLevel(logging.DEBUG)
-
-
 def ask(question, *args, **kwargs):
     """
     Ask a question, possibly prepended with the name of the program
@@ -140,7 +124,7 @@ def main():
     parser.add_option(
         "--debug", action="callback", type='string',
         help="Enable debugging (logger target or 'all')",
-        callback=debug_callback, metavar='target')
+        callback=libdelete.make_debug_callback(logger), metavar='target')
     (options, args) = parser.parse_args()
     if options.recursive and options.dirsonly:
         parser.error("-r and -R are mutually exclusive")