added copyright header
authorTony Mack <tmack@paris.CS.Princeton.EDU>
Sat, 21 Jul 2012 02:36:01 +0000 (22:36 -0400)
committerTony Mack <tmack@paris.CS.Princeton.EDU>
Sat, 21 Jul 2012 02:36:01 +0000 (22:36 -0400)
sfa/util/sfalogging.py

index 2e4640e..5529fe7 100644 (file)
-#!/usr/bin/python
-
-import os, sys
-import traceback
-import logging, logging.handlers
-
-CRITICAL=logging.CRITICAL
-ERROR=logging.ERROR
-WARNING=logging.WARNING
-INFO=logging.INFO
-DEBUG=logging.DEBUG
-
-# a logger that can handle tracebacks 
-class _SfaLogger:
-    def __init__ (self,logfile=None,loggername=None,level=logging.INFO):
-        # default is to locate loggername from the logfile if avail.
-        if not logfile:
-            #loggername='console'
-            #handler=logging.StreamHandler()
-            #handler.setFormatter(logging.Formatter("%(levelname)s %(message)s"))
-            logfile = "/var/log/sfa.log"
-
-        if not loggername:
-            loggername=os.path.basename(logfile)
-        try:
-            handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5) 
-        except IOError:
-            # This is usually a permissions error becaue the file is
-            # owned by root, but httpd is trying to access it.
-            tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)
-            # In strange uses, 2 users on same machine might use same code,
-            # meaning they would clobber each others files
-            # We could (a) rename the tmplogfile, or (b)
-            # just log to the console in that case.
-            # Here we default to the console.
-            if os.path.exists(tmplogfile) and not os.access(tmplogfile,os.W_OK):
-                loggername = loggername + "-console"
-                handler = logging.StreamHandler()
-            else:
-                handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5) 
-        handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
-        self.logger=logging.getLogger(loggername)
-        self.logger.setLevel(level)
-        # check if logger already has the handler we're about to add
-        handler_exists = False
-        for l_handler in self.logger.handlers:
-            if l_handler.baseFilename == handler.baseFilename and \
-               l_handler.level == handler.level:
-                handler_exists = True 
-
-        if not handler_exists:
-            self.logger.addHandler(handler)
-
-        self.loggername=loggername
-
-    def setLevel(self,level):
-        self.logger.setLevel(level)
-
-    # shorthand to avoid having to import logging all over the place
-    def setLevelDebug(self):
-        self.logger.setLevel(logging.DEBUG)
-
-    # define a verbose option with s/t like
-    # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)
-    # and pass the coresponding options.verbose to this method to adjust level
-    def setLevelFromOptVerbose(self,verbose):
-        if verbose==0:
-            self.logger.setLevel(logging.WARNING)
-        elif verbose==1:
-            self.logger.setLevel(logging.INFO)
-        elif verbose>=2:
-            self.logger.setLevel(logging.DEBUG)
-    # in case some other code needs a boolean
-    def getBoolVerboseFromOpt(self,verbose):
-        return verbose>=1
-
-    ####################
-    def info(self, msg):
-        self.logger.info(msg)
-
-    def debug(self, msg):
-        self.logger.debug(msg)
-        
-    def warn(self, msg):
-        self.logger.warn(msg)
-
-    # some code is using logger.warn(), some is using logger.warning()
-    def warning(self, msg):
-        self.logger.warning(msg)
-   
-    def error(self, msg):
-        self.logger.error(msg)    
-    def critical(self, msg):
-        self.logger.critical(msg)
-
-    # logs an exception - use in an except statement
-    def log_exc(self,message):
-        self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
-        self.error("%s END TRACEBACK"%message)
-    
-    def log_exc_critical(self,message):
-        self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
-        self.critical("%s END TRACEBACK"%message)
-    
-    # for investigation purposes, can be placed anywhere
-    def log_stack(self,message):
-        to_log="".join(traceback.format_stack())
-        self.info("%s BEG STACK"%message+"\n"+to_log)
-        self.info("%s END STACK"%message)
-
-    def enable_console(self, stream=sys.stdout):
-        formatter = logging.Formatter("%(message)s")
-        handler = logging.StreamHandler(stream)
-        handler.setFormatter(formatter)
-        self.logger.addHandler(handler)
-
-
-info_logger = _SfaLogger(loggername='info', level=logging.INFO)
-debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)
-warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)
-error_logger = _SfaLogger(loggername='error', level=logging.ERROR)
-critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)
-logger = info_logger
-sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/")+'sfi.log',loggername='sfilog', level=logging.DEBUG)
-########################################
-import time
-
-def profile(logger):
-    """
-    Prints the runtime of the specified callable. Use as a decorator, e.g.,
-    
-    @profile(logger)
-    def foo(...):
-        ...
-    """
-    def logger_profile(callable):
-        def wrapper(*args, **kwds):
-            start = time.time()
-            result = callable(*args, **kwds)
-            end = time.time()
-            args = map(str, args)
-            args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]
-            # should probably use debug, but then debug is not always enabled
-            logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
-            return result
-        return wrapper
-    return logger_profile
-
-
-if __name__ == '__main__': 
-    print 'testing sfalogging into logger.log'
-    logger1=_SfaLogger('logger.log', loggername='std(info)')
-    logger2=_SfaLogger('logger.log', loggername='error', level=logging.ERROR)
-    logger3=_SfaLogger('logger.log', loggername='debug', level=logging.DEBUG)
-    
-    for (logger,msg) in [ (logger1,"std(info)"),(logger2,"error"),(logger3,"debug")]:
-        
-        print "====================",msg, logger.logger.handlers
-   
-        logger.enable_console()
-        logger.critical("logger.critical")
-        logger.error("logger.error")
-        logger.warn("logger.warning")
-        logger.info("logger.info")
-        logger.debug("logger.debug")
-        logger.setLevel(logging.DEBUG)
-        logger.debug("logger.debug again")
-    
-        @profile(logger)
-        def sleep(seconds = 1):
-            time.sleep(seconds)
-
-        logger.info('console.info')
-        sleep(0.5)
-        logger.setLevel(logging.DEBUG)
-        sleep(0.25)
-
+#!/usr/bin/python\r
+\r
+#----------------------------------------------------------------------\r
+# Copyright (c) 2008 Board of Trustees, Princeton University\r
+#\r
+# Permission is hereby granted, free of charge, to any person obtaining\r
+# a copy of this software and/or hardware specification (the "Work") to\r
+# deal in the Work without restriction, including without limitation the\r
+# rights to use, copy, modify, merge, publish, distribute, sublicense,\r
+# and/or sell copies of the Work, and to permit persons to whom the Work\r
+# is furnished to do so, subject to the following conditions:\r
+#\r
+# The above copyright notice and this permission notice shall be\r
+# included in all copies or substantial portions of the Work.\r
+#\r
+# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS \r
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF \r
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND \r
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT \r
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, \r
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \r
+# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS \r
+# IN THE WORK.\r
+#----------------------------------------------------------------------\r
+\r
+import os, sys\r
+import traceback\r
+import logging, logging.handlers\r
+\r
+CRITICAL=logging.CRITICAL\r
+ERROR=logging.ERROR\r
+WARNING=logging.WARNING\r
+INFO=logging.INFO\r
+DEBUG=logging.DEBUG\r
+\r
+# a logger that can handle tracebacks \r
+class _SfaLogger:\r
+    def __init__ (self,logfile=None,loggername=None,level=logging.INFO):\r
+        # default is to locate loggername from the logfile if avail.\r
+        if not logfile:\r
+            #loggername='console'\r
+            #handler=logging.StreamHandler()\r
+            #handler.setFormatter(logging.Formatter("%(levelname)s %(message)s"))\r
+            logfile = "/var/log/sfa.log"\r
+\r
+        if not loggername:\r
+            loggername=os.path.basename(logfile)\r
+        try:\r
+            handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5) \r
+        except IOError:\r
+            # This is usually a permissions error becaue the file is\r
+            # owned by root, but httpd is trying to access it.\r
+            tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)\r
+            # In strange uses, 2 users on same machine might use same code,\r
+            # meaning they would clobber each others files\r
+            # We could (a) rename the tmplogfile, or (b)\r
+            # just log to the console in that case.\r
+            # Here we default to the console.\r
+            if os.path.exists(tmplogfile) and not os.access(tmplogfile,os.W_OK):\r
+                loggername = loggername + "-console"\r
+                handler = logging.StreamHandler()\r
+            else:\r
+                handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5) \r
+        handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))\r
+        self.logger=logging.getLogger(loggername)\r
+        self.logger.setLevel(level)\r
+        # check if logger already has the handler we're about to add\r
+        handler_exists = False\r
+        for l_handler in self.logger.handlers:\r
+            if l_handler.baseFilename == handler.baseFilename and \\r
+               l_handler.level == handler.level:\r
+                handler_exists = True \r
+\r
+        if not handler_exists:\r
+            self.logger.addHandler(handler)\r
+\r
+        self.loggername=loggername\r
+\r
+    def setLevel(self,level):\r
+        self.logger.setLevel(level)\r
+\r
+    # shorthand to avoid having to import logging all over the place\r
+    def setLevelDebug(self):\r
+        self.logger.setLevel(logging.DEBUG)\r
+\r
+    # define a verbose option with s/t like\r
+    # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)\r
+    # and pass the coresponding options.verbose to this method to adjust level\r
+    def setLevelFromOptVerbose(self,verbose):\r
+        if verbose==0:\r
+            self.logger.setLevel(logging.WARNING)\r
+        elif verbose==1:\r
+            self.logger.setLevel(logging.INFO)\r
+        elif verbose>=2:\r
+            self.logger.setLevel(logging.DEBUG)\r
+    # in case some other code needs a boolean\r
+    def getBoolVerboseFromOpt(self,verbose):\r
+        return verbose>=1\r
+\r
+    ####################\r
+    def info(self, msg):\r
+        self.logger.info(msg)\r
+\r
+    def debug(self, msg):\r
+        self.logger.debug(msg)\r
+        \r
+    def warn(self, msg):\r
+        self.logger.warn(msg)\r
+\r
+    # some code is using logger.warn(), some is using logger.warning()\r
+    def warning(self, msg):\r
+        self.logger.warning(msg)\r
+   \r
+    def error(self, msg):\r
+        self.logger.error(msg)    \r
\r
+    def critical(self, msg):\r
+        self.logger.critical(msg)\r
+\r
+    # logs an exception - use in an except statement\r
+    def log_exc(self,message):\r
+        self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))\r
+        self.error("%s END TRACEBACK"%message)\r
+    \r
+    def log_exc_critical(self,message):\r
+        self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))\r
+        self.critical("%s END TRACEBACK"%message)\r
+    \r
+    # for investigation purposes, can be placed anywhere\r
+    def log_stack(self,message):\r
+        to_log="".join(traceback.format_stack())\r
+        self.info("%s BEG STACK"%message+"\n"+to_log)\r
+        self.info("%s END STACK"%message)\r
+\r
+    def enable_console(self, stream=sys.stdout):\r
+        formatter = logging.Formatter("%(message)s")\r
+        handler = logging.StreamHandler(stream)\r
+        handler.setFormatter(formatter)\r
+        self.logger.addHandler(handler)\r
+\r
+\r
+info_logger = _SfaLogger(loggername='info', level=logging.INFO)\r
+debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)\r
+warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)\r
+error_logger = _SfaLogger(loggername='error', level=logging.ERROR)\r
+critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)\r
+logger = info_logger\r
+sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/")+'sfi.log',loggername='sfilog', level=logging.DEBUG)\r
+########################################\r
+import time\r
+\r
+def profile(logger):\r
+    """\r
+    Prints the runtime of the specified callable. Use as a decorator, e.g.,\r
+    \r
+    @profile(logger)\r
+    def foo(...):\r
+        ...\r
+    """\r
+    def logger_profile(callable):\r
+        def wrapper(*args, **kwds):\r
+            start = time.time()\r
+            result = callable(*args, **kwds)\r
+            end = time.time()\r
+            args = map(str, args)\r
+            args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]\r
+            # should probably use debug, but then debug is not always enabled\r
+            logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))\r
+            return result\r
+        return wrapper\r
+    return logger_profile\r
+\r
+\r
+if __name__ == '__main__': \r
+    print 'testing sfalogging into logger.log'\r
+    logger1=_SfaLogger('logger.log', loggername='std(info)')\r
+    logger2=_SfaLogger('logger.log', loggername='error', level=logging.ERROR)\r
+    logger3=_SfaLogger('logger.log', loggername='debug', level=logging.DEBUG)\r
+    \r
+    for (logger,msg) in [ (logger1,"std(info)"),(logger2,"error"),(logger3,"debug")]:\r
+        \r
+        print "====================",msg, logger.logger.handlers\r
+   \r
+        logger.enable_console()\r
+        logger.critical("logger.critical")\r
+        logger.error("logger.error")\r
+        logger.warn("logger.warning")\r
+        logger.info("logger.info")\r
+        logger.debug("logger.debug")\r
+        logger.setLevel(logging.DEBUG)\r
+        logger.debug("logger.debug again")\r
+    \r
+        @profile(logger)\r
+        def sleep(seconds = 1):\r
+            time.sleep(seconds)\r
+\r
+        logger.info('console.info')\r
+        sleep(0.5)\r
+        logger.setLevel(logging.DEBUG)\r
+        sleep(0.25)\r
+\r