8000 🚀 releasing version 1.1.0 @ 2020-03-18 09:33 · ARMmbed/mbed-tools-lib@172b032 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Jul 27, 2020. It is now read-only.

Commit 172b032

Browse files
monty-botmonty-bot
committed
🚀 releasing version 1.1.0 @ 2020-03-18 09:33
[skip ci]
1 parent 11b11ff commit 172b032

File tree

8 files changed

+35
-19
lines changed

8 files changed

+35
-19
lines changed

‎CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ beta releases are not included in this history. For a full list of all releases,
1212

1313
[//]: # (begin_release_notes)
1414

15+
"1.1.0" (2020-03-18)
16+
====================
17+
"" "1.1.0" (2020-03-18)
18+
=======================
19+
20+
Features
21+
--------
22+
23+
- Added a traceback parameter to log_exception (#20200318)
24+
25+
26+
Misc
27+
----
28+
29+
- #20200210, #202002102
30+
31+
1532
"1.0.0" (2020-02-06)
1633
====================
1734

‎docs/exceptions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.7.4" />
6+
<meta name="generator" content="pdoc 0.7.5" />
77
<title>mbed_tools_lib.exceptions API documentation</title>
88
<meta name="description" content="Exceptions raised by mbed tools." />
99
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
@@ -85,7 +85,7 @@ <h4><code><a title="mbed_tools_lib.exceptions.ToolsError" href="#mbed_tools_lib.
8585
</nav>
8686
</main>
8787
<footer id="footer">
88-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
88+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
8989
</footer>
9090
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
9191
<script>hljs.initHighlightingOnLoad()</script>

‎docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.7.4" />
6+
<meta name="generator" content="pdoc 0.7.5" />
77
<title>mbed_tools_lib API documentation</title>
88
<meta name="description" content="Exposes the primary interfaces for the library." />
99
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
@@ -66,7 +66,7 @@ <h1>Index</h1>
6666
</nav>
6767
</main>
6868
<footer id="footer">
69-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
69+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
7070
</footer>
7171
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
7272
<script>hljs.initHighlightingOnLoad()</script>

‎docs/logging.html

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.7.4" />
6+
<meta name="generator" content="pdoc 0.7.5" />
77
<title>mbed_tools_lib.logging API documentation</title>
88
<meta name="description" content="Helpers for logging errors according to severity of the exception." />
99
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
@@ -31,15 +31,15 @@ <h1 class="title">Module <code>mbed_tools_lib.logging</code></h1>
3131
LOGGING_FORMAT = &#34;%(levelname)s: %(message)s&#34;
3232

3333

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

3737
Args:
3838
logger: logger
3939
exception: exception to log
40+
show_traceback: show the full traceback.
4041
&#34;&#34;&#34;
41-
logger.error(exception)
42-
logger.debug(exception, exc_info=True)
42+
logger.error(exception, exc_info=show_traceback)
4343

4444

4545
def set_log_level(verbose_count: int) -&gt; None:
@@ -67,7 +67,7 @@ <h1 class="title">Module <code>mbed_tools_lib.logging</code></h1>
6767
<h2 class="section-title" id="header-functions">Functions</h2>
6868
<dl>
6969
<dt id="mbed_tools_lib.logging.log_exception"><code class="name flex">
70-
<span>def <span class="ident">log_exception</span></span>(<span>logger: logging.Logger, exception: Exception) -> NoneType</span>
70+
<span>def <span class="ident">log_exception</span></span>(<span>logger: logging.Logger, exception: Exception, show_traceback: bool = False) -> NoneType</span>
7171
</code></dt>
7272
<dd>
7373
<section class="desc"><p>Logs an exception in both normal and verbose forms.</p>
@@ -77,20 +77,22 @@ <h2 id="args">Args</h2>
7777
<dd>logger</dd>
7878
<dt><strong><code>exception</code></strong></dt>
7979
<dd>exception to log</dd>
80+
<dt><strong><code>show_traceback</code></strong></dt>
81+
<dd>show the full traceback.</dd>
8082
</dl></section>
8183
<details class="source">
8284
<summary>
8385
<span>Expand source code</span>
8486
</summary>
85-
<pre><code class="python">def log_exception(logger: logging.Logger, exception: Exception) -&gt; None:
87+
<pre><code class="python">def log_exception(logger: logging.Logger, exception: Exception, show_traceback: bool = False) -&gt; None:
8688
&#34;&#34;&#34;Logs an exception in both normal and verbose forms.
8789

8890
Args:
8991
logger: logger
9092
exception: exception to log
93+
show_traceback: show the full traceback.
9194
&#34;&#34;&#34;
92-
logger.error(exception)
93-
logger.debug(exception, exc_info=True)</code></pre>
95+
logger.error(exception, exc_info=show_traceback)</code></pre>
9496
</details>
9597
</dd>
9698
<dt id="mbed_tools_lib.logging.set_log_level"><code class="name flex">
@@ -150,7 +152,7 @@ <h1>Index</h1>
150152
</nav>
151153
</main>
152154
<footer id="footer">
153-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
155+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
154156
</footer>
155157
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
156158
<script>hljs.initHighlightingOnLoad()</script>

‎mbed_tools_lib/_version.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
77
This file is autogenerated, do not modify by hand.
88
"""
9-
__version__ = "1.0.0"
10-
COMMIT = "1fc21e61fcd91b0e5faab13b4004e2679a081a5d"
9+
__version__ = "1.1.0"
10+
COMMIT = "11b11ff24d682a4584da52d6f4b17bfc8061d8d9"
1111
MAJOR = 1
12-
MINOR = 0
12+
MINOR = 1
1313
PATCH = 0

‎news/20200210.misc

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎news/202002102.misc

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎news/20200318.feature

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)
You can’t perform that action at this time.
0