From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Peter Maydell" <peter.maydell@linaro.org>,
"Thomas Huth" <thuth@redhat.com>,
"Daniel Berrange" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Markus Armbruster" <armbru@redhat.com>,
"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
"Philippe Mathieu-Daudé" <f4bug@amsat.org>,
"Willian Rampazzo" <willianr@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>, "John Snow" <jsnow@redhat.com>,
"Eric Blake" <eblake@redhat.com>
Subject: [PULL 07/32] python/aqmp: Add logging utility helpers
Date: Mon, 27 Sep 2021 15:24:48 -0400 [thread overview]
Message-ID: <20210927192513.744199-8-jsnow@redhat.com> (raw)
In-Reply-To: <20210927192513.744199-1-jsnow@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 20210915162955.333025-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/util.py | 56 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 56 insertions(+)
diff --git a/python/qemu/aqmp/util.py b/python/qemu/aqmp/util.py
index 5b8f968969d..52a15321889 100644
--- a/python/qemu/aqmp/util.py
+++ b/python/qemu/aqmp/util.py
@@ -4,10 +4,15 @@
This module provides asyncio utilities and compatibility wrappers for
Python 3.6 to provide some features that otherwise become available in
Python 3.7+.
+
+Various logging and debugging utilities are also provided, such as
+`exception_summary()` and `pretty_traceback()`, used primarily for
+adding information into the logging stream.
"""
import asyncio
import sys
+import traceback
from typing import (
Any,
Coroutine,
@@ -140,3 +145,54 @@ async def wait_closed(writer: asyncio.StreamWriter) -> None:
while sock.fileno() != -1:
await asyncio.sleep(0)
+
+
+# ----------------------------
+# Section: Logging & Debugging
+# ----------------------------
+
+
+def exception_summary(exc: BaseException) -> str:
+ """
+ Return a summary string of an arbitrary exception.
+
+ It will be of the form "ExceptionType: Error Message", if the error
+ string is non-empty, and just "ExceptionType" otherwise.
+ """
+ name = type(exc).__qualname__
+ smod = type(exc).__module__
+ if smod not in ("__main__", "builtins"):
+ name = smod + '.' + name
+
+ error = str(exc)
+ if error:
+ return f"{name}: {error}"
+ return name
+
+
+def pretty_traceback(prefix: str = " | ") -> str:
+ """
+ Formats the current traceback, indented to provide visual distinction.
+
+ This is useful for printing a traceback within a traceback for
+ debugging purposes when encapsulating errors to deliver them up the
+ stack; when those errors are printed, this helps provide a nice
+ visual grouping to quickly identify the parts of the error that
+ belong to the inner exception.
+
+ :param prefix: The prefix to append to each line of the traceback.
+ :return: A string, formatted something like the following::
+
+ | Traceback (most recent call last):
+ | File "foobar.py", line 42, in arbitrary_example
+ | foo.baz()
+ | ArbitraryError: [Errno 42] Something bad happened!
+ """
+ output = "".join(traceback.format_exception(*sys.exc_info()))
+
+ exc_lines = []
+ for line in output.split('\n'):
+ exc_lines.append(prefix + line)
+
+ # The last line is always empty, omit it
+ return "\n".join(exc_lines[:-1])
--
2.31.1
next prev parent reply other threads:[~2021-09-27 19:38 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-27 19:24 [PULL 00/32] Python patches John Snow
2021-09-27 19:24 ` [PULL 01/32] python/aqmp: add asynchronous QMP (AQMP) subpackage John Snow
2021-09-27 19:24 ` [PULL 02/32] python/aqmp: add error classes John Snow
2021-09-27 19:24 ` [PULL 03/32] python/pylint: Add exception for TypeVar names ('T') John Snow
2021-09-27 19:24 ` [PULL 04/32] python/aqmp: add asyncio compatibility wrappers John Snow
2021-09-27 19:24 ` [PULL 05/32] python/aqmp: add generic async message-based protocol support John Snow
2021-09-27 19:24 ` [PULL 06/32] python/aqmp: add runstate state machine to AsyncProtocol John Snow
2021-09-27 19:24 ` John Snow [this message]
2021-09-27 19:24 ` [PULL 08/32] python/aqmp: add logging " John Snow
2021-09-27 19:24 ` [PULL 09/32] python/aqmp: add AsyncProtocol.accept() method John Snow
2021-09-27 19:24 ` [PULL 10/32] python/aqmp: add configurable read buffer limit John Snow
2021-09-27 19:24 ` [PULL 11/32] python/aqmp: add _cb_inbound and _cb_outbound logging hooks John Snow
2021-09-27 19:24 ` [PULL 12/32] python/aqmp: add AsyncProtocol._readline() method John Snow
2021-09-27 19:24 ` [PULL 13/32] python/aqmp: add QMP Message format John Snow
2021-09-27 19:24 ` [PULL 14/32] python/aqmp: add well-known QMP object models John Snow
2021-09-27 19:24 ` [PULL 15/32] python/aqmp: add QMP event support John Snow
2021-09-27 19:24 ` [PULL 16/32] python/pylint: disable too-many-function-args John Snow
2021-09-27 19:24 ` [PULL 17/32] python/aqmp: add QMP protocol support John Snow
2021-09-27 19:24 ` [PULL 18/32] python/pylint: disable no-member check John Snow
2021-09-27 19:25 ` [PULL 19/32] python/aqmp: Add message routing to QMP protocol John Snow
2021-09-27 19:25 ` [PULL 20/32] python/aqmp: add execute() interfaces John Snow
2021-09-27 19:25 ` [PULL 21/32] python/aqmp: add _raw() execution interface John Snow
2021-09-27 19:25 ` [PULL 22/32] python/aqmp: add asyncio_run compatibility wrapper John Snow
2021-09-27 19:25 ` [PULL 23/32] python/aqmp: add scary message John Snow
2021-09-27 19:25 ` [PULL 24/32] python: bump avocado to v90.0 John Snow
2021-09-27 19:25 ` [PULL 25/32] python/aqmp: add AsyncProtocol unit tests John Snow
2021-09-27 19:25 ` [PULL 26/32] python/aqmp: add LineProtocol tests John Snow
2021-09-27 19:25 ` [PULL 27/32] python/aqmp: Add Coverage.py support John Snow
2021-09-27 19:25 ` [PULL 28/32] python: Add dependencies for AQMP TUI John Snow
2021-09-27 19:25 ` [PULL 29/32] python/aqmp-tui: Add " John Snow
2021-09-27 19:25 ` [PULL 30/32] python: Add entry point for aqmp-tui John Snow
2021-09-27 19:25 ` [PULL 31/32] python: add optional pygments dependency John Snow
2021-09-27 19:25 ` [PULL 32/32] python/aqmp-tui: Add syntax highlighting John Snow
2021-09-28 14:37 ` [PULL 00/32] Python patches Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210927192513.744199-8-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=ehabkost@redhat.com \
--cc=f4bug@amsat.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
--cc=wainersm@redhat.com \
--cc=willianr@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).