From nobody Mon Feb 9 23:00:57 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1626482239293166.0606449475996; Fri, 16 Jul 2021 17:37:19 -0700 (PDT) Received: from localhost ([::1]:44724 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m4YKU-0004ep-90 for importer@patchew.org; Fri, 16 Jul 2021 20:37:18 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:37518) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4YGa-0004ZM-Vg for qemu-devel@nongnu.org; Fri, 16 Jul 2021 20:33:16 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:56250) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4YGZ-0006Es-8C for qemu-devel@nongnu.org; Fri, 16 Jul 2021 20:33:16 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-117-zaWCbqjjMkWOfMTEHNCSPA-1; Fri, 16 Jul 2021 20:33:12 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A6E361084F57; Sat, 17 Jul 2021 00:33:11 +0000 (UTC) Received: from scv.redhat.com (ovpn-119-183.rdu2.redhat.com [10.10.119.183]) by smtp.corp.redhat.com (Postfix) with ESMTP id 887565C1A1; Sat, 17 Jul 2021 00:33:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1626481994; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=CPhrOSK3X9Dy7uo9xp1MEF9PSkyyDQ9qC7O9WewQ9hA=; b=JFVy2YOPBmX1LlVA0Cfc2VyAi9ovLV/hKU1tL9zSQMPJS+Bc3a7m4WSAHHSrQ3BdMZvFzG VKmil3HfusTEps3XcQDkh3+CTbSQ3JNhEsOTkQkaauz6Ki2OIk/ojkbSi9tr0ieCwxn2GI CLdoDQIyGzM6nOhH/XPB9JekhlKjQuw= X-MC-Unique: zaWCbqjjMkWOfMTEHNCSPA-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v2 07/24] python/aqmp: Add logging utility helpers Date: Fri, 16 Jul 2021 20:32:36 -0400 Message-Id: <20210717003253.457418-8-jsnow@redhat.com> In-Reply-To: <20210717003253.457418-1-jsnow@redhat.com> References: <20210717003253.457418-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -15 X-Spam_score: -1.6 X-Spam_bar: - X-Spam_report: (-1.6 / 5.0 requ) DKIMWL_WL_HIGH=-0.7, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Eduardo Habkost , Eric Blake , Stefan Hajnoczi , Markus Armbruster , Wainer dos Santos Moschetta , "Niteesh G . S ." , Willian Rampazzo , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1626482241219100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: John Snow --- 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 88abfc9eb22..70ef94ad600 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. """ =20 import asyncio import sys +import traceback from typing import ( Any, Coroutine, @@ -130,3 +135,54 @@ async def wait_closed(writer: asyncio.StreamWriter) ->= None: while not transport.is_closing(): await asyncio.sleep(0) await flush(writer) + + +# ---------------------------- +# 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 =3D type(exc).__qualname__ + smod =3D type(exc).__module__ + if smod not in ("__main__", "builtins"): + name =3D smod + '.' + name + + error =3D str(exc) + if error: + return f"{name}: {error}" + return name + + +def pretty_traceback(prefix: str =3D " | ") -> 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 =3D "".join(traceback.format_exception(*sys.exc_info())) + + exc_lines =3D [] + 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]) --=20 2.31.1