<!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>[11326] 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/11326">11326</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-06-10 14:29:13 -0700 (Mon, 10 Jun 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>log.emit() now takes a format, instead of a message.</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 (11325 => 11326)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/python/log.py        2013-06-07 16:43:52 UTC (rev 11325)
+++ CalendarServer/trunk/twext/python/log.py        2013-06-10 21:29:13 UTC (rev 11326)
</span><span class="lines">@@ -50,6 +50,7 @@
</span><span class="cx"> # TODO List:
</span><span class="cx"> #
</span><span class="cx"> # * Replace message argument with format argument
</span><ins>+# * Filter in observers, not emit()
</ins><span class="cx"> #
</span><span class="cx"> 
</span><span class="cx"> __all__ = [
</span><span class="lines">@@ -244,19 +245,21 @@
</span><span class="cx">         return &quot;&lt;%s %r&gt;&quot; % (self.__class__.__name__, self.namespace)
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-    def emit(self, level, message=None, **kwargs):
</del><ins>+    def emit(self, level, format=None, **kwargs):
</ins><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         Emit a log message to all log observers at the given level.
</span><span class="cx"> 
</span><span class="cx">         @param level: a L{LogLevel}
</span><span class="cx"> 
</span><del>-        @param message: a message
</del><ins>+        @param format: a message format using PEP3101 formatting.  All
+            variables in C{kwargs} are available.
</ins><span class="cx"> 
</span><span class="cx">         @param kwargs: additional keyword parameters to include with the
</span><span class="cx">             message.
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         if level not in LogLevel.iterconstants():
</span><del>-            raise InvalidLogLevelError(level)
</del><ins>+            self.failure(Failure(InvalidLogLevelError(level)))
+            level = LogLevel.error
</ins><span class="cx"> 
</span><span class="cx">         # FIXME: Filtering should be done by the log observer(s)
</span><span class="cx">         if not self.willLogAtLevel(level):
</span><span class="lines">@@ -274,10 +277,6 @@
</span><span class="cx">         if level in pythonLogLevelMapping:
</span><span class="cx">             kwargs[&quot;logLevel&quot;] = pythonLogLevelMapping[level]
</span><span class="cx"> 
</span><del>-        if message:
-            kwargs[&quot;legacyMessage&quot;] = message
-            kwargs[&quot;format&quot;] = &quot;%(legacyMessage)s&quot;
-
</del><span class="cx">         prefix = &quot;[%(namespace)s#%(levelName)s] &quot;
</span><span class="cx"> 
</span><span class="cx">         if &quot;failure&quot; in kwargs:
</span><span class="lines">@@ -288,9 +287,21 @@
</span><span class="cx">                 why = &quot;Unhandled Error&quot;
</span><span class="cx">             kwargs[&quot;why&quot;] = &quot;%s%s&quot; % (prefix % kwargs, why)
</span><span class="cx"> 
</span><del>-        if &quot;format&quot; in kwargs:
-            kwargs[&quot;format&quot;] = &quot;%s%s&quot; % (prefix, kwargs[&quot;format&quot;])
</del><ins>+        if format:
+            kwargs[&quot;log_format&quot;] = format
</ins><span class="cx"> 
</span><ins>+            #
+            # Create an object that implements __str__() in order to
+            # defer the work of formatting until it's needed by a
+            # legacy log observer.
+            #
+            class LegacyFormatStub(object):
+                def __str__(self):
+                    return format.format(**kwargs)
+
+            kwargs[&quot;format&quot;] = prefix + &quot;%(log_legacy)s&quot;
+            kwargs[&quot;log_legacy&quot;] = LegacyFormatStub()
+
</ins><span class="cx">         twistedLogMessage(**kwargs)
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -390,8 +401,8 @@
</span><span class="cx">     #
</span><span class="cx">     # Attach methods to Logger
</span><span class="cx">     #
</span><del>-    def log_emit(self, message=None, **kwargs):
-        self.emit(level, message, **kwargs)
</del><ins>+    def log_emit(self, format=None, **kwargs):
+        self.emit(level, format, **kwargs)
</ins><span class="cx"> 
</span><span class="cx">     def will_emit(self):
</span><span class="cx">         return self.willLogAtLevel(level)
</span></span></pre></div>
<a id="CalendarServertrunktwextpythontesttest_logpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/python/test/test_log.py (11325 => 11326)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/python/test/test_log.py        2013-06-07 16:43:52 UTC (rev 11325)
+++ CalendarServer/trunk/twext/python/test/test_log.py        2013-06-10 21:29:13 UTC (rev 11326)
</span><span class="lines">@@ -72,7 +72,7 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def __str__(self):
</span><del>-        return &quot;&lt;LogComposedObject %s&gt;&quot; % (self.state,)
</del><ins>+        return &quot;&lt;LogComposedObject {state}&gt;&quot;.format(state=self.state)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -126,7 +126,7 @@
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         obj = LogComposedObject(&quot;hello&quot;)
</span><span class="cx">         log = obj.log
</span><del>-        log.error(format=&quot;Hello. %(source)s&quot;)
</del><ins>+        log.error(&quot;Hello. {source}&quot;)
</ins><span class="cx">         stuff = twistedLogging.textFromEventDict(log.eventDict)
</span><span class="cx">         self.assertIn(&quot;Hello. &lt;LogComposedObject hello&gt;&quot;, stuff)
</span><span class="cx"> 
</span><span class="lines">@@ -137,7 +137,7 @@
</span><span class="cx">         Logger.
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         for level in LogLevel.iterconstants():
</span><del>-            message = &quot;This is a %s message&quot; % (level.name,)
</del><ins>+            message = &quot;This is a {level} message&quot;.format(level=level.name)
</ins><span class="cx"> 
</span><span class="cx">             log = TestLogger()
</span><span class="cx">             method = getattr(log, level.name)
</span><span class="lines">@@ -306,6 +306,18 @@
</span><span class="cx">                 self.assertFalse(log.willLogAtLevel(level))
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+    def test_logInvalidLogLevel(self):
+        &quot;&quot;&quot;
+        Test passing in a bogus log level to C{emit()}.
+        &quot;&quot;&quot;
+        log = TestLogger()
+
+        log.emit(&quot;*bogus*&quot;)
+
+        errors = self.flushLoggedErrors(InvalidLogLevelError)
+        self.assertEquals(len(errors), 1)
+
+
</ins><span class="cx">     def test_legacy_msg(self):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         Test LegacyLogger's log.msg()
</span></span></pre>
</div>
</div>

</body>
</html>