[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 07/17] python/aqmp: Disable logging messages by default
From: |
John Snow |
Subject: |
[PATCH v2 07/17] python/aqmp: Disable logging messages by default |
Date: |
Wed, 22 Sep 2021 20:49:28 -0400 |
AQMP is a library, and ideally it should not print error diagnostics
unless a user opts into seeing them. By default, Python will print all
WARNING, ERROR or CRITICAL messages to screen if no logging
configuration has been created by a client application.
In AQMP's case, ERROR logging statements are used to report additional
detail about runtime failures that will also eventually be reported to the
client library via an Exception, so these messages should not be
rendered by default.
(Why bother to have them at all, then? In async contexts, there may be
multiple Exceptions and we are only able to report one of them back to
the client application. It is not reasonably easy to predict ahead of
time if one or more of these Exceptions will be squelched. Therefore,
it's useful to log intermediate failures to help make sense of the
ultimate, resulting failure.)
Add a NullHandler that will suppress these messages until a client
application opts into logging via logging.basicConfig or similar. Note
that upon calling basicConfig(), this handler will *not* suppress these
messages from being displayed by the client's configuration.
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/__init__.py | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/aqmp/__init__.py
index ab1782999cf..d1b0e4dc3d3 100644
--- a/python/qemu/aqmp/__init__.py
+++ b/python/qemu/aqmp/__init__.py
@@ -21,6 +21,7 @@
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
+import logging
import warnings
from .error import AQMPError
@@ -41,6 +42,9 @@
warnings.warn(_WMSG, FutureWarning)
+# Suppress logging unless an application engages it.
+logging.getLogger('qemu.aqmp').addHandler(logging.NullHandler())
+
# The order of these fields impact the Sphinx documentation order.
__all__ = (
--
2.31.1
- [PATCH v2 00/17] Switch iotests to using Async QMP, John Snow, 2021/09/22
- [PATCH v2 01/17] python/aqmp: add greeting property to QMPClient, John Snow, 2021/09/22
- [PATCH v2 03/17] python/aqmp: Return cleared events from EventListener.clear(), John Snow, 2021/09/22
- [PATCH v2 02/17] python/aqmp: add .empty() method to EventListener, John Snow, 2021/09/22
- [PATCH v2 04/17] python/aqmp: add send_fd_scm, John Snow, 2021/09/22
- [PATCH v2 05/17] python/aqmp: Add dict conversion method to Greeting object, John Snow, 2021/09/22
- [PATCH v2 07/17] python/aqmp: Disable logging messages by default,
John Snow <=
- [PATCH v2 06/17] python/aqmp: Reduce severity of EOFError-caused loop terminations, John Snow, 2021/09/22
- [PATCH v2 08/17] python/qmp: clear events on get_events() call, John Snow, 2021/09/22
- [PATCH v2 09/17] python/qmp: add send_fd_scm directly to QEMUMonitorProtocol, John Snow, 2021/09/22
- [PATCH v2 10/17] python, iotests: remove socket_scm_helper, John Snow, 2021/09/22
- [PATCH v2 11/17] python/machine: remove has_quit argument, John Snow, 2021/09/22
- [PATCH v2 12/17] python/machine: Handle QMP errors on close more meticulously, John Snow, 2021/09/22
- [PATCH v2 15/17] python/aqmp: Create sync QMP wrapper for iotests, John Snow, 2021/09/22
- [PATCH v2 16/17] python/aqmp: Remove scary message, John Snow, 2021/09/22
- [PATCH v2 13/17] iotests: Accommodate async QMP Exception classes, John Snow, 2021/09/22
- [PATCH v2 14/17] iotests: Conditionally silence certain AQMP errors, John Snow, 2021/09/22