<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>stem.util.log — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/theme_extras.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="../../../index.html" />
<link rel="up" title="stem" href="../../stem.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="../../../_static/logo.png" alt="Logo"/><h1 class="heading"><a href="../../../index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>stem.util.log</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="../../../index.html">Home</a></li>
<li><a href="../../../tutorials.html">Tutorials</a>
<ul>
<li><a href="../../../tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="../../../tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="../../../tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="../../../tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="../../../tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="../../../tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="../../../api.html">API</a>
<ul>
<li><a href="../../../api/control.html">stem.control</a></li>
<li><a href="../../../api/connection.html">stem.connection</a></li>
<li><a href="../../../api/socket.html">stem.socket</a></li>
<li><a href="../../../api/process.html">stem.process</a></li>
<li><a href="../../../api/response.html">stem.response</a></li>
<li><a href="../../../api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="../../../api/version.html">stem.version</a></li>
<li><a href="../../../api.html#descriptors">Descriptors</a></li>
<li><a href="../../../api.html#utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="../../../faq.html">FAQ</a></li>
<li><a href="../../../change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="../../../download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<h1>Source code for stem.util.log</h1><div class="highlight"><pre>
<span class="c"># Copyright 2011-2013, Damian Johnson and The Tor Project</span>
<span class="c"># See LICENSE for licensing information</span>
<span class="sd">"""</span>
<span class="sd">Functions to aid library logging. The default logging</span>
<span class="sd">:data:`~stem.util.log.Runlevel` is usually NOTICE and above.</span>
<span class="sd">**Stem users are more than welcome to listen for stem events, but these</span>
<span class="sd">functions are not being vended to our users. They may change in the future, use</span>
<span class="sd">them at your own risk.**</span>
<span class="sd">**Module Overview:**</span>
<span class="sd">::</span>
<span class="sd"> get_logger - provides the stem's Logger instance</span>
<span class="sd"> logging_level - converts a runlevel to its logging number</span>
<span class="sd"> escape - escapes special characters in a message in preparation for logging</span>
<span class="sd"> log - logs a message at the given runlevel</span>
<span class="sd"> log_once - logs a message, deduplicating if it has already been logged</span>
<span class="sd"> trace - logs a message at the TRACE runlevel</span>
<span class="sd"> debug - logs a message at the DEBUG runlevel</span>
<span class="sd"> info - logs a message at the INFO runlevel</span>
<span class="sd"> notice - logs a message at the NOTICE runlevel</span>
<span class="sd"> warn - logs a message at the WARN runlevel</span>
<span class="sd"> error - logs a message at the ERROR runlevel</span>
<span class="sd"> LogBuffer - Buffers logged events so they can be iterated over.</span>
<span class="sd"> |- is_empty - checks if there's events in our buffer</span>
<span class="sd"> +- __iter__ - iterates over and removes the buffered events</span>
<span class="sd"> log_to_stdout - reports further logged events to stdout</span>
<span class="sd">.. data:: Runlevel (enum)</span>
<span class="sd"> Enumeration for logging runlevels.</span>
<span class="sd"> ========== ===========</span>
<span class="sd"> Runlevel Description</span>
<span class="sd"> ========== ===========</span>
<span class="sd"> **ERROR** critical issue occurred, the user needs to be notified</span>
<span class="sd"> **WARN** non-critical issue occurred that the user should be aware of</span>
<span class="sd"> **NOTICE** information that is helpful to the user</span>
<span class="sd"> **INFO** high level library activity</span>
<span class="sd"> **DEBUG** low level library activity</span>
<span class="sd"> **TRACE** request/reply logging</span>
<span class="sd"> ========== ===========</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">stem.prereq</span>
<span class="kn">import</span> <span class="nn">stem.util.enum</span>
<span class="kn">import</span> <span class="nn">stem.util.str_tools</span>
<span class="c"># Logging runlevels. These are *very* commonly used so including shorter</span>
<span class="c"># aliases (so they can be referenced as log.DEBUG, log.WARN, etc).</span>
<span class="n">Runlevel</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">enum</span><span class="o">.</span><span class="n">UppercaseEnum</span><span class="p">(</span><span class="s">"TRACE"</span><span class="p">,</span> <span class="s">"DEBUG"</span><span class="p">,</span> <span class="s">"INFO"</span><span class="p">,</span> <span class="s">"NOTICE"</span><span class="p">,</span> <span class="s">"WARN"</span><span class="p">,</span> <span class="s">"ERROR"</span><span class="p">)</span>
<span class="n">TRACE</span><span class="p">,</span> <span class="n">DEBUG</span><span class="p">,</span> <span class="n">INFO</span><span class="p">,</span> <span class="n">NOTICE</span><span class="p">,</span> <span class="n">WARN</span><span class="p">,</span> <span class="n">ERR</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">Runlevel</span><span class="p">)</span>
<span class="c"># mapping of runlevels to the logger module's values, TRACE and DEBUG aren't</span>
<span class="c"># built into the module</span>
<span class="n">LOG_VALUES</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">TRACE</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span> <span class="o">-</span> <span class="mi">5</span><span class="p">,</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">INFO</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">NOTICE</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span> <span class="o">+</span> <span class="mi">5</span><span class="p">,</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">WARN</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARN</span><span class="p">,</span>
<span class="n">Runlevel</span><span class="o">.</span><span class="n">ERROR</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">logging</span><span class="o">.</span><span class="n">addLevelName</span><span class="p">(</span><span class="n">LOG_VALUES</span><span class="p">[</span><span class="n">TRACE</span><span class="p">],</span> <span class="s">"TRACE"</span><span class="p">)</span>
<span class="n">logging</span><span class="o">.</span><span class="n">addLevelName</span><span class="p">(</span><span class="n">LOG_VALUES</span><span class="p">[</span><span class="n">NOTICE</span><span class="p">],</span> <span class="s">"NOTICE"</span><span class="p">)</span>
<span class="n">LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">"stem"</span><span class="p">)</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">LOG_VALUES</span><span class="p">[</span><span class="n">TRACE</span><span class="p">])</span>
<span class="c"># There's some messages that we don't want to log more than once. This set has</span>
<span class="c"># the messages IDs that we've logged which fall into this category.</span>
<span class="n">DEDUPLICATION_MESSAGE_IDS</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="c"># Adds a default nullhandler for the stem logger, suppressing the 'No handlers</span>
<span class="c"># could be found for logger "stem"' warning as per...</span>
<span class="c"># http://docs.python.org/release/3.1.3/library/logging.html#configuring-logging-for-a-library</span>
<span class="k">class</span> <span class="nc">_NullHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">LOGGER</span><span class="o">.</span><span class="n">handlers</span><span class="p">:</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">_NullHandler</span><span class="p">())</span>
<div class="viewcode-block" id="get_logger"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.get_logger">[docs]</a><span class="k">def</span> <span class="nf">get_logger</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Provides the stem logger.</span>
<span class="sd"> :return: **logging.Logger** for stem</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">LOGGER</span>
</div>
<div class="viewcode-block" id="logging_level"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.logging_level">[docs]</a><span class="k">def</span> <span class="nf">logging_level</span><span class="p">(</span><span class="n">runlevel</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Translates a runlevel into the value expected by the logging module.</span>
<span class="sd"> :param stem.util.log.Runlevel runlevel: runlevel to be returned, no logging if **None**</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">runlevel</span><span class="p">:</span>
<span class="k">return</span> <span class="n">LOG_VALUES</span><span class="p">[</span><span class="n">runlevel</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">logging</span><span class="o">.</span><span class="n">FATAL</span> <span class="o">+</span> <span class="mi">5</span>
</div>
<div class="viewcode-block" id="escape"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.escape">[docs]</a><span class="k">def</span> <span class="nf">escape</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Escapes specific sequences for logging (newlines, tabs, carriage returns). If</span>
<span class="sd"> the input is **bytes** then this converts it to **unicode** under python 3.x.</span>
<span class="sd"> :param str message: string to be escaped</span>
<span class="sd"> :returns: str that is escaped</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">stem</span><span class="o">.</span><span class="n">prereq</span><span class="o">.</span><span class="n">is_python_3</span><span class="p">():</span>
<span class="n">message</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">str_tools</span><span class="o">.</span><span class="n">_to_unicode</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="k">for</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">replacement</span> <span class="ow">in</span> <span class="p">((</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="s">"</span><span class="se">\\</span><span class="s">n"</span><span class="p">),</span> <span class="p">(</span><span class="s">"</span><span class="se">\r</span><span class="s">"</span><span class="p">,</span> <span class="s">"</span><span class="se">\\</span><span class="s">r"</span><span class="p">),</span> <span class="p">(</span><span class="s">"</span><span class="se">\t</span><span class="s">"</span><span class="p">,</span> <span class="s">"</span><span class="se">\\</span><span class="s">t"</span><span class="p">)):</span>
<span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">replacement</span><span class="p">)</span>
<span class="k">return</span> <span class="n">message</span>
</div>
<div class="viewcode-block" id="log"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.log">[docs]</a><span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="n">runlevel</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Logs a message at the given runlevel.</span>
<span class="sd"> :param stem.util.log.Runlevel runlevel: runlevel to log the message at, logging is skipped if **None**</span>
<span class="sd"> :param str message: message to be logged</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">runlevel</span><span class="p">:</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">LOG_VALUES</span><span class="p">[</span><span class="n">runlevel</span><span class="p">],</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="log_once"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.log_once">[docs]</a><span class="k">def</span> <span class="nf">log_once</span><span class="p">(</span><span class="n">message_id</span><span class="p">,</span> <span class="n">runlevel</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Logs a message at the given runlevel. If a message with this ID has already</span>
<span class="sd"> been logged then this is a no-op.</span>
<span class="sd"> :param str message_id: unique message identifier to deduplicate on</span>
<span class="sd"> :param stem.util.log.Runlevel runlevel: runlevel to log the message at, logging is skipped if **None**</span>
<span class="sd"> :param str message: message to be logged</span>
<span class="sd"> :returns: **True** if we log the message, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">runlevel</span> <span class="ow">or</span> <span class="n">message_id</span> <span class="ow">in</span> <span class="n">DEDUPLICATION_MESSAGE_IDS</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">DEDUPLICATION_MESSAGE_IDS</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">message_id</span><span class="p">)</span>
<span class="n">log</span><span class="p">(</span><span class="n">runlevel</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
<span class="c"># shorter aliases for logging at a runlevel</span>
</div>
<div class="viewcode-block" id="trace"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.trace">[docs]</a><span class="k">def</span> <span class="nf">trace</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">TRACE</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="debug"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.debug">[docs]</a><span class="k">def</span> <span class="nf">debug</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="info"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.info">[docs]</a><span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="notice"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.notice">[docs]</a><span class="k">def</span> <span class="nf">notice</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">NOTICE</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="warn"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.warn">[docs]</a><span class="k">def</span> <span class="nf">warn</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">WARN</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="error"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.error">[docs]</a><span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="n">log</span><span class="p">(</span><span class="n">Runlevel</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="LogBuffer"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.LogBuffer">[docs]</a><span class="k">class</span> <span class="nc">LogBuffer</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Basic log handler that listens for stem events and stores them so they can be</span>
<span class="sd"> read later. Log entries are cleared as they are read.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">runlevel</span><span class="p">):</span>
<span class="c"># TODO: At least in python 2.6 logging.Handler has a bug in that it doesn't</span>
<span class="c"># extend object, causing our super() call to fail. When we drop python 2.6</span>
<span class="c"># support we should switch back to using super() instead.</span>
<span class="c">#super(LogBuffer, self).__init__(level = logging_level(runlevel))</span>
<span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span> <span class="o">=</span> <span class="n">logging_level</span><span class="p">(</span><span class="n">runlevel</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="s">'</span><span class="si">%(asctime)s</span><span class="s"> [</span><span class="si">%(levelname)s</span><span class="s">] </span><span class="si">%(message)s</span><span class="s">'</span><span class="p">,</span>
<span class="n">datefmt</span> <span class="o">=</span> <span class="s">'%m/</span><span class="si">%d</span><span class="s">/%Y %H:%M:%S'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span> <span class="o">=</span> <span class="p">[]</span>
<div class="viewcode-block" id="LogBuffer.is_empty"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.LogBuffer.is_empty">[docs]</a> <span class="k">def</span> <span class="nf">is_empty</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="ow">not</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="p">:</span>
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">formatter</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
<div class="viewcode-block" id="LogBuffer.emit"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.LogBuffer.emit">[docs]</a> <span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
</div></div>
<span class="k">class</span> <span class="nc">_StdoutLogger</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">runlevel</span><span class="p">):</span>
<span class="n">logging</span><span class="o">.</span><span class="n">Handler</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span> <span class="o">=</span> <span class="n">logging_level</span><span class="p">(</span><span class="n">runlevel</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="s">'</span><span class="si">%(asctime)s</span><span class="s"> [</span><span class="si">%(levelname)s</span><span class="s">] </span><span class="si">%(message)s</span><span class="s">'</span><span class="p">,</span>
<span class="n">datefmt</span> <span class="o">=</span> <span class="s">'%m/</span><span class="si">%d</span><span class="s">/%Y %H:%M:%S'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="k">print</span> <span class="bp">self</span><span class="o">.</span><span class="n">formatter</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
<div class="viewcode-block" id="log_to_stdout"><a class="viewcode-back" href="../../../api/util/log.html#stem.util.log.log_to_stdout">[docs]</a><span class="k">def</span> <span class="nf">log_to_stdout</span><span class="p">(</span><span class="n">runlevel</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Logs further events to stdout.</span>
<span class="sd"> :param stem.util.log.Runlevel runlevel: minimum runlevel a message needs to be to be logged</span>
<span class="sd"> """</span>
<span class="n">get_logger</span><span class="p">()</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">_StdoutLogger</span><span class="p">(</span><span class="n">runlevel</span><span class="p">))</span></div>
</pre></div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
