From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 7B25BC433F5 for ; Tue, 15 Feb 2022 22:22:26 +0000 (UTC) Received: from localhost ([::1]:42560 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nK6DJ-0001Gz-IY for qemu-devel@archiver.kernel.org; Tue, 15 Feb 2022 17:22:25 -0500 Received: from eggs.gnu.org ([209.51.188.92]:45916) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nK60T-0003zk-2a for qemu-devel@nongnu.org; Tue, 15 Feb 2022 17:09:09 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:31645) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nK60O-0006Kr-6v for qemu-devel@nongnu.org; Tue, 15 Feb 2022 17:09:08 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1644962943; 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=0Est3gT7fKJzLxS65tT1wupOiKJEw+eV9Ot8heZ+DqM=; b=My1jqfjzY2HWLBqku+br0qzYJhd8H+hCMHm76fYsGbUTfYP5txRUgxdEJqo+4uGWt/GFGm evyRZa7oYh2bBYf1NctdRTWmcY3qHH8p9OdiE2RoWpBqAKp2DyfFVSteWYQNWl8NmYePWv HLiBHvi/IHpBRRH1V8QIpfoLHF3/IHM= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-13-9ZxjYUUWNdeoHtPhcckQcw-1; Tue, 15 Feb 2022 17:08:59 -0500 X-MC-Unique: 9ZxjYUUWNdeoHtPhcckQcw-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id B30081091DA0; Tue, 15 Feb 2022 22:08:58 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.16.166]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9EBB51059A77; Tue, 15 Feb 2022 22:08:57 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH 1/4] python/utils: add enboxify() text decoration utility Date: Tue, 15 Feb 2022 17:08:50 -0500 Message-Id: <20220215220853.4179173-2-jsnow@redhat.com> In-Reply-To: <20220215220853.4179173-1-jsnow@redhat.com> References: <20220215220853.4179173-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 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-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -28 X-Spam_score: -2.9 X-Spam_bar: -- X-Spam_report: (-2.9 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.083, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Eduardo Habkost , Kevin Wolf , Thomas Huth , Beraldo Leal , qemu-block@nongnu.org, Hanna Reitz , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" >>> print(enboxify(msg, width=72, name="commit message")) ┏━ commit message ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ enboxify() takes a chunk of text and wraps it in a text art box that ┃ ┃ adheres to a specified width. An optional title label may be given, ┃ ┃ and any of the individual glyphs used to draw the box may be ┃ ┃ replaced or specified as well. ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ Signed-off-by: John Snow --- python/qemu/utils/__init__.py | 58 +++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/python/qemu/utils/__init__.py b/python/qemu/utils/__init__.py index 7f1a5138c4b..f785316f230 100644 --- a/python/qemu/utils/__init__.py +++ b/python/qemu/utils/__init__.py @@ -15,7 +15,10 @@ # the COPYING file in the top-level directory. # +import os import re +import shutil +import textwrap from typing import Optional # pylint: disable=import-error @@ -23,6 +26,7 @@ __all__ = ( + 'enboxify', 'get_info_usernet_hostfwd_port', 'kvm_available', 'list_accel', @@ -43,3 +47,57 @@ def get_info_usernet_hostfwd_port(info_usernet_output: str) -> Optional[int]: if match is not None: return int(match[1]) return None + + +# pylint: disable=too-many-arguments +def enboxify( + content: str = '', + width: Optional[int] = None, + name: Optional[str] = None, + padding: int = 1, + upper_left: str = '┏', + upper_right: str = '┓', + lower_left: str = '┗', + lower_right: str = '┛', + horizontal: str = '━', + vertical: str = '┃', +) -> str: + """ + Wrap some text into a text art box of a given width. + + :param content: The text to wrap into a box. + :param width: The number of columns (including the box itself). + :param name: A label to apply to the upper-left of the box. + :param padding: How many columns of padding to apply inside. + """ + if width is None: + width = shutil.get_terminal_size()[0] + prefix = vertical + (' ' * padding) + suffix = (' ' * padding) + vertical + lwidth = width - len(suffix) + + def _bar(name: Optional[str], top: bool = True) -> str: + ret = upper_left if top else lower_left + right = upper_right if top else lower_right + if name is not None: + ret += f"{horizontal} {name} " + + assert width is not None + filler_len = width - len(ret) - len(right) + ret += f"{horizontal * filler_len}{right}" + return ret + + def _wrap(line: str) -> str: + return os.linesep.join([ + wrapped_line.ljust(lwidth) + suffix + for wrapped_line in textwrap.wrap( + line, width=lwidth, initial_indent=prefix, + subsequent_indent=prefix, replace_whitespace=False, + drop_whitespace=False, break_on_hyphens=False) + ]) + + return os.linesep.join(( + _bar(name, top=True), + os.linesep.join(_wrap(line) for line in content.splitlines()), + _bar(None, top=False), + )) -- 2.34.1