<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[11339] CalendarServer/trunk/twext/python</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/11339">11339</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-06-13 14:40:03 -0700 (Thu, 13 Jun 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>No more filtering in Logger.emit(); add a new LogLevelFilteringLogObserverWrapper which handles that.
Get rid of &quot;_enabled&quot; truthy thing for testing whether a logger will log; it's totally unused.  (eg. log.error_enabled)</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktwextpythonlogpy">CalendarServer/trunk/twext/python/log.py</a></li>
<li><a href="#CalendarServertrunktwextpythontesttest_logpy">CalendarServer/trunk/twext/python/test/test_log.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktwextpythonlogpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/python/log.py (11338 => 11339)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/python/log.py        2013-06-13 20:20:14 UTC (rev 11338)
+++ CalendarServer/trunk/twext/python/log.py        2013-06-13 21:40:03 UTC (rev 11339)
</span><span class="lines">@@ -50,12 +50,12 @@
</span><span class="cx"> #
</span><span class="cx"> # TODO List:
</span><span class="cx"> #
</span><del>-# * Filter in observers, not emit() - use a wrapper observer
</del><span class="cx"> # * Expose the default log observer (TheLogPublisher)
</span><span class="cx"> # * Specifically, expose addObserver and removeObserver so one can register other observers
</span><span class="cx"> # * Check the unicode situation for sanity
</span><span class="cx"> # * Change the default log observer to something non-legacy
</span><span class="cx"> # * Register a legacy observer with Twisted's logging that forwards to this module
</span><ins>+# * Monkey patch logging in Twisted to use our LegacyLogger to sprinkle betterness everywhere
</ins><span class="cx"> #
</span><span class="cx"> 
</span><span class="cx"> __all__ = [
</span><span class="lines">@@ -69,6 +69,7 @@
</span><span class="cx">     &quot;ILogObserver&quot;,
</span><span class="cx">     &quot;ILegacyLogObserver&quot;,
</span><span class="cx">     &quot;LogPublisher&quot;,
</span><ins>+    &quot;LogLevelFilteringLogObserverWrapper&quot;,
</ins><span class="cx">     &quot;LegacyLogObserverWrapper&quot;,
</span><span class="cx">     #&quot;StandardIOObserver&quot;,
</span><span class="cx"> ]
</span><span class="lines">@@ -329,12 +330,9 @@
</span><span class="cx">                 logger = self,
</span><span class="cx">             )
</span><span class="cx">             #level = LogLevel.error
</span><ins>+            # FIXME: continue to emit?
</ins><span class="cx">             return
</span><span class="cx"> 
</span><del>-        # FIXME: Filtering should be done by the log observer(s)
-        if not self.willLogAtLevel(level):
-            return
-
</del><span class="cx">         event = kwargs
</span><span class="cx">         event.update(
</span><span class="cx">             log_logger    = self,
</span><span class="lines">@@ -396,7 +394,6 @@
</span><span class="cx">         setLogLevelForNamespace(self.namespace, level)
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-    # FIXME: get rid of this
</del><span class="cx">     def willLogAtLevel(self, level):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         @param level: a L{LogLevel}
</span><span class="lines">@@ -468,7 +465,6 @@
</span><span class="cx">     log_emit.__doc__ = doc
</span><span class="cx"> 
</span><span class="cx">     setattr(Logger, level.name, log_emit)
</span><del>-    setattr(Logger, level.name + &quot;_enabled&quot;, property(will_emit))
</del><span class="cx"> 
</span><span class="cx"> for level in LogLevel.iterconstants(): 
</span><span class="cx">     bindEmit(level)
</span><span class="lines">@@ -502,15 +498,15 @@
</span><span class="cx"> @implementer(ILogObserver)
</span><span class="cx"> class LogPublisher(object):
</span><span class="cx">     &quot;&quot;&quot;
</span><del>-    Log publisher that fans out events to other observers.
</del><ins>+    I{ILogObserver} that fans out events to other observers.
</ins><span class="cx"> 
</span><span class="cx">     Keeps track of a set of L{ILogObserver} objects and forwards
</span><span class="cx">     events to each.
</span><span class="cx">     &quot;&quot;&quot;
</span><span class="cx">     log = Logger()
</span><span class="cx"> 
</span><del>-    def __init__(self):
-        self._observers = set()
</del><ins>+    def __init__(self, *observers):
+        self._observers = set(observers)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     @property
</span><span class="lines">@@ -561,10 +557,40 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> @implementer(ILogObserver)
</span><ins>+class LogLevelFilteringLogObserverWrapper(object):
+    &quot;&quot;&quot;
+    L{ILogObserver} that wraps another L{ILogObserver}, but does not
+    forward events which have a L{LogLevel} lower than is configured
+    for the event's namespace.
+    &quot;&quot;&quot;
+
+    def __init__(self, observer):
+        &quot;&quot;&quot;
+        @param observer: an L{ILogObserver} to which this observer
+            will forward events.
+        &quot;&quot;&quot;
+        self.observer = observer
+
+
+    def eventShouldForward(self, event):
+        if event[&quot;log_level&quot;] &gt;= logLevelForNamespace(event[&quot;log_namespace&quot;]):
+            return True
+        else:
+            return False
+
+
+    def __call__(self, event):
+        if self.eventShouldForward(event):
+            self.observer(event)
+
+
+
+@implementer(ILogObserver)
</ins><span class="cx"> class LegacyLogObserverWrapper(object):
</span><span class="cx">     &quot;&quot;&quot;
</span><span class="cx">     L{ILogObserver} that wraps an L{ILegacyLogObserver}.
</span><span class="cx">     &quot;&quot;&quot;
</span><ins>+
</ins><span class="cx">     def __init__(self, legacyObserver):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         @param legacyObserver: an L{ILegacyLogObserver} to which this
</span><span class="lines">@@ -612,11 +638,12 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-TheLogPublisher = LogPublisher()
-TheLogPublisher.addObserver(LegacyLogObserverWrapper(twistedLogMessage))
</del><ins>+TheLegacyLogObserver = LegacyLogObserverWrapper(twistedLogMessage)
+TheFilteredLogPublisher = LogPublisher(TheLegacyLogObserver) # Add post-filtering observers here
+TheFilteringLogObserver = LogLevelFilteringLogObserverWrapper(TheFilteredLogPublisher)
+TheLogPublisher = LogPublisher(TheFilteringLogObserver) # Add pre-filtering observers here
</ins><span class="cx"> 
</span><span class="cx"> 
</span><del>-
</del><span class="cx"> ######################################################################
</span><span class="cx"> # FIXME: This may not be needed; look into removing it.
</span><span class="cx"> 
</span></span></pre></div>
<a id="CalendarServertrunktwextpythontesttest_logpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/python/test/test_log.py (11338 => 11339)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/python/test/test_log.py        2013-06-13 20:20:14 UTC (rev 11338)
+++ CalendarServer/trunk/twext/python/test/test_log.py        2013-06-13 21:40:03 UTC (rev 11339)
</span><span class="lines">@@ -323,21 +323,6 @@
</span><span class="cx">                 self.assertTrue(log.willLogAtLevel(level), (level, log.level()))
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-    def test_logMethodTruthiness_Logger(self):
-        &quot;&quot;&quot;
-        Logger's log level functions/methods have true/false
-        value based on whether they will log.
-        &quot;&quot;&quot;
-        log = Logger()
-
-        for level in LogLevel.iterconstants():
-            enabled = getattr(log, level.name + &quot;_enabled&quot;)
-            if enabled:
-                self.assertTrue(log.willLogAtLevel(level))
-            else:
-                self.assertFalse(log.willLogAtLevel(level))
-
-
</del><span class="cx">     def test_logInvalidLogLevel(self):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         Test passing in a bogus log level to C{emit()}.
</span></span></pre>
</div>
</div>

</body>
</html>