Sign upLogin

ARMmbed/mbed-tools-lib

View on GitHub
Star
docs/logging.html

Summary

Maintainability
Test Coverage
<!--
-- Copyright (C) 2020 Arm Mbed. All rights reserved.
-- SPDX-License-Identifier: Apache-2.0
-->
<!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.8.1" />
<title>mbed_tools_lib.logging API documentation</title>
<meta name="description" content="Helpers for logging errors according to severity of the exception." />
<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}#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%}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}.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%}.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>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>mbed_tools_lib.logging</code></h1>
</header>
<section id="section-intro">
<p>Helpers for logging errors according to severity of the exception.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020 Arm Mbed. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Helpers for logging errors according to severity of the exception.&#34;&#34;&#34;
from typing import Type, Optional, cast
from types import TracebackType
import logging
from mbed_tools_lib.exceptions import ToolsError

LOGGING_FORMAT = &#34;%(levelname)s: %(message)s&#34;

VERBOSITY_HELP = {
    logging.CRITICAL: &#34;-v&#34;,
    logging.ERROR: &#34;-v&#34;,
    logging.WARNING: &#34;-vv&#34;,
    logging.INFO: &#34;-vvv&#34;,
    logging.DEBUG: &#34;--traceback&#34;,
}


def _exception_message(err: BaseException, log_level: int, traceback: bool) -&gt; str:
    &#34;&#34;&#34;Generate a user facing message with help on how to get more information from the logs.&#34;&#34;&#34;
    error_msg = str(err)
    if log_level != logging.DEBUG or not traceback:
        cli_option = VERBOSITY_HELP.get(log_level, &#34;-v&#34;)
        error_msg += f&#34;\n\nMore information may be available by using the command line option &#39;{cli_option}&#39;.&#34;
    return error_msg


class MbedToolsHandler:
    &#34;&#34;&#34;Context Manager to catch Mbed Tools exceptions and generate a helpful user facing message.&#34;&#34;&#34;

    def __init__(self, logger: logging.Logger, traceback: bool = False):
        &#34;&#34;&#34;Keep track of the logger to use and whether or not a traceback should be generated.&#34;&#34;&#34;
        self._logger = logger
        self._traceback = traceback

    def __enter__(self) -&gt; &#34;MbedToolsHandler&#34;:
        &#34;&#34;&#34;Return the Context Manager.&#34;&#34;&#34;
        return self

    def __exit__(
        self,
        exc_type: Optional[Type[BaseException]],
        exc_value: Optional[BaseException],
        exc_traceback: Optional[TracebackType],
    ) -&gt; bool:
        &#34;&#34;&#34;Handle any raised exceptions, suppressing Tools errors and generating an error message instead.&#34;&#34;&#34;
        if exc_type and issubclass(exc_type, ToolsError):
            error_msg = _exception_message(cast(BaseException, exc_value), logging.root.level, self._traceback)
            self._logger.error(error_msg, exc_info=self._traceback)
            # Do not propagate exceptions derived from ToolsError
            return True

        # Propagate all other exceptions
        return False


def log_exception(logger: logging.Logger, exception: Exception, show_traceback: bool = False) -&gt; None:
    &#34;&#34;&#34;Logs an exception in both normal and verbose forms.

    Args:
        logger: logger
        exception: exception to log
        show_traceback: show the full traceback.
    &#34;&#34;&#34;
    logger.error(exception, exc_info=show_traceback)


def set_log_level(verbose_count: int) -&gt; None:
    &#34;&#34;&#34;Sets the log level.

    Args:
        verbose_count: number of `-v` flags used
    &#34;&#34;&#34;
    if verbose_count &gt; 2:
        log_level = logging.DEBUG
    elif verbose_count == 2:
        log_level = logging.INFO
    elif verbose_count == 1:
        log_level = logging.WARNING
    else:
        log_level = logging.ERROR
    logging.basicConfig(level=log_level, format=LOGGING_FORMAT)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="mbed_tools_lib.logging.log_exception"><code class="name flex">
<span>def <span class="ident">log_exception</span></span>(<span>logger: logging.Logger, exception: Exception, show_traceback: bool = False) -> NoneType</span>
</code></dt>
<dd>
<div class="desc"><p>Logs an exception in both normal and verbose forms.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>logger</code></strong></dt>
<dd>logger</dd>
<dt><strong><code>exception</code></strong></dt>
<dd>exception to log</dd>
<dt><strong><code>show_traceback</code></strong></dt>
<dd>show the full traceback.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def log_exception(logger: logging.Logger, exception: Exception, show_traceback: bool = False) -&gt; None:
    &#34;&#34;&#34;Logs an exception in both normal and verbose forms.

    Args:
        logger: logger
        exception: exception to log
        show_traceback: show the full traceback.
    &#34;&#34;&#34;
    logger.error(exception, exc_info=show_traceback)</code></pre>
</details>
</dd>
<dt id="mbed_tools_lib.logging.set_log_level"><code class="name flex">
<span>def <span class="ident">set_log_level</span></span>(<span>verbose_count: int) -> NoneType</span>
</code></dt>
<dd>
<div class="desc"><p>Sets the log level.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>verbose_count</code></strong></dt>
<dd>number of <code>-v</code> flags used</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_log_level(verbose_count: int) -&gt; None:
    &#34;&#34;&#34;Sets the log level.

    Args:
        verbose_count: number of `-v` flags used
    &#34;&#34;&#34;
    if verbose_count &gt; 2:
        log_level = logging.DEBUG
    elif verbose_count == 2:
        log_level = logging.INFO
    elif verbose_count == 1:
        log_level = logging.WARNING
    else:
        log_level = logging.ERROR
    logging.basicConfig(level=log_level, format=LOGGING_FORMAT)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="mbed_tools_lib.logging.MbedToolsHandler"><code class="flex name class">
<span>class <span class="ident">MbedToolsHandler</span></span>
<span>(</span><span>logger: logging.Logger, traceback: bool = False)</span>
</code></dt>
<dd>
<div class="desc"><p>Context Manager to catch Mbed Tools exceptions and generate a helpful user facing message.</p>
<p>Keep track of the logger to use and whether or not a traceback should be generated.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class MbedToolsHandler:
    &#34;&#34;&#34;Context Manager to catch Mbed Tools exceptions and generate a helpful user facing message.&#34;&#34;&#34;

    def __init__(self, logger: logging.Logger, traceback: bool = False):
        &#34;&#34;&#34;Keep track of the logger to use and whether or not a traceback should be generated.&#34;&#34;&#34;
        self._logger = logger
        self._traceback = traceback

    def __enter__(self) -&gt; &#34;MbedToolsHandler&#34;:
        &#34;&#34;&#34;Return the Context Manager.&#34;&#34;&#34;
        return self

    def __exit__(
        self,
        exc_type: Optional[Type[BaseException]],
        exc_value: Optional[BaseException],
        exc_traceback: Optional[TracebackType],
    ) -&gt; bool:
        &#34;&#34;&#34;Handle any raised exceptions, suppressing Tools errors and generating an error message instead.&#34;&#34;&#34;
        if exc_type and issubclass(exc_type, ToolsError):
            error_msg = _exception_message(cast(BaseException, exc_value), logging.root.level, self._traceback)
            self._logger.error(error_msg, exc_info=self._traceback)
            # Do not propagate exceptions derived from ToolsError
            return True

        # Propagate all other exceptions
        return False</code></pre>
</details>
</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="mbed_tools_lib" href="index.html">mbed_tools_lib</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="mbed_tools_lib.logging.log_exception" href="#mbed_tools_lib.logging.log_exception">log_exception</a></code></li>
<li><code><a title="mbed_tools_lib.logging.set_log_level" href="#mbed_tools_lib.logging.set_log_level">set_log_level</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="mbed_tools_lib.logging.MbedToolsHandler" href="#mbed_tools_lib.logging.MbedToolsHandler">MbedToolsHandler</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.1</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>