264 lines
15 KiB
HTML
264 lines
15 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<meta name="generator" content="pdoc 0.6.3" />
|
|
<title>onionr.logger API documentation</title>
|
|
<meta name="description" content="Onionr - Private P2P Communication …" />
|
|
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
|
|
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
|
|
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<article id="content">
|
|
<header>
|
|
<h1 class="title">Module <code>onionr.logger</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>Onionr - Private P2P Communication</p>
|
|
<p>This file handles all operations involving logging</p>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">'''
|
|
Onionr - Private P2P Communication
|
|
|
|
This file handles all operations involving logging
|
|
'''
|
|
'''
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
'''
|
|
|
|
import sys, traceback
|
|
|
|
from . import colors, readline, log, raw, confirm, colors, settings
|
|
colors = colors.Colors
|
|
readline = readline.readline
|
|
log = log.log
|
|
raw = raw.raw
|
|
confirm = confirm.confirm
|
|
|
|
# debug: when there is info that could be useful for debugging purposes only
|
|
def debug(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_DEBUG):
|
|
if settings.get_level() <= level:
|
|
log('/', data, timestamp = timestamp, prompt = prompt, terminal = terminal)
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())
|
|
|
|
# info: when there is something to notify the user of, such as the success of a process
|
|
def info(data: str, timestamp = False, prompt = True, terminal = False, level = settings.LEVEL_INFO):
|
|
if settings.get_level() <= level:
|
|
log('+', data, colors.fg.green, timestamp = timestamp, prompt = prompt, terminal = terminal)
|
|
|
|
# warn: when there is a potential for something bad to happen
|
|
def warn(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_WARN):
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())
|
|
if settings.get_level() <= level:
|
|
log('!', data, colors.fg.orange, timestamp = timestamp, prompt = prompt, terminal = terminal)
|
|
|
|
# error: when only one function, module, or process of the program encountered a problem and must stop
|
|
def error(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_ERROR):
|
|
if settings.get_level() <= level:
|
|
log('-', data, colors.fg.red, timestamp = timestamp, fd = sys.stderr, prompt = prompt, terminal = terminal)
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())
|
|
|
|
# fatal: when the something so bad has happened that the program must stop
|
|
def fatal(data: str, error = None, timestamp=True, prompt = True, terminal = False, level = settings.LEVEL_FATAL):
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error(), terminal = terminal)
|
|
if settings.get_level() <= level:
|
|
log('#', data, colors.bg.red + colors.fg.green + colors.bold, timestamp = timestamp, fd = sys.stderr, prompt = prompt, terminal = terminal)
|
|
|
|
# returns a formatted error message
|
|
def parse_error():
|
|
details = traceback.extract_tb(sys.exc_info()[2])
|
|
output = ''
|
|
|
|
for line in details:
|
|
output += '\n ... module %s in %s:%i' % (line[2], line[0], line[1])
|
|
|
|
return output</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
|
|
<dl>
|
|
<dt><code class="name"><a title="onionr.logger.colors" href="colors.html">onionr.logger.colors</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
<dt><code class="name"><a title="onionr.logger.confirm" href="confirm.html">onionr.logger.confirm</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
<dt><code class="name"><a title="onionr.logger.log" href="log.html">onionr.logger.log</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
<dt><code class="name"><a title="onionr.logger.raw" href="raw.html">onionr.logger.raw</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
<dt><code class="name"><a title="onionr.logger.readline" href="readline.html">onionr.logger.readline</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
<dt><code class="name"><a title="onionr.logger.settings" href="settings.html">onionr.logger.settings</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
<dl>
|
|
<dt id="onionr.logger.debug"><code class="name flex">
|
|
<span>def <span class="ident">debug</span></span>(<span>data, error=None, timestamp=True, prompt=True, terminal=False, level=1)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def debug(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_DEBUG):
|
|
if settings.get_level() <= level:
|
|
log('/', data, timestamp = timestamp, prompt = prompt, terminal = terminal)
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="onionr.logger.error"><code class="name flex">
|
|
<span>def <span class="ident">error</span></span>(<span>data, error=None, timestamp=True, prompt=True, terminal=False, level=4)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def error(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_ERROR):
|
|
if settings.get_level() <= level:
|
|
log('-', data, colors.fg.red, timestamp = timestamp, fd = sys.stderr, prompt = prompt, terminal = terminal)
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="onionr.logger.fatal"><code class="name flex">
|
|
<span>def <span class="ident">fatal</span></span>(<span>data, error=None, timestamp=True, prompt=True, terminal=False, level=5)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def fatal(data: str, error = None, timestamp=True, prompt = True, terminal = False, level = settings.LEVEL_FATAL):
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error(), terminal = terminal)
|
|
if settings.get_level() <= level:
|
|
log('#', data, colors.bg.red + colors.fg.green + colors.bold, timestamp = timestamp, fd = sys.stderr, prompt = prompt, terminal = terminal)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="onionr.logger.info"><code class="name flex">
|
|
<span>def <span class="ident">info</span></span>(<span>data, timestamp=False, prompt=True, terminal=False, level=2)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def info(data: str, timestamp = False, prompt = True, terminal = False, level = settings.LEVEL_INFO):
|
|
if settings.get_level() <= level:
|
|
log('+', data, colors.fg.green, timestamp = timestamp, prompt = prompt, terminal = terminal)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="onionr.logger.parse_error"><code class="name flex">
|
|
<span>def <span class="ident">parse_error</span></span>(<span>)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def parse_error():
|
|
details = traceback.extract_tb(sys.exc_info()[2])
|
|
output = ''
|
|
|
|
for line in details:
|
|
output += '\n ... module %s in %s:%i' % (line[2], line[0], line[1])
|
|
|
|
return output</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="onionr.logger.warn"><code class="name flex">
|
|
<span>def <span class="ident">warn</span></span>(<span>data, error=None, timestamp=True, prompt=True, terminal=False, level=3)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>Source code</summary>
|
|
<pre><code class="python">def warn(data: str, error = None, timestamp = True, prompt = True, terminal = False, level = settings.LEVEL_WARN):
|
|
if not error is None:
|
|
debug('Error: ' + str(error) + parse_error())
|
|
if settings.get_level() <= level:
|
|
log('!', data, colors.fg.orange, timestamp = timestamp, prompt = prompt, terminal = terminal)</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
</article>
|
|
<nav id="sidebar">
|
|
<h1>Index</h1>
|
|
<div class="toc">
|
|
<ul></ul>
|
|
</div>
|
|
<ul id="index">
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code><a title="onionr" href="../index.html">onionr</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
|
|
<ul>
|
|
<li><code><a title="onionr.logger.colors" href="colors.html">onionr.logger.colors</a></code></li>
|
|
<li><code><a title="onionr.logger.confirm" href="confirm.html">onionr.logger.confirm</a></code></li>
|
|
<li><code><a title="onionr.logger.log" href="log.html">onionr.logger.log</a></code></li>
|
|
<li><code><a title="onionr.logger.raw" href="raw.html">onionr.logger.raw</a></code></li>
|
|
<li><code><a title="onionr.logger.readline" href="readline.html">onionr.logger.readline</a></code></li>
|
|
<li><code><a title="onionr.logger.settings" href="settings.html">onionr.logger.settings</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
<ul class="two-column">
|
|
<li><code><a title="onionr.logger.debug" href="#onionr.logger.debug">debug</a></code></li>
|
|
<li><code><a title="onionr.logger.error" href="#onionr.logger.error">error</a></code></li>
|
|
<li><code><a title="onionr.logger.fatal" href="#onionr.logger.fatal">fatal</a></code></li>
|
|
<li><code><a title="onionr.logger.info" href="#onionr.logger.info">info</a></code></li>
|
|
<li><code><a title="onionr.logger.parse_error" href="#onionr.logger.parse_error">parse_error</a></code></li>
|
|
<li><code><a title="onionr.logger.warn" href="#onionr.logger.warn">warn</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
|
|
</footer>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad()</script>
|
|
</body>
|
|
</html> |