[CalendarServer-changes] [2342] CalendarServer/branches/users/wsanchez/logging/twistedcaldav/log.py

source_changes at macosforge.org source_changes at macosforge.org
Thu Apr 24 14:25:56 PDT 2008


Revision: 2342
          http://trac.macosforge.org/projects/calendarserver/changeset/2342
Author:   wsanchez at apple.com
Date:     2008-04-24 14:25:54 -0700 (Thu, 24 Apr 2008)

Log Message:
-----------
doc

Modified Paths:
--------------
    CalendarServer/branches/users/wsanchez/logging/twistedcaldav/log.py

Modified: CalendarServer/branches/users/wsanchez/logging/twistedcaldav/log.py
===================================================================
--- CalendarServer/branches/users/wsanchez/logging/twistedcaldav/log.py	2008-04-24 21:13:16 UTC (rev 2341)
+++ CalendarServer/branches/users/wsanchez/logging/twistedcaldav/log.py	2008-04-24 21:25:54 UTC (rev 2342)
@@ -64,6 +64,10 @@
 logLevelsByNamespace = {}
 
 def logLevelForNamespace(namespace):
+    """
+    @param namespace: a logging namespace
+    @return: the log level for the given namespace.
+    """
     if namespace in logLevelsByNamespace:
         return logLevelsByNamespace[namespace]
 
@@ -79,10 +83,18 @@
     return defaultLogLevel
 
 def setLogLevelForNamespace(namespace, level):
+    """
+    Sets the log level for a logging namespace.
+    @param namespace: a logging namespace
+    @param level: the log level for the given namespace.
+    """
     assert level in logLevels
     logLevelsByNamespace[namespace] = level
 
 def clearLogLevels():
+    """
+    Clears all log levels to the default.
+    """
     logLevelsByNamespace.clear()
 
 ##
@@ -110,6 +122,9 @@
         self.namespace = namespace
 
     def emit(self, level, message, **kwargs):
+        """
+        Called internally to emit log messages at a given log level.
+        """
         log.msg(
             str(message),
             isError = (level == "error"),
@@ -142,12 +157,29 @@
     logger = property(_getLogger, _setLogger)
 
 for level in logLevels:
+    doc = """
+    Emit a log message at log level C{%s}.
+    @param message: The message to emit.
+    """ % (level,)
+
+    #
+    # Attach methods to Logger
+    #
     def log_level(self, message, level=level, **kwargs):
         self.emit(level, message, **kwargs)
+
+    log_level.__doc__ = doc
+
     setattr(Logger, level, log_level)
 
+    #
+    # Attach methods to LoggingMixIn
+    #
     def log_level(self, message, level=level, **kwargs):
         self.logger.emit(level, message, **kwargs)
+
+    log_level.__doc__ = doc
+
     setattr(LoggingMixIn, "log_%s" % (level,), log_level)
 
 del level, log_level

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20080424/5cafde9f/attachment-0001.html


More information about the calendarserver-changes mailing list