474 lines
35 KiB
HTML
474 lines
35 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Welcome to report documentation! — report documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=67a6116b" />
|
||
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=5ff89526" />
|
||
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css?v=5349f25f" />
|
||
|
||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" /><link rel="stylesheet" href="_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
|
||
<link rel="shortcut icon" type="image/png" href="_static/py.svg">
|
||
<script type="text/javascript" src="_static/copybutton.js"></script>
|
||
<script type="text/javascript" src="_static/menu.js"></script>
|
||
<script type="text/javascript" src="_static/search-focus.js"></script>
|
||
<script type="text/javascript" src="_static/themetoggle.js"></script>
|
||
</head>
|
||
<body>
|
||
<div class="mobile-nav">
|
||
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
|
||
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">
|
||
<nav class="nav-content" role="navigation">
|
||
<label for="menuToggler" class="toggler__label">
|
||
<span></span>
|
||
</label>
|
||
<span class="nav-items-wrapper">
|
||
<a href="https://www.python.org/" class="nav-logo">
|
||
<img src="_static/py.svg" alt="Python logo">
|
||
</a>
|
||
<span class="version_switcher_placeholder"></span>
|
||
<form role="search" class="search" action="search.html" method="get">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
|
||
<path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
|
||
</svg>
|
||
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q">
|
||
<input type="submit" value="Go">
|
||
</form>
|
||
</span>
|
||
</nav>
|
||
<div class="menu-wrapper">
|
||
<nav class="menu" role="navigation" aria-label="main navigation">
|
||
<div class="language_switcher_placeholder"></div>
|
||
|
||
<label class="theme-selector-label">
|
||
Theme
|
||
<select class="theme-selector" oninput="activateTheme(this.value)">
|
||
<option value="auto" selected>Auto</option>
|
||
<option value="light">Light</option>
|
||
<option value="dark">Dark</option>
|
||
</select>
|
||
</label>
|
||
<div>
|
||
<h3><a href="#">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Welcome to report documentation!</a><ul>
|
||
<li><a class="reference internal" href="#report-report-module">report (Report Module)</a></li>
|
||
<li><a class="reference internal" href="#report.DEFAULT_FMT"><code class="docutils literal notranslate"><span class="pre">DEFAULT_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.JOURNAL_FMT"><code class="docutils literal notranslate"><span class="pre">JOURNAL_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.JsonFormatter"><code class="docutils literal notranslate"><span class="pre">JsonFormatter</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.JsonFormatter.format"><code class="docutils literal notranslate"><span class="pre">JsonFormatter.format()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.LONG_FMT"><code class="docutils literal notranslate"><span class="pre">LONG_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.SHORT_FMT"><code class="docutils literal notranslate"><span class="pre">SHORT_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_FULL"><code class="docutils literal notranslate"><span class="pre">TCEL_FULL</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_NAMES"><code class="docutils literal notranslate"><span class="pre">TCEL_NAMES</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_REVERSE_NAMED"><code class="docutils literal notranslate"><span class="pre">TCEL_REVERSE_NAMED</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SHORT"><code class="docutils literal notranslate"><span class="pre">TCEL_SHORT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SINGLE"><code class="docutils literal notranslate"><span class="pre">TCEL_SINGLE</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SMOKE"><code class="docutils literal notranslate"><span class="pre">TCEL_SMOKE</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.app_logging_config"><code class="docutils literal notranslate"><span class="pre">app_logging_config()</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.collectingHandler"><code class="docutils literal notranslate"><span class="pre">collectingHandler</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.collectingHandler.emit"><code class="docutils literal notranslate"><span class="pre">collectingHandler.emit()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.collectingRingHandler"><code class="docutils literal notranslate"><span class="pre">collectingRingHandler</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.collectingTestcaseHandler"><code class="docutils literal notranslate"><span class="pre">collectingTestcaseHandler</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.collectingTestcaseHandler.emit"><code class="docutils literal notranslate"><span class="pre">collectingTestcaseHandler.emit()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.default_logging_config"><code class="docutils literal notranslate"><span class="pre">default_logging_config()</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.testSession"><code class="docutils literal notranslate"><span class="pre">testSession</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/index.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
|
||
<li><a href="https://www.python.org/">Python</a> »</li>
|
||
<li class="switchers">
|
||
<div class="language_switcher_placeholder"></div>
|
||
<div class="version_switcher_placeholder"></div>
|
||
</li>
|
||
<li>
|
||
|
||
<a href="#">report documentation</a> »
|
||
|
||
</li>
|
||
<li class="nav-item nav-item-this"><a href="">Welcome to report documentation!</a></li>
|
||
<li class="right">
|
||
|
||
|
||
<div class="inline-search" role="search">
|
||
<form class="inline-search" action="search.html" method="get">
|
||
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
|
||
<input type="submit" value="Go">
|
||
</form>
|
||
</div>
|
||
|
|
||
</li>
|
||
<li class="right">
|
||
<label class="theme-selector-label">
|
||
Theme
|
||
<select class="theme-selector" oninput="activateTheme(this.value)">
|
||
<option value="auto" selected>Auto</option>
|
||
<option value="light">Light</option>
|
||
<option value="dark">Dark</option>
|
||
</select>
|
||
</label> |</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-report">
|
||
<span id="welcome-to-report-documentation"></span><h1>Welcome to report documentation!<a class="headerlink" href="#module-report" title="Link to this heading">¶</a></h1>
|
||
<section id="report-report-module">
|
||
<h2>report (Report Module)<a class="headerlink" href="#report-report-module" title="Link to this heading">¶</a></h2>
|
||
<p><strong>Author:</strong></p>
|
||
<ul class="simple">
|
||
<li><p>Dirk Alders <<a class="reference external" href="mailto:sudo-dirk%40mount-mockery.de">sudo-dirk<span>@</span>mount-mockery<span>.</span>de</a>></p></li>
|
||
</ul>
|
||
<p><strong>Description:</strong></p>
|
||
<blockquote>
|
||
<div><p>The Module is designed to help with python logging and to support some handlers for logging to memory.</p>
|
||
</div></blockquote>
|
||
<p><strong>Submodules:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#report.collectingHandler" title="report.collectingHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">report.collectingHandler</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#report.collectingRingHandler" title="report.collectingRingHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">report.collectingRingHandler</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#report.collectingTestcaseHandler" title="report.collectingTestcaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">report.collectingTestcaseHandler</span></code></a></p></li>
|
||
<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">report.consoleLoggingConfigure()</span></code></p></li>
|
||
<li><p><a class="reference internal" href="#report.testSession" title="report.testSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">report.testSession</span></code></a></p></li>
|
||
</ul>
|
||
<p><strong>Unittest:</strong></p>
|
||
<blockquote>
|
||
<div><p>See also the <code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code> documentation.</p>
|
||
</div></blockquote>
|
||
</section>
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.DEFAULT_FMT">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">DEFAULT_FMT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%(asctime)s:</span> <span class="pre">%(levelname)8s</span> <span class="pre">-</span> <span class="pre">%(name)s</span> <span class="pre">-</span> <span class="pre">%(message)s\n</span>                                    <span class="pre">File</span> <span class="pre">"%(pathname)s",</span> <span class="pre">line</span> <span class="pre">%(lineno)d,</span> <span class="pre">in</span> <span class="pre">%(funcName)s'</span></em><a class="headerlink" href="#report.DEFAULT_FMT" title="Link to this definition">¶</a></dt>
|
||
<dd><p>The default formatstring</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.JOURNAL_FMT">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">JOURNAL_FMT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%(levelname)8s</span> <span class="pre">-</span> <span class="pre">%(name)s</span> <span class="pre">-</span> <span class="pre">%(message)s'</span></em><a class="headerlink" href="#report.JOURNAL_FMT" title="Link to this definition">¶</a></dt>
|
||
<dd><p>A short journal formatter including the most important information</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="report.JsonFormatter">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">JsonFormatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datefmt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'%'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.JsonFormatter" title="Link to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt class="sig sig-object py" id="report.JsonFormatter.format">
|
||
<span class="sig-name descname"><span class="pre">format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.JsonFormatter.format" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Format the specified record as text.</p>
|
||
<p>The record’s attribute dictionary is used as the operand to a
|
||
string formatting operation which yields the returned string.
|
||
Before formatting the dictionary, a couple of preparatory steps
|
||
are carried out. The message attribute of the record is computed
|
||
using LogRecord.getMessage(). If the formatting string uses the
|
||
time (as determined by a call to usesTime(), formatTime() is
|
||
called to format the event time. If there is exception information,
|
||
it is formatted using formatException() and appended to the message.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.LONG_FMT">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">LONG_FMT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%(asctime)s:</span> <span class="pre">%(levelname)8s</span> <span class="pre">-</span> <span class="pre">%(name)s</span> <span class="pre">-</span> <span class="pre">%(message)s\n</span>                                    <span class="pre">File</span> <span class="pre">"%(pathname)s",</span> <span class="pre">line</span> <span class="pre">%(lineno)d,</span> <span class="pre">in</span> <span class="pre">%(funcName)s'</span></em><a class="headerlink" href="#report.LONG_FMT" title="Link to this definition">¶</a></dt>
|
||
<dd><p>A long formatter which results in links to the source code inside Eclipse</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.SHORT_FMT">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">SHORT_FMT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%(asctime)s:</span> <span class="pre">%(levelname)8s</span> <span class="pre">-</span> <span class="pre">%(name)s</span> <span class="pre">-</span> <span class="pre">%(message)s'</span></em><a class="headerlink" href="#report.SHORT_FMT" title="Link to this definition">¶</a></dt>
|
||
<dd><p>A short formatter including the most important information</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_FULL">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_FULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">90</span></em><a class="headerlink" href="#report.TCEL_FULL" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Testcase level (full), this is a complete test for the full functionality</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_NAMES">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_NAMES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">'Single</span> <span class="pre">Test',</span> <span class="pre">10:</span> <span class="pre">'Smoke</span> <span class="pre">Test</span> <span class="pre">(Minumum</span> <span class="pre">subset)',</span> <span class="pre">50:</span> <span class="pre">'Short</span> <span class="pre">Test</span> <span class="pre">(Subset)',</span> <span class="pre">90:</span> <span class="pre">'Full</span> <span class="pre">Test</span> <span class="pre">(all</span> <span class="pre">defined</span> <span class="pre">tests)'}</span></em><a class="headerlink" href="#report.TCEL_NAMES" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Dictionary for resolving the test case levels (TCL) to a (human readable) name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_REVERSE_NAMED">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_REVERSE_NAMED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'full':</span> <span class="pre">90,</span> <span class="pre">'short':</span> <span class="pre">50,</span> <span class="pre">'single':</span> <span class="pre">0,</span> <span class="pre">'smoke':</span> <span class="pre">10}</span></em><a class="headerlink" href="#report.TCEL_REVERSE_NAMED" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Dictionary for resolving named test case levels (TCL) to test case level number</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_SHORT">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_SHORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></em><a class="headerlink" href="#report.TCEL_SHORT" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Testcase level (short), this is a short test for an extended functionality</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_SINGLE">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_SINGLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#report.TCEL_SINGLE" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Testcase level (smoke), this is just a rough test for the main functionality</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="report.TCEL_SMOKE">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">TCEL_SMOKE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#report.TCEL_SMOKE" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Testcase level (smoke), this is just a rough test for the main functionality</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="report.app_logging_config">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">app_logging_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#report.app_logging_config" title="Link to this definition">¶</a></dt>
|
||
<dd><p>For details see comment in default_logging_config.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="report.collectingHandler">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">collectingHandler</span></span><a class="headerlink" href="#report.collectingHandler" title="Link to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt class="sig sig-object py" id="report.collectingHandler.emit">
|
||
<span class="sig-name descname"><span class="pre">emit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.collectingHandler.emit" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Do whatever it takes to actually log the specified logging record.</p>
|
||
<p>This version is intended to be implemented by subclasses and so
|
||
raises a NotImplementedError.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="report.collectingRingHandler">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">collectingRingHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_logs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.collectingRingHandler" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="report.collectingTestcaseHandler">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">collectingTestcaseHandler</span></span><a class="headerlink" href="#report.collectingTestcaseHandler" title="Link to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt class="sig sig-object py" id="report.collectingTestcaseHandler.emit">
|
||
<span class="sig-name descname"><span class="pre">emit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.collectingTestcaseHandler.emit" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Do whatever it takes to actually log the specified logging record.</p>
|
||
<p>This version is intended to be implemented by subclasses and so
|
||
raises a NotImplementedError.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="report.default_logging_config">
|
||
<span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">default_logging_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'%(levelname)8s</span> <span class="pre">-</span> <span class="pre">%(name)s</span> <span class="pre">-</span> <span class="pre">%(message)s'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.default_logging_config" title="Link to this definition">¶</a></dt>
|
||
<dd><p>You are able to configure logging by a config file including these line:</p>
|
||
<p>import logging</p>
|
||
<p>DEBUG = False
|
||
#
|
||
# Logging
|
||
#
|
||
APP_NAME = “<YOUR_APP_NAME>”
|
||
LOG_HOSTNAME = “loggy” # When DEBUG is True
|
||
LOG_LEVEL = logging.INFO # STDOUT logging</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="report.testSession">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">report.</span></span><span class="sig-name descname"><span class="pre">testSession</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#report.testSession" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</section>
|
||
<section id="indices-and-tables">
|
||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||
</ul>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<div>
|
||
<h3><a href="#">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Welcome to report documentation!</a><ul>
|
||
<li><a class="reference internal" href="#report-report-module">report (Report Module)</a></li>
|
||
<li><a class="reference internal" href="#report.DEFAULT_FMT"><code class="docutils literal notranslate"><span class="pre">DEFAULT_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.JOURNAL_FMT"><code class="docutils literal notranslate"><span class="pre">JOURNAL_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.JsonFormatter"><code class="docutils literal notranslate"><span class="pre">JsonFormatter</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.JsonFormatter.format"><code class="docutils literal notranslate"><span class="pre">JsonFormatter.format()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.LONG_FMT"><code class="docutils literal notranslate"><span class="pre">LONG_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.SHORT_FMT"><code class="docutils literal notranslate"><span class="pre">SHORT_FMT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_FULL"><code class="docutils literal notranslate"><span class="pre">TCEL_FULL</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_NAMES"><code class="docutils literal notranslate"><span class="pre">TCEL_NAMES</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_REVERSE_NAMED"><code class="docutils literal notranslate"><span class="pre">TCEL_REVERSE_NAMED</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SHORT"><code class="docutils literal notranslate"><span class="pre">TCEL_SHORT</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SINGLE"><code class="docutils literal notranslate"><span class="pre">TCEL_SINGLE</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.TCEL_SMOKE"><code class="docutils literal notranslate"><span class="pre">TCEL_SMOKE</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.app_logging_config"><code class="docutils literal notranslate"><span class="pre">app_logging_config()</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.collectingHandler"><code class="docutils literal notranslate"><span class="pre">collectingHandler</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.collectingHandler.emit"><code class="docutils literal notranslate"><span class="pre">collectingHandler.emit()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.collectingRingHandler"><code class="docutils literal notranslate"><span class="pre">collectingRingHandler</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.collectingTestcaseHandler"><code class="docutils literal notranslate"><span class="pre">collectingTestcaseHandler</span></code></a><ul>
|
||
<li><a class="reference internal" href="#report.collectingTestcaseHandler.emit"><code class="docutils literal notranslate"><span class="pre">collectingTestcaseHandler.emit()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#report.default_logging_config"><code class="docutils literal notranslate"><span class="pre">default_logging_config()</span></code></a></li>
|
||
<li><a class="reference internal" href="#report.testSession"><code class="docutils literal notranslate"><span class="pre">testSession</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/index.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
|
||
<li><a href="https://www.python.org/">Python</a> »</li>
|
||
<li class="switchers">
|
||
<div class="language_switcher_placeholder"></div>
|
||
<div class="version_switcher_placeholder"></div>
|
||
</li>
|
||
<li>
|
||
|
||
<a href="#">report documentation</a> »
|
||
|
||
</li>
|
||
<li class="nav-item nav-item-this"><a href="">Welcome to report documentation!</a></li>
|
||
<li class="right">
|
||
|
||
|
||
<div class="inline-search" role="search">
|
||
<form class="inline-search" action="search.html" method="get">
|
||
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
|
||
<input type="submit" value="Go">
|
||
</form>
|
||
</div>
|
||
|
|
||
</li>
|
||
<li class="right">
|
||
<label class="theme-selector-label">
|
||
Theme
|
||
<select class="theme-selector" oninput="activateTheme(this.value)">
|
||
<option value="auto" selected>Auto</option>
|
||
<option value="light">Light</option>
|
||
<option value="dark">Dark</option>
|
||
</select>
|
||
</label> |</li>
|
||
|
||
</ul>
|
||
</div>
|
||
<div class="footer">
|
||
©
|
||
Copyright
|
||
2025, Dirk Alders.
|
||
<br>
|
||
This page is licensed under the Python Software Foundation License Version 2.
|
||
<br>
|
||
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
|
||
<br>
|
||
|
||
|
||
<br>
|
||
|
||
The Python Software Foundation is a non-profit corporation.
|
||
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
||
<br>
|
||
<br>
|
||
|
||
<br>
|
||
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
||
</div>
|
||
|
||
</body>
|
||
</html> |