From patchwork Mon Aug 23 16:29:34 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Niteesh G. S." X-Patchwork-Id: 12453159 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A09BEC4338F for ; Mon, 23 Aug 2021 16:33:19 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 4DBA961361 for ; Mon, 23 Aug 2021 16:33:19 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 4DBA961361 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:32900 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mICss-0002Qs-NR for qemu-devel@archiver.kernel.org; Mon, 23 Aug 2021 12:33:16 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46710) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mICqu-0000QI-Dt for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:12 -0400 Received: from mail-pf1-x42a.google.com ([2607:f8b0:4864:20::42a]:34378) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mICqs-00088l-RB for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:12 -0400 Received: by mail-pf1-x42a.google.com with SMTP id g14so15835668pfm.1 for ; Mon, 23 Aug 2021 09:31:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=h5KtKMWDDVs8IAOwL+94ObAhGladPMl23HCiYjqXkEo=; b=iXzK6m4PEyiHn9SLvit8uEGqdCBfedGRQeDC0dyE4c+hizO/8pHiyBUCggyD2COnFd knKUt91f8SvGcDf+Mp0pdexOYjfZ77JvhN+AehBF0oeDZxm2/hpALjz+EeftquKB9eq/ zYSJ5CEUFSnNJHQ4xKRl4LSdPhB/+8DFK8QttVEXA9rj/FVcn0MrUGumkI8OchnAdD18 6wU4EHMzm6/I5Nhz4cYDUExZ5UaeHuu7XjUExLlN4dpBgirLnhqhHhCmRgNHigBaKTcw Sk8kgBIzYqudqBnW4pnHoIBmfxmc7qhqyCHPZUMZnx2F+Hix4227Ar4r/7lyi4DzB0n8 ed0A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=h5KtKMWDDVs8IAOwL+94ObAhGladPMl23HCiYjqXkEo=; b=QqKE+mpzeaoVMfhqHqxHdwNrOQ7z6qkDKuwAOL10Le5owYhs/bSyRn2Kn+2ybC3iQj xvJYM/f0Vc7wPcZAL9svr/NwUjAQz3Scji1cF7rQEVFzWbVBRGdtoay4VwndagY40Dxx 9dNH6qyI4BFZHW2H7LREDSxC6nuKwfOuAoTMVyLsH15g5fRupTg96sOitRiCvkq/MWkB XFBj8Zmfkn+ND3NaL/mlfiLf4WxOu94GUWGZtOvZ3J3XCNCVYeWoAhnsVYfmwoC+tWIL VoT4201RbCxYRBOS70jp0vF4d2hvTOU2LFwedxe3gHzNBg4FGHJ34IJv10VChceKhNOq oxaQ== X-Gm-Message-State: AOAM531SL8//HC6FeI2XFpWfzj5OWeeEe6izrefx3t7/DgrdKDM8eJCo lNtQbpTialpQ3k4oqtkbjYZx19Jbhs8= X-Google-Smtp-Source: ABdhPJy7AkZIg5LPQwpnk78JF8OYc+D0+gF6SSSg9LAK8GR2MOlWaIrq2sAXPKKxQ1uT/12ESzdR4w== X-Received: by 2002:a62:fb13:0:b029:309:8d89:46b2 with SMTP id x19-20020a62fb130000b02903098d8946b2mr34327204pfm.67.1629736269242; Mon, 23 Aug 2021 09:31:09 -0700 (PDT) Received: from localhost.localdomain ([120.138.13.180]) by smtp.gmail.com with ESMTPSA id x19sm16371243pfa.104.2021.08.23.09.31.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Aug 2021 09:31:09 -0700 (PDT) From: G S Niteesh Babu To: qemu-devel@nongnu.org Subject: [PATCH v5 1/5] python: Add dependencies for AQMP TUI Date: Mon, 23 Aug 2021 21:59:34 +0530 Message-Id: <20210823162938.32757-2-niteesh.gs@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210823162938.32757-1-niteesh.gs@gmail.com> References: <20210823162938.32757-1-niteesh.gs@gmail.com> Received-SPF: pass client-ip=2607:f8b0:4864:20::42a; envelope-from=niteesh.gs@gmail.com; helo=mail-pf1-x42a.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: ehabkost@redhat.com, kchamart@redhat.com, jsnow@redhat.com, armbru@redhat.com, wainersm@redhat.com, G S Niteesh Babu , stefanha@redhat.com, crosa@redhat.com, eblake@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Added dependencies for the upcoming AQMP TUI under the optional 'tui' group. The same dependencies have also been added under the devel group since no work around has been found for optional groups to imply other optional groups. Signed-off-by: G S Niteesh Babu --- python/Pipfile.lock | 12 ++++++++++++ python/setup.cfg | 8 ++++++++ 2 files changed, 20 insertions(+) diff --git a/python/Pipfile.lock b/python/Pipfile.lock index 457f5c3fe8..da7a4ee164 100644 --- a/python/Pipfile.lock +++ b/python/Pipfile.lock @@ -289,6 +289,18 @@ "markers": "python_version < '3.8'", "version": "==3.10.0.0" }, + "urwid": { + "hashes": [ + "sha256:588bee9c1cb208d0906a9f73c613d2bd32c3ed3702012f51efe318a3f2127eae" + ], + "version": "==2.1.2" + }, + "urwid-readline": { + "hashes": [ + "sha256:018020cbc864bb5ed87be17dc26b069eae2755cb29f3a9c569aac3bded1efaf4" + ], + "version": "==0.13" + }, "virtualenv": { "hashes": [ "sha256:14fdf849f80dbb29a4eb6caa9875d476ee2a5cf76a5f5415fa2f1606010ab467", diff --git a/python/setup.cfg b/python/setup.cfg index 152c683f41..589a90be21 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -44,11 +44,18 @@ devel = mypy >= 0.770 pylint >= 2.8.0 tox >= 3.18.0 + urwid >= 2.1.2 + urwid-readline >= 0.13 # Provides qom-fuse functionality fuse = fusepy >= 2.0.4 +# AQMP TUI dependencies +tui = + urwid >= 2.1.2 + urwid-readline >= 0.13 + [options.entry_points] console_scripts = qom = qemu.qmp.qom:main @@ -132,5 +139,6 @@ allowlist_externals = make deps = .[devel] .[fuse] # Workaround to trigger tox venv rebuild + .[tui] # Workaround to trigger tox venv rebuild commands = make check From patchwork Mon Aug 23 16:29:35 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Niteesh G. S." X-Patchwork-Id: 12453169 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3EBBCC4338F for ; Mon, 23 Aug 2021 16:34:58 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id AE9156101C for ; Mon, 23 Aug 2021 16:34:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org AE9156101C Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:38584 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mICuW-0006GJ-Qm for qemu-devel@archiver.kernel.org; Mon, 23 Aug 2021 12:34:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46746) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mICr1-0000eI-Ci for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:19 -0400 Received: from mail-pg1-x531.google.com ([2607:f8b0:4864:20::531]:40621) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mICqx-0008C0-BF for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:19 -0400 Received: by mail-pg1-x531.google.com with SMTP id y23so17137643pgi.7 for ; Mon, 23 Aug 2021 09:31:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=oG8sKmCEXZolklrWmetdJ6x9uFegjPskjOEMUBbwn1M=; b=jgJwC//CvgvKE+xfy49ovH5GWjhASt/ae/ToZCJXu3/MYmJJJxADAJ4Waz45POBoXY dVHFX6wldYYHIHseZOBXiHVVySn7anoP6KRO3rvYgk8UQaB2IjRP4mSk9DLcHVqOTz6C LkWxzjuA8fzONRF9zDTYsygDXKYewYZC8NsE7RS1UYxWpYU31GXw45emXGk2hpVzmuzL tFIOXa+OO6QEuznyOVNHNdFpYDLDF0WW4FPE0qjjeS/X/UdIWPfvjc8HWEGPWzbRD1n5 uezdFmcOl4BsHfj7kSlTzF60R5b3grKP1yxZjBRbIiyYjbMv1tyjl/2x4pjxB934dv1u p2cw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=oG8sKmCEXZolklrWmetdJ6x9uFegjPskjOEMUBbwn1M=; b=aCCSfkpy61KTfY6NFyi/E/uC4efQ9ZOKWwf25DFCJloPJ8mk5e8QxcCr/zfaapLmqM stC7AwmnD9vuKq63KOZmajQ+TOSjFYjsxChZYMp9tl4WuK6+vPqQCwAXXEjdazhPnxjc +o02k9YWw+UVMDC+hmdZBO/ttcPZSQora+iIhq18liXI+SCtMnWV/eS1UxqhuUv782Bl 2iT11MY53XucFQqQs00MWUX7Bretex/yEwQEhF6P95tRdycucZuqx7MLJS4FQAR4kRuo g9jYzilmEj5SYeBb0NTlFkBsOKB0rE2VTk58JIBBhb2dQVth9Fyw7SCumi9TPmlIy4Zo 2V1Q== X-Gm-Message-State: AOAM533X2Q9jWlFQIuV4nXucLmxWI8I2n5/ojApHjrzprkTJz+u/hufC OhUfcAORuBs+nhNgzXxhoIZYrU0nsGY= X-Google-Smtp-Source: ABdhPJxCw0PgBeBO5ulWAd/6zL8yYhDAzUYRJW8QhoezveYX8Wbou/ypHd05uCss6782EUy9GkGMqg== X-Received: by 2002:a62:483:0:b0:3e2:8b7:8208 with SMTP id 125-20020a620483000000b003e208b78208mr34865048pfe.42.1629736273568; Mon, 23 Aug 2021 09:31:13 -0700 (PDT) Received: from localhost.localdomain ([120.138.13.180]) by smtp.gmail.com with ESMTPSA id x19sm16371243pfa.104.2021.08.23.09.31.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Aug 2021 09:31:13 -0700 (PDT) From: G S Niteesh Babu To: qemu-devel@nongnu.org Subject: [PATCH v5 2/5] python/aqmp-tui: Add AQMP TUI Date: Mon, 23 Aug 2021 21:59:35 +0530 Message-Id: <20210823162938.32757-3-niteesh.gs@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210823162938.32757-1-niteesh.gs@gmail.com> References: <20210823162938.32757-1-niteesh.gs@gmail.com> Received-SPF: pass client-ip=2607:f8b0:4864:20::531; envelope-from=niteesh.gs@gmail.com; helo=mail-pg1-x531.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: ehabkost@redhat.com, kchamart@redhat.com, jsnow@redhat.com, armbru@redhat.com, wainersm@redhat.com, G S Niteesh Babu , stefanha@redhat.com, crosa@redhat.com, eblake@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Added AQMP TUI. Implements the follwing basic features: 1) Command transmission/reception. 2) Shows events asynchronously. 3) Shows server status in the bottom status bar. 4) Automatic retries on disconnects and error conditions. Also added type annotations and necessary pylint/mypy configurations. Signed-off-by: G S Niteesh Babu --- python/qemu/aqmp/aqmp_tui.py | 637 +++++++++++++++++++++++++++++++++++ python/setup.cfg | 13 +- 2 files changed, 649 insertions(+), 1 deletion(-) create mode 100644 python/qemu/aqmp/aqmp_tui.py diff --git a/python/qemu/aqmp/aqmp_tui.py b/python/qemu/aqmp/aqmp_tui.py new file mode 100644 index 0000000000..d3180e38bf --- /dev/null +++ b/python/qemu/aqmp/aqmp_tui.py @@ -0,0 +1,637 @@ +# Copyright (c) 2021 +# +# Authors: +# Niteesh Babu G S +# +# This work is licensed under the terms of the GNU GPL, version 2 or +# later. See the COPYING file in the top-level directory. +""" +AQMP TUI + +AQMP TUI is an asynchronous interface built on top the of the AQMP library. +It is the successor of QMP-shell and is bought-in as a replacement for it. + +Example Usage: aqmp-tui +Full Usage: aqmp-tui --help +""" + +import argparse +import asyncio +import logging +from logging import Handler, LogRecord +import signal +from typing import ( + List, + Optional, + Tuple, + Type, + Union, + cast, +) + +import urwid +import urwid_readline + +from ..qmp import QEMUMonitorProtocol, QMPBadPortError +from .error import ProtocolError +from .message import DeserializationError, Message, UnexpectedTypeError +from .protocol import ConnectError, Runstate +from .qmp_client import ExecInterruptedError, QMPClient +from .util import create_task, pretty_traceback + + +# The name of the signal that is used to update the history list +UPDATE_MSG: str = 'UPDATE_MSG' + + +def format_json(msg: str) -> str: + """ + Formats given multi-line JSON message into a single-line message. + Converting into single line is more asthetically pleasing when looking + along with error messages. + + Eg: + Input: + [ 1, + true, + 3 ] + The above input is not a valid QMP message and produces the following error + "QMP message is not a JSON object." + When displaying this in TUI in multiline mode we get + + [ 1, + true, + 3 ]: QMP message is not a JSON object. + + whereas in singleline mode we get the following + + [1, true, 3]: QMP message is not a JSON object. + + The single line mode is more asthetically pleasing. + + :param msg: + The message to formatted into single line. + + :return: Formatted singleline message. + + NOTE: We cannot use the JSON module here because it is only capable of + format valid JSON messages. But here the goal is to also format invalid + JSON messages. + """ + msg = msg.replace('\n', '') + words = msg.split(' ') + words = [word for word in words if word != ''] + return ' '.join(words) + + +def has_tui_handler(logger: logging.Logger, + handler_type: Type[Handler]) -> bool: + """ + The Logger class has no interface to check if a certain type of handler is + installed or not. So we provide an interface to do so. + + :param logger: + Logger object + :param handler_type: + The type of the handler to be checked. + + :return: returns True if handler of type `handler_type` is installed else + False. + """ + handlers = logger.handlers + for handler in handlers: + if isinstance(handler, handler_type): + return True + return False + + +class App(QMPClient): + """ + Implements the AQMP TUI. + + Initializes the widgets and starts the urwid event loop. + """ + def __init__(self, address: Union[str, Tuple[str, int]], num_retries: int, + retry_delay: Optional[int]) -> None: + """ + Initializes the TUI. + + :param address: + Address of the server to connect to. + :param num_retries: + The number of times to retry before stopping to reconnect. + :param retry_delay: + The delay(sec) before each retry + """ + urwid.register_signal(type(self), UPDATE_MSG) + self.window = Window(self) + self.address = address + self.aloop: Optional[asyncio.AbstractEventLoop] = None + self.num_retries = num_retries + self.retry_delay = retry_delay if retry_delay else 2 + self.retry: bool = False + self.exiting: bool = False + super().__init__() + + def add_to_history(self, msg: str, level: Optional[str] = None) -> None: + """ + Appends the msg to the history list. + + :param msg: + The raw message to be appended in string type. + """ + urwid.emit_signal(self, UPDATE_MSG, msg, level) + + def _cb_outbound(self, msg: Message) -> Message: + """ + Callback: outbound message hook. + + Appends the outgoing messages to the history box. + + :param msg: raw outbound message. + :return: final outbound message. + """ + str_msg = str(msg) + + if not has_tui_handler(logging.getLogger(), TUILogHandler): + logging.debug('Request: %s', str_msg) + self.add_to_history('<-- ' + str_msg) + return msg + + def _cb_inbound(self, msg: Message) -> Message: + """ + Callback: outbound message hook. + + Appends the incoming messages to the history box. + + :param msg: raw inbound message. + :return: final inbound message. + """ + str_msg = str(msg) + + if not has_tui_handler(logging.getLogger(), TUILogHandler): + logging.debug('Request: %s', str_msg) + self.add_to_history('--> ' + str_msg) + return msg + + async def _send_to_server(self, msg: Message) -> None: + """ + This coroutine sends the message to the server. + The message has to be pre-validated. + + :param msg: + Pre-validated message to be to sent to the server. + + :raise Exception: When an unhandled exception is caught. + """ + try: + await self._raw(msg, assign_id='id' not in msg) + except ExecInterruptedError as err: + logging.info('Error server disconnected before reply %s', str(err)) + self.add_to_history('Server disconnected before reply', 'ERROR') + await self.disconnect() + except Exception as err: + logging.error('Exception from _send_to_server: %s', str(err)) + raise err + + def cb_send_to_server(self, raw_msg: str) -> None: + """ + Validates and sends the message to the server. + The raw string message is first converted into a Message object + and is then sent to the server. + + :param raw_msg: + The raw string message to be sent to the server. + + :raise Exception: When an unhandled exception is caught. + """ + try: + raw_msg = format_json(raw_msg) + msg = Message(bytes(raw_msg, encoding='utf-8')) + create_task(self._send_to_server(msg)) + except (ValueError, TypeError) as err: + logging.info('Invalid message: %s', str(err)) + self.add_to_history(f'{raw_msg}: {err}', 'ERROR') + except (DeserializationError, UnexpectedTypeError) as err: + logging.info('Invalid message: %s', err.error_message) + self.add_to_history(f'{raw_msg}: {err.error_message}', 'ERROR') + + def unhandled_input(self, key: str) -> None: + """ + Handle's keys which haven't been handled by the child widgets. + + :param key: + Unhandled key + """ + if key == 'esc': + self.kill_app() + + def kill_app(self) -> None: + """ + Initiates killing of app. A bridge between asynchronous and synchronous + code. + """ + create_task(self._kill_app()) + + async def _kill_app(self) -> None: + """ + This coroutine initiates the actual disconnect process and calls + urwid.ExitMainLoop() to kill the TUI. + + :raise Exception: When an unhandled exception is caught. + """ + self.exiting = True + await self.disconnect() + logging.debug('Disconnect finished. Exiting app') + raise urwid.ExitMainLoop() + + async def disconnect(self) -> None: + """ + Overrides the disconnect method to handle the errors locally. + """ + try: + await super().disconnect() + self.retry = False + except EOFError as err: + logging.info('disconnect: %s', str(err)) + self.retry = True + except ProtocolError as err: + logging.info('disconnect: %s', str(err)) + self.retry = False + except Exception as err: + logging.error('disconnect: Unhandled exception %s', str(err)) + self.retry = False + raise err + + def _set_status(self, msg: str) -> None: + """ + Sets the message as the status. + + :param msg: + The message to be displayed in the status bar. + """ + self.window.footer.set_text(msg) + + def _get_formatted_address(self) -> str: + """ + Returns a formatted version of the server's address. + + :return: formatted address + """ + if isinstance(self.address, tuple): + host, port = self.address + addr = f'{host}:{port}' + else: + addr = f'{self.address}' + return addr + + async def _initiate_connection(self) -> Optional[ConnectError]: + """ + Tries connecting to a server a number of times with a delay between + each try. If all retries failed then return the error faced during + the last retry. + + :return: Error faced during last retry. + """ + current_retries = 0 + err = None + + # initial try + await self.connect_server() + while self.retry and current_retries < self.num_retries: + logging.info('Connection Failed, retrying in %d', self.retry_delay) + status = f'[Retry #{current_retries} ({self.retry_delay}s)]' + self._set_status(status) + + await asyncio.sleep(self.retry_delay) + + err = await self.connect_server() + current_retries += 1 + # If all retries failed report the last error + if err: + logging.info('All retries failed: %s', err) + return err + return None + + async def manage_connection(self) -> None: + """ + Manage the connection based on the current run state. + + A reconnect is issued when the current state is IDLE and the number + of retries is not exhausted. + A disconnect is issued when the current state is DISCONNECTING. + """ + while not self.exiting: + if self.runstate == Runstate.IDLE: + err = await self._initiate_connection() + # If retry is still true then, we have exhausted all our tries. + if err: + self._set_status(f'[Error: {err.error_message}]') + else: + addr = self._get_formatted_address() + self._set_status(f'[Connected {addr}]') + elif self.runstate == Runstate.DISCONNECTING: + self._set_status('[Disconnected]') + await self.disconnect() + # check if a retry is needed + if self.runstate == Runstate.IDLE: + continue + await self.runstate_changed() + + async def connect_server(self) -> Optional[ConnectError]: + """ + Initiates a connection to the server at address `self.address` + and in case of a failure, sets the status to the respective error. + """ + try: + await self.connect(self.address) + self.retry = False + except ConnectError as err: + logging.info('connect_server: ConnectError %s', str(err)) + self.retry = True + return err + return None + + def run(self, debug: bool = False) -> None: + """ + Starts the long running co-routines and the urwid event loop. + + :param debug: + Enables/Disables asyncio event loop debugging + """ + self.aloop = asyncio.get_event_loop() + self.aloop.set_debug(debug) + + # Gracefully handle SIGTERM and SIGINT signals + cancel_signals = [signal.SIGTERM, signal.SIGINT] + for sig in cancel_signals: + self.aloop.add_signal_handler(sig, self.kill_app) + + event_loop = urwid.AsyncioEventLoop(loop=self.aloop) + main_loop = urwid.MainLoop(urwid.AttrMap(self.window, 'background'), + unhandled_input=self.unhandled_input, + handle_mouse=True, + event_loop=event_loop) + + create_task(self.manage_connection(), self.aloop) + try: + main_loop.run() + except Exception as err: + logging.error('%s\n%s\n', str(err), pretty_traceback()) + raise err + + +class StatusBar(urwid.Text): + """ + A simple statusbar modelled using the Text widget. The status can be + set using the set_text function. All text set is aligned to right. + """ + def __init__(self, text: str = ''): + super().__init__(text, align='right') + + +class Editor(urwid_readline.ReadlineEdit): + """ + A simple editor modelled using the urwid_readline.ReadlineEdit widget. + Mimcs GNU readline shortcuts and provides history support. + + The readline shortcuts can be found below: + https://github.com/rr-/urwid_readline#features + + Along with the readline features, this editor also has support for + history. Pressing the 'up' arrow key with empty message box, lists the + previous message inplace. + + Currently there is no support to save the history to a file. The history of + previous commands is lost on exit. + """ + def __init__(self, parent: App) -> None: + """ + Initializes the editor widget + + :param parent: Reference to the TUI object. + """ + super().__init__(caption='> ', multiline=True) + self.parent = parent + self.history: List[str] = [] + self.last_index: int = 0 + self.show_history: bool = False + + def keypress(self, size: Tuple[int, int], key: str) -> Optional[str]: + """ + Handles the keypress on this widget. + + :param size: + The current size of the widget. + :param key: + The key to be handled. + + :return: Unhandled key if any. + """ + msg = self.get_edit_text() + if key == 'up' and not msg: + # Show the history when 'up arrow' is pressed with no input text. + # NOTE: The show_history logic is necessary because in 'multiline' + # mode (which we use) 'up arrow' is used to move between lines. + if not self.history: + return None + self.show_history = True + last_msg = self.history[self.last_index] + self.set_edit_text(last_msg) + self.edit_pos = len(last_msg) + elif key == 'up' and self.show_history: + self.last_index = min(self.last_index + 1, len(self.history) - 1) + self.set_edit_text(self.history[self.last_index]) + self.edit_pos = len(self.history[self.last_index]) + elif key == 'down' and self.show_history: + if self.last_index == 0: + self.set_edit_text('') + self.show_history = False + else: + self.last_index -= 1 + self.set_edit_text(self.history[self.last_index]) + self.edit_pos = len(self.history[self.last_index]) + elif key == 'meta enter': + # When using multiline, enter inserts a new line into the editor + # send the input to the server on alt + enter + self.parent.cb_send_to_server(msg) + self.history.insert(0, msg) + self.set_edit_text('') + self.last_index = 0 + self.show_history = False + else: + self.show_history = False + self.last_index = 0 + return cast(Optional[str], super().keypress(size, key)) + return None + + +class EditorWidget(urwid.Filler): + """ + The Editor is a flow widget and has to wrapped inside a box widget. + This class wraps the Editor inside filler widget. + """ + def __init__(self, parent: App) -> None: + super().__init__(Editor(parent), valign='top') + + +class HistoryBox(urwid.ListBox): + """ + This widget is modelled using the ListBox widget, contains the list of + all messages both QMP messages and log messsages to be shown in the TUI. + + The messages are urwid.Text widgets. On every append of a message, the + focus is shifted to the last appended message. + """ + def __init__(self, parent: App) -> None: + """ + Initializes the historybox widget + + :param parent: Reference to the TUI object. + """ + self.parent = parent + self.history = urwid.SimpleFocusListWalker([]) + super().__init__(self.history) + + def add_to_history(self, history: str) -> None: + """ + Appends a message to the list and set the focus to the last appended + message. + + :param history: + The history item(message/event) to be appended to the list. + """ + self.history.append(urwid.Text(history)) + if self.history: + self.history.set_focus(len(self.history) - 1) + + def mouse_event(self, size: Tuple[int, int], _event: str, button: float, + _x: int, _y: int, focus: bool) -> None: + # Unfortunately there are no urwid constants that represent the below + # events. + if button == 4: # Scroll up event + super().keypress(size, 'up') + elif button == 5: # Scroll down event + super().keypress(size, 'down') + + +class HistoryWindow(urwid.Frame): + """ + This window composes the HistoryBox and EditorWidget in a horizontal split. + By default the first focus is given to the history box. + """ + def __init__(self, parent: App) -> None: + """ + Initializes this widget and its child widgets. + + :param parent: Reference to the TUI object. + """ + self.parent = parent + self.editor_widget = EditorWidget(parent) + self.editor = urwid.LineBox(self.editor_widget) + self.history = HistoryBox(parent) + self.body = urwid.Pile([('weight', 80, self.history), + ('weight', 20, self.editor)]) + super().__init__(self.body) + urwid.connect_signal(self.parent, UPDATE_MSG, self.cb_add_to_history) + + def cb_add_to_history(self, msg: str, level: Optional[str] = None) -> None: + """ + Appends a message to the history box + + :param msg: + The message to be appended to the history box. + """ + if level: + msg = f'[{level}]: {msg}' + self.history.add_to_history(msg) + + +class Window(urwid.Frame): + """ + This window is the top most widget of the TUI and will contain other + windows. Each child of this widget is responsible for displaying a specific + functionality. + """ + def __init__(self, parent: App) -> None: + """ + Initializes this widget and its child windows. + + :param parent: Reference to the TUI object. + """ + self.parent = parent + footer = StatusBar() + body = HistoryWindow(parent) + super().__init__(body, footer=footer) + + +class TUILogHandler(Handler): + """ + This handler routes all the log messages to the TUI screen. + It is installed to the root logger to so that the log message from all + libraries begin used is routed to the screen. + """ + def __init__(self, tui: App) -> None: + """ + Initializes the handler class. + + :param tui: + Reference to the TUI object. + """ + super().__init__() + self.tui = tui + + def emit(self, record: LogRecord) -> None: + """ + Emits a record to the TUI screen. + + Appends the log message to the TUI screen + """ + level = record.levelname + msg = record.getMessage() + self.tui.add_to_history(msg, level) + + +def main() -> None: + """ + Driver of the whole script, parses arguments, initialize the TUI and + the logger. + """ + parser = argparse.ArgumentParser(description='AQMP TUI') + parser.add_argument('qmp_server', help='Address of the QMP server. ' + 'Format ') + parser.add_argument('--num-retries', type=int, default=10, + help='Number of times to reconnect before giving up.') + parser.add_argument('--retry-delay', type=int, + help='Time(s) to wait before next retry. ' + 'Default action is to wait 2s between each retry.') + parser.add_argument('--log-file', help='The Log file name') + parser.add_argument('--log-level', default='WARNING', + help='Log level ') + parser.add_argument('--asyncio-debug', action='store_true', + help='Enable debug mode for asyncio loop. ' + 'Generates lot of output, makes TUI unusable when ' + 'logs are logged in the TUI. ' + 'Use only when logging to a file.') + args = parser.parse_args() + + try: + address = QEMUMonitorProtocol.parse_address(args.qmp_server) + except QMPBadPortError as err: + parser.error(str(err)) + + app = App(address, args.num_retries, args.retry_delay) + + root_logger = logging.getLogger() + root_logger.setLevel(logging.getLevelName(args.log_level)) + + if args.log_file: + root_logger.addHandler(logging.FileHandler(args.log_file)) + else: + root_logger.addHandler(TUILogHandler(app)) + + app.run(args.asyncio_debug) + + +if __name__ == '__main__': + main() diff --git a/python/setup.cfg b/python/setup.cfg index 589a90be21..e9ceaea637 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -81,8 +81,19 @@ namespace_packages = True # fusepy has no type stubs: allow_subclassing_any = True +[mypy-qemu.aqmp.aqmp_tui] +# urwid and urwid_readline have no type stubs: +allow_subclassing_any = True + +# The following missing import directives are because these libraries do not +# provide type stubs. Allow them on an as-needed basis for mypy. [mypy-fuse] -# fusepy has no type stubs: +ignore_missing_imports = True + +[mypy-urwid] +ignore_missing_imports = True + +[mypy-urwid_readline] ignore_missing_imports = True [pylint.messages control] From patchwork Mon Aug 23 16:29:36 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Niteesh G. S." X-Patchwork-Id: 12453161 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C3158C4338F for ; Mon, 23 Aug 2021 16:33:35 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 86BBB61361 for ; Mon, 23 Aug 2021 16:33:35 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 86BBB61361 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:33540 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mICtC-0002qi-IR for qemu-devel@archiver.kernel.org; Mon, 23 Aug 2021 12:33:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46760) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mICr2-0000hX-Ls for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:20 -0400 Received: from mail-pj1-x102d.google.com ([2607:f8b0:4864:20::102d]:52021) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mICr0-0008Dx-UR for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:20 -0400 Received: by mail-pj1-x102d.google.com with SMTP id oa17so12343734pjb.1 for ; Mon, 23 Aug 2021 09:31:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=9YhbKwcUIZlKjGGWVi9LMyqnGm4JxOOty0zVYcxDAZE=; b=h2J3IlMyjH9ZkP2gtGlijdCb8ddrBoG4sVMzTr4Zwoj5Odz8UAOA6kJPLLqcY+y9T0 Gq2Qf/5R04P0l4nArWXfqnRRd2b5xMfHsx5ISkVjG/RfzkTYTToikdxOisFdJcPJ4NpK kCuWLRK+CcYK6Q8EuE6/x+Bdg3qqJz1TKiiJtaABXSVL4pkV2y/Xoem2myVwEW8ZjJG4 lBvnGenhn6DEjnVb5ZBXIGmr2NuenLdfgsayl0iN+MYz8KUQHUk0IpF4sDzOps661V8S +I1e/KSCa6yEzHSG0ZuqcgNUYIUdT98GLL+X4M9RohvyVgomL/Zz7zgrdJxaFrj/jyox MJTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=9YhbKwcUIZlKjGGWVi9LMyqnGm4JxOOty0zVYcxDAZE=; b=O4zLAOKFFtE0/XTdW6cyQ950GnSM3OFYgpM+t+0aq6MSE+U3adtQpzeJMkiWwFznH6 Mhz2LWnZFr/ZCVu7ruV3rlkYssYM6krd0Wu7D72vzLONIoOZUUmNDIDvXYSJmS7/VJfA K6Yyh3GznWXp0witezBsTsxWBDJ10N/1W1RB49jOGo1sUbqJfsHzyPwERcdghy+eoNgO 27yJpkJ2xBfZthEqrLbSdbo/QZUEC6kBNLAbtcMiswjzXX5dVXLFvhWRrXfdKUfYB1IF BNvKX1QiC/GGhzquphaibjlvDDSFsVk91ysohoMMxHCt1o+gmA4nVerXIJTHXEj63t99 1xzw== X-Gm-Message-State: AOAM532JbAeXveEJI72HzSUS1PfWUfGY2YTwGqlmdmec8RHy2im/5cAL lzKyB2qhSzrXrESy0EqAqzOLPuWPzmQ= X-Google-Smtp-Source: ABdhPJwzAgf1/3PoEuE9eNqlN/8AvKLQBB+yrDkPfU+ZBjownPV5cyGou/NKLYXmTXgJEF6VPtn8Zg== X-Received: by 2002:a17:903:310a:b0:133:9bb6:98bd with SMTP id w10-20020a170903310a00b001339bb698bdmr7342299plc.19.1629736277424; Mon, 23 Aug 2021 09:31:17 -0700 (PDT) Received: from localhost.localdomain ([120.138.13.180]) by smtp.gmail.com with ESMTPSA id x19sm16371243pfa.104.2021.08.23.09.31.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Aug 2021 09:31:17 -0700 (PDT) From: G S Niteesh Babu To: qemu-devel@nongnu.org Subject: [PATCH v5 3/5] python: Add entry point for aqmp-tui Date: Mon, 23 Aug 2021 21:59:36 +0530 Message-Id: <20210823162938.32757-4-niteesh.gs@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210823162938.32757-1-niteesh.gs@gmail.com> References: <20210823162938.32757-1-niteesh.gs@gmail.com> Received-SPF: pass client-ip=2607:f8b0:4864:20::102d; envelope-from=niteesh.gs@gmail.com; helo=mail-pj1-x102d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: ehabkost@redhat.com, kchamart@redhat.com, jsnow@redhat.com, armbru@redhat.com, wainersm@redhat.com, G S Niteesh Babu , stefanha@redhat.com, crosa@redhat.com, eblake@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add an entry point for aqmp-tui. This will allow it to be run from the command line using "aqmp-tui localhost:1234" More options available in the TUI can be found using "aqmp-tui -h" Signed-off-by: G S Niteesh Babu --- python/setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/python/setup.cfg b/python/setup.cfg index e9ceaea637..0850c7a10f 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -66,6 +66,7 @@ console_scripts = qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse] qemu-ga-client = qemu.qmp.qemu_ga_client:main qmp-shell = qemu.qmp.qmp_shell:main + aqmp-tui = qemu.aqmp.aqmp_tui:main [tui] [flake8] extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's From patchwork Mon Aug 23 16:29:37 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Niteesh G. S." X-Patchwork-Id: 12453171 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 00F65C432BE for ; Mon, 23 Aug 2021 16:35:01 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B3E4861361 for ; Mon, 23 Aug 2021 16:35:00 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org B3E4861361 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:38856 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mICuZ-0006SU-VN for qemu-devel@archiver.kernel.org; Mon, 23 Aug 2021 12:35:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46772) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mICr6-0000sU-So for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:24 -0400 Received: from mail-pj1-x1032.google.com ([2607:f8b0:4864:20::1032]:55227) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mICr5-0008He-7Y for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:24 -0400 Received: by mail-pj1-x1032.google.com with SMTP id n5so12314157pjt.4 for ; Mon, 23 Aug 2021 09:31:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=e+vmUdU/giGsSkSIQo4m0qZs9uEO4d8YRre5I3lw2nc=; b=WHmXeDGd8ghdmSFkPpjE9IgjznWDk0bGKgzdllBM6cNnPnymq/E4A062EgQ+7HsJJH 4u4XX/0E43nNg2tSujso71i399EtZPszPk4YQcewq80WuRevc9FrTAwuf2fxqK0Mi0uo 67RuI4/gtJsjOA8zsBZJbMlZm2At0z0FhCTZmER4J7oJMpcfsIgQhzO8AE4WlYe8+D42 AXI40AIZf4tvnt09InUcYrl5aXtNAdiE2wF8n/FRVtspA/xFGNkC09BXhbmETkPBk4+l OcEvQYfReQUIHOONKlqN072C5ZFM1OJ3vyWF7ONLxk9/a2eBEeCobmoKwwRgIIb1Zhdt 67fw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=e+vmUdU/giGsSkSIQo4m0qZs9uEO4d8YRre5I3lw2nc=; b=U2YbZRkKi9cpReggTf+dsSNTbrIC0e9HMsqlmUvVrhxizd2RyfzsAPFPle1i+La6zO zbjVIt+VRrs4LNOpvN9yQMYwflji9BHfaya0n3U9TRuUrFib5lM9JkjSyCCGB+hfoXm7 6gq9u3w9f0GusRnSel22Y5lIZN846sG45GyqawU90Px+Yy45TRLKt7sb5XWolwUbjKvm 5hMSIC6CXRHIeK07JQJiavezR0CLaeRAQasdo4zGa9NRmRsCHGNf4HO90RkH0HPd8NSm qzHMG7U8azqqVANB1ViMUUV9AZbKNxovadmBcp15p1MeDUd4CeblI7XPSfDAHkAV9TK2 kNLA== X-Gm-Message-State: AOAM533z/0x3CwTT4g4CjZ+Zg938WE0Q28QHAjfYaHPBddtBAMor230t ZSjGuxm842yoIcpdEOngw93RsYWpmP8= X-Google-Smtp-Source: ABdhPJwvDstq4xqqKMo35m6MDbfAQ3+mwf6F4KAIfwvbFQLDBOj1I/F+0+1XuC/OHsC0jpZ9niHUQw== X-Received: by 2002:a17:902:7203:b0:133:ec6b:6c16 with SMTP id ba3-20020a170902720300b00133ec6b6c16mr6544368plb.67.1629736281724; Mon, 23 Aug 2021 09:31:21 -0700 (PDT) Received: from localhost.localdomain ([120.138.13.180]) by smtp.gmail.com with ESMTPSA id x19sm16371243pfa.104.2021.08.23.09.31.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Aug 2021 09:31:21 -0700 (PDT) From: G S Niteesh Babu To: qemu-devel@nongnu.org Subject: [PATCH v5 4/5] python: add optional pygments dependency Date: Mon, 23 Aug 2021 21:59:37 +0530 Message-Id: <20210823162938.32757-5-niteesh.gs@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210823162938.32757-1-niteesh.gs@gmail.com> References: <20210823162938.32757-1-niteesh.gs@gmail.com> Received-SPF: pass client-ip=2607:f8b0:4864:20::1032; envelope-from=niteesh.gs@gmail.com; helo=mail-pj1-x1032.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: ehabkost@redhat.com, kchamart@redhat.com, jsnow@redhat.com, armbru@redhat.com, wainersm@redhat.com, G S Niteesh Babu , stefanha@redhat.com, crosa@redhat.com, eblake@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Added pygments as optional dependency for AQMP TUI. This is required for the upcoming syntax highlighting feature in AQMP TUI. The dependency has also been added in the devel optional group. Added mypy 'ignore_missing_imports' for pygments since it does not have any type stubs. Signed-off-by: G S Niteesh Babu --- python/Pipfile.lock | 8 ++++++++ python/setup.cfg | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/python/Pipfile.lock b/python/Pipfile.lock index da7a4ee164..d2a7dbd88b 100644 --- a/python/Pipfile.lock +++ b/python/Pipfile.lock @@ -200,6 +200,14 @@ ], "version": "==2.0.0" }, + "pygments": { + "hashes": [ + "sha256:a18f47b506a429f6f4b9df81bb02beab9ca21d0a5fee38ed15aef65f0545519f", + "sha256:d66e804411278594d764fc69ec36ec13d9ae9147193a1740cd34d272ca383b8e" + ], + "markers": "python_version >= '3.5'", + "version": "==2.9.0" + }, "pylint": { "hashes": [ "sha256:082a6d461b54f90eea49ca90fff4ee8b6e45e8029e5dbd72f6107ef84f3779c0", diff --git a/python/setup.cfg b/python/setup.cfg index 0850c7a10f..435f86384a 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -46,6 +46,7 @@ devel = tox >= 3.18.0 urwid >= 2.1.2 urwid-readline >= 0.13 + Pygments >= 2.9.0 # Provides qom-fuse functionality fuse = @@ -55,6 +56,7 @@ fuse = tui = urwid >= 2.1.2 urwid-readline >= 0.13 + Pygments >= 2.9.0 [options.entry_points] console_scripts = @@ -97,6 +99,9 @@ ignore_missing_imports = True [mypy-urwid_readline] ignore_missing_imports = True +[mypy-pygments] +ignore_missing_imports = True + [pylint.messages control] # Disable the message, report, category or checker with the given id(s). You # can either give multiple identifiers separated by comma (,) or put this From patchwork Mon Aug 23 16:29:38 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Niteesh G. S." X-Patchwork-Id: 12453173 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E14F3C4338F for ; Mon, 23 Aug 2021 16:36:58 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 73E7060F21 for ; Mon, 23 Aug 2021 16:36:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 73E7060F21 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:43282 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mICwS-00019m-H0 for qemu-devel@archiver.kernel.org; Mon, 23 Aug 2021 12:36:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46794) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mICrA-000137-Vv for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:29 -0400 Received: from mail-pl1-x634.google.com ([2607:f8b0:4864:20::634]:38810) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mICr9-0008Nc-42 for qemu-devel@nongnu.org; Mon, 23 Aug 2021 12:31:28 -0400 Received: by mail-pl1-x634.google.com with SMTP id a5so10486256plh.5 for ; Mon, 23 Aug 2021 09:31:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=blFucbeqswjEJGA2DwljHA8w43+SFZPeBTr6pc869JU=; b=iFi5ApxHqbNCAE1zkuguQj7GTwvTZ4C5nuw4DFl9Q9oKFCWhtouvFJP3WJsGpoYW/a QZFg8N5AtzZJews6KoUG02wYHpoaTrBZE+5tF9FArXD6Nsq1Bc5/Kho93CqF1duiR4jM arr/3WcOWe8VHCzA/qWR1uM55DjHPTq/aEb125ez7C8KpQtLbJHd/1XCgFw3ohFeQvGB ivE0UNv7DG9O8IuVtkraHFq5p+cklZdYcfMYK9N6yEI0eAoB2eElfST2cz9gtHDIAesw ERxKR+jeNXeJhTKQ9vio109tLnQD/mSVkyZeCR+cfP5eUspum+sSIl9MIXMPAiV+yscg p8kw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=blFucbeqswjEJGA2DwljHA8w43+SFZPeBTr6pc869JU=; b=Er/QLZq4tPDTcGrcxV2iY2nVDxZEfusiVcfWbA0PTlqoui3oN0n57zQLjPCq1QvL6w kzsd6OkuF/p6ehi1rmmbePatit+/IIx+G4e4N/ecAO71Ln3DMD99mJcuFnadfqhGIUNx Ryayo7pnmekixWSd1H8Cbqw6VB49sru76AXeqJ+C/mOMtrUg5SZTJzlXv1mxClofDqn5 UFlbq2x4FSKba+C1/7Th4kySa9v2kzbvJHcU+Hnx8dyuuYM0CBRSX1p/J6q2JX8o2uPK fKCS7E/nBseRr1FEskKNtpUwyAW3MtsZxu4qRCFykam1pfU4wSC9bbSTumUcaNul0VkE 8XjQ== X-Gm-Message-State: AOAM530wMeT4duMyRvmL5VsePgX86FBwRoAwsydjF2YiDams5AFDhElv 5m345ocNTXPq6iV8q18SHbG29rPrchY= X-Google-Smtp-Source: ABdhPJwXKghFjp5OgwShXKw6bDFkcdqzCTJ7HCLxOZNrUmNxI6b+/h2OTI5Mzp8NPDfDc3gC6D0g1Q== X-Received: by 2002:a17:902:fe81:b0:133:851e:5923 with SMTP id x1-20020a170902fe8100b00133851e5923mr7591743plm.25.1629736285521; Mon, 23 Aug 2021 09:31:25 -0700 (PDT) Received: from localhost.localdomain ([120.138.13.180]) by smtp.gmail.com with ESMTPSA id x19sm16371243pfa.104.2021.08.23.09.31.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 23 Aug 2021 09:31:25 -0700 (PDT) From: G S Niteesh Babu To: qemu-devel@nongnu.org Subject: [PATCH v5 5/5] python/aqmp-tui: Add syntax highlighting Date: Mon, 23 Aug 2021 21:59:38 +0530 Message-Id: <20210823162938.32757-6-niteesh.gs@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210823162938.32757-1-niteesh.gs@gmail.com> References: <20210823162938.32757-1-niteesh.gs@gmail.com> Received-SPF: pass client-ip=2607:f8b0:4864:20::634; envelope-from=niteesh.gs@gmail.com; helo=mail-pl1-x634.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: ehabkost@redhat.com, kchamart@redhat.com, jsnow@redhat.com, armbru@redhat.com, wainersm@redhat.com, G S Niteesh Babu , stefanha@redhat.com, crosa@redhat.com, eblake@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add syntax highlighting for the incoming and outgoing QMP messages. This is achieved using the pygments module which was added in a previous commit. The current implementation is a really simple one which doesn't allow for any configuration. In future this has to be improved to allow for easier theme config using an external config of some sort. Signed-off-by: G S Niteesh Babu --- python/qemu/aqmp/aqmp_tui.py | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/python/qemu/aqmp/aqmp_tui.py b/python/qemu/aqmp/aqmp_tui.py index d3180e38bf..9b28eebb90 100644 --- a/python/qemu/aqmp/aqmp_tui.py +++ b/python/qemu/aqmp/aqmp_tui.py @@ -29,6 +29,8 @@ cast, ) +from pygments import lexers +from pygments import token as Token import urwid import urwid_readline @@ -44,6 +46,22 @@ UPDATE_MSG: str = 'UPDATE_MSG' +palette = [ + (Token.Punctuation, '', '', '', 'h15,bold', 'g7'), + (Token.Text, '', '', '', '', 'g7'), + (Token.Name.Tag, '', '', '', 'bold,#f88', 'g7'), + (Token.Literal.Number.Integer, '', '', '', '#fa0', 'g7'), + (Token.Literal.String.Double, '', '', '', '#6f6', 'g7'), + (Token.Keyword.Constant, '', '', '', '#6af', 'g7'), + ('DEBUG', '', '', '', '#ddf', 'g7'), + ('INFO', '', '', '', 'g100', 'g7'), + ('WARNING', '', '', '', '#ff6', 'g7'), + ('ERROR', '', '', '', '#a00', 'g7'), + ('CRITICAL', '', '', '', '#a00', 'g7'), + ('background', '', 'black', '', '', 'g7'), +] + + def format_json(msg: str) -> str: """ Formats given multi-line JSON message into a single-line message. @@ -359,6 +377,9 @@ def run(self, debug: bool = False) -> None: :param debug: Enables/Disables asyncio event loop debugging """ + screen = urwid.raw_display.Screen() + screen.set_terminal_properties(256) + self.aloop = asyncio.get_event_loop() self.aloop.set_debug(debug) @@ -370,6 +391,8 @@ def run(self, debug: bool = False) -> None: event_loop = urwid.AsyncioEventLoop(loop=self.aloop) main_loop = urwid.MainLoop(urwid.AttrMap(self.window, 'background'), unhandled_input=self.unhandled_input, + screen=screen, + palette=palette, handle_mouse=True, event_loop=event_loop) @@ -493,7 +516,8 @@ def __init__(self, parent: App) -> None: self.history = urwid.SimpleFocusListWalker([]) super().__init__(self.history) - def add_to_history(self, history: str) -> None: + def add_to_history(self, + history: Union[str, List[Tuple[str, str]]]) -> None: """ Appends a message to the list and set the focus to the last appended message. @@ -541,10 +565,18 @@ def cb_add_to_history(self, msg: str, level: Optional[str] = None) -> None: :param msg: The message to be appended to the history box. + :param level: + The log level of the message, if it is a log message. """ + formatted = [] if level: msg = f'[{level}]: {msg}' - self.history.add_to_history(msg) + formatted.append((level, msg)) + else: + lexer = lexers.JsonLexer() # pylint: disable=no-member + for token in lexer.get_tokens(msg): + formatted.append(token) + self.history.add_to_history(formatted) class Window(urwid.Frame):