You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

446 lines
20 KiB

<!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.9.2" />
<title>TermTk.TTkCore.log API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.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%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}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{margin-top:.6em;font-weight:bold}@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}dt:target .name{background:var(--highlight-color)}.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,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.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%}td{padding:0 .5em}.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%;height:100vh;overflow:auto;position:sticky;top:0}#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>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>TermTk.TTkCore.log</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#!/usr/bin/env python3
# MIT License
#
# Copyright (c) 2021 Eugenio Parodi &lt;ceccopierangiolieugenio AT googlemail DOT com&gt;
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the &#34;Software&#34;), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED &#34;AS IS&#34;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# This code is inspired by
# https://github.com/ceccopierangiolieugenio/pyCuT/blob/master/cupy/CuTCore/CuDebug.py
import inspect
import logging
from collections.abc import Callable, Set
class _TTkContext:
__slots__ = [&#39;file&#39;, &#39;line&#39;, &#39;function&#39;]
def __init__(self, cf):
self.file = cf[1]
self.line = cf[2]
self.function = cf[3]
def __str__(self):
return f&#34;{self.file}:{self.line} [{self.function}]&#34;
class TTkLog:
DebugMsg = 0x0001
InfoMsg = 0x0002
ErrorMsg = 0x0004
WarningMsg = 0x0008
CriticalMsg = 0x0010
FatalMsg = 0x0020
SystemMsg = CriticalMsg
# TypeHandlers = list[Callable]
_messageHandler: Set = []
@staticmethod
def _logging_message_handler(mode, context, message):
log = logging.debug
if mode == TTkLog.InfoMsg: log = logging.info
elif mode == TTkLog.WarningMsg: log = logging.warning
elif mode == TTkLog.CriticalMsg: log = logging.critical
elif mode == TTkLog.FatalMsg: log = logging.fatal
elif mode == TTkLog.ErrorMsg: log = logging.error
log(f&#34;{context.file}:{context.line} {message}&#34;)
@staticmethod
def use_default_file_logging():
logging.basicConfig(level=logging.DEBUG,
filename=&#39;session.log&#39;,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)
@staticmethod
def use_default_stdout_logging():
logging.basicConfig(level=logging.DEBUG,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)
@staticmethod
def _process_msg(mode: int, msg: str):
for cb in TTkLog._messageHandler:
curframe = inspect.currentframe()
calframe = inspect.getouterframes(curframe,1)
if len(calframe) &gt; 2:
ctx = _TTkContext(calframe[2])
cb(mode, ctx, msg)
@staticmethod
def debug(msg):
TTkLog._process_msg(TTkLog.DebugMsg, msg)
@staticmethod
def info(msg):
TTkLog._process_msg(TTkLog.InfoMsg, msg)
@staticmethod
def error(msg):
TTkLog._process_msg(TTkLog.ErrorMsg, msg)
@staticmethod
def warn(msg):
TTkLog._process_msg(TTkLog.WarningMsg, msg)
@staticmethod
def critical(msg):
TTkLog._process_msg(TTkLog.CriticalMsg, msg)
@staticmethod
def fatal(msg):
TTkLog._process_msg(TTkLog.FatalMsg, msg)
@staticmethod
def installMessageHandler(mh: Callable):
TTkLog._messageHandler.append(mh)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="TermTk.TTkCore.log.TTkLog"><code class="flex name class">
<span>class <span class="ident">TTkLog</span></span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TTkLog:
DebugMsg = 0x0001
InfoMsg = 0x0002
ErrorMsg = 0x0004
WarningMsg = 0x0008
CriticalMsg = 0x0010
FatalMsg = 0x0020
SystemMsg = CriticalMsg
# TypeHandlers = list[Callable]
_messageHandler: Set = []
@staticmethod
def _logging_message_handler(mode, context, message):
log = logging.debug
if mode == TTkLog.InfoMsg: log = logging.info
elif mode == TTkLog.WarningMsg: log = logging.warning
elif mode == TTkLog.CriticalMsg: log = logging.critical
elif mode == TTkLog.FatalMsg: log = logging.fatal
elif mode == TTkLog.ErrorMsg: log = logging.error
log(f&#34;{context.file}:{context.line} {message}&#34;)
@staticmethod
def use_default_file_logging():
logging.basicConfig(level=logging.DEBUG,
filename=&#39;session.log&#39;,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)
@staticmethod
def use_default_stdout_logging():
logging.basicConfig(level=logging.DEBUG,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)
@staticmethod
def _process_msg(mode: int, msg: str):
for cb in TTkLog._messageHandler:
curframe = inspect.currentframe()
calframe = inspect.getouterframes(curframe,1)
if len(calframe) &gt; 2:
ctx = _TTkContext(calframe[2])
cb(mode, ctx, msg)
@staticmethod
def debug(msg):
TTkLog._process_msg(TTkLog.DebugMsg, msg)
@staticmethod
def info(msg):
TTkLog._process_msg(TTkLog.InfoMsg, msg)
@staticmethod
def error(msg):
TTkLog._process_msg(TTkLog.ErrorMsg, msg)
@staticmethod
def warn(msg):
TTkLog._process_msg(TTkLog.WarningMsg, msg)
@staticmethod
def critical(msg):
TTkLog._process_msg(TTkLog.CriticalMsg, msg)
@staticmethod
def fatal(msg):
TTkLog._process_msg(TTkLog.FatalMsg, msg)
@staticmethod
def installMessageHandler(mh: Callable):
TTkLog._messageHandler.append(mh)</code></pre>
</details>
<h3>Class variables</h3>
<dl>
<dt id="TermTk.TTkCore.log.TTkLog.CriticalMsg"><code class="name">var <span class="ident">CriticalMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.DebugMsg"><code class="name">var <span class="ident">DebugMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.ErrorMsg"><code class="name">var <span class="ident">ErrorMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.FatalMsg"><code class="name">var <span class="ident">FatalMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.InfoMsg"><code class="name">var <span class="ident">InfoMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.SystemMsg"><code class="name">var <span class="ident">SystemMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.WarningMsg"><code class="name">var <span class="ident">WarningMsg</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Static methods</h3>
<dl>
<dt id="TermTk.TTkCore.log.TTkLog.critical"><code class="name flex">
<span>def <span class="ident">critical</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def critical(msg):
TTkLog._process_msg(TTkLog.CriticalMsg, msg)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.debug"><code class="name flex">
<span>def <span class="ident">debug</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def debug(msg):
TTkLog._process_msg(TTkLog.DebugMsg, msg)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.error"><code class="name flex">
<span>def <span class="ident">error</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def error(msg):
TTkLog._process_msg(TTkLog.ErrorMsg, msg)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.fatal"><code class="name flex">
<span>def <span class="ident">fatal</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def fatal(msg):
TTkLog._process_msg(TTkLog.FatalMsg, msg)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.info"><code class="name flex">
<span>def <span class="ident">info</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def info(msg):
TTkLog._process_msg(TTkLog.InfoMsg, msg)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.installMessageHandler"><code class="name flex">
<span>def <span class="ident">installMessageHandler</span></span>(<span>mh: collections.abc.Callable)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def installMessageHandler(mh: Callable):
TTkLog._messageHandler.append(mh)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.use_default_file_logging"><code class="name flex">
<span>def <span class="ident">use_default_file_logging</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def use_default_file_logging():
logging.basicConfig(level=logging.DEBUG,
filename=&#39;session.log&#39;,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.use_default_stdout_logging"><code class="name flex">
<span>def <span class="ident">use_default_stdout_logging</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def use_default_stdout_logging():
logging.basicConfig(level=logging.DEBUG,
format=&#39;%(levelname)s:(%(threadName)-9s) %(message)s&#39;,)
TTkLog.installMessageHandler(TTkLog._logging_message_handler)</code></pre>
</details>
</dd>
<dt id="TermTk.TTkCore.log.TTkLog.warn"><code class="name flex">
<span>def <span class="ident">warn</span></span>(<span>msg)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def warn(msg):
TTkLog._process_msg(TTkLog.WarningMsg, msg)</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</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="TermTk.TTkCore" href="index.html">TermTk.TTkCore</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="TermTk.TTkCore.log.TTkLog" href="#TermTk.TTkCore.log.TTkLog">TTkLog</a></code></h4>
<ul class="">
<li><code><a title="TermTk.TTkCore.log.TTkLog.CriticalMsg" href="#TermTk.TTkCore.log.TTkLog.CriticalMsg">CriticalMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.DebugMsg" href="#TermTk.TTkCore.log.TTkLog.DebugMsg">DebugMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.ErrorMsg" href="#TermTk.TTkCore.log.TTkLog.ErrorMsg">ErrorMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.FatalMsg" href="#TermTk.TTkCore.log.TTkLog.FatalMsg">FatalMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.InfoMsg" href="#TermTk.TTkCore.log.TTkLog.InfoMsg">InfoMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.SystemMsg" href="#TermTk.TTkCore.log.TTkLog.SystemMsg">SystemMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.WarningMsg" href="#TermTk.TTkCore.log.TTkLog.WarningMsg">WarningMsg</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.critical" href="#TermTk.TTkCore.log.TTkLog.critical">critical</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.debug" href="#TermTk.TTkCore.log.TTkLog.debug">debug</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.error" href="#TermTk.TTkCore.log.TTkLog.error">error</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.fatal" href="#TermTk.TTkCore.log.TTkLog.fatal">fatal</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.info" href="#TermTk.TTkCore.log.TTkLog.info">info</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.installMessageHandler" href="#TermTk.TTkCore.log.TTkLog.installMessageHandler">installMessageHandler</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.use_default_file_logging" href="#TermTk.TTkCore.log.TTkLog.use_default_file_logging">use_default_file_logging</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.use_default_stdout_logging" href="#TermTk.TTkCore.log.TTkLog.use_default_stdout_logging">use_default_stdout_logging</a></code></li>
<li><code><a title="TermTk.TTkCore.log.TTkLog.warn" href="#TermTk.TTkCore.log.TTkLog.warn">warn</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>