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 X-Spam-Level: X-Spam-Status: No, score=-9.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 6A5D2C433E2 for ; Thu, 17 Sep 2020 08:26:59 +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 08BE620715 for ; Thu, 17 Sep 2020 08:26:59 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="SD2brI2r" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 08BE620715 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:45408 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kIpFp-0000tu-Nd for qemu-devel@archiver.kernel.org; Thu, 17 Sep 2020 04:26:58 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55426) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kIoxQ-0002NU-1r for qemu-devel@nongnu.org; Thu, 17 Sep 2020 04:07:56 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:37341) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kIoxN-0007Q0-Rf for qemu-devel@nongnu.org; Thu, 17 Sep 2020 04:07:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1600330073; 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: in-reply-to:in-reply-to:references:references; bh=J8dXbkOQGEdi/cOYHuu2VQPmJLlfoATPsJepYK9WgWs=; b=SD2brI2rCiOJrpFCF5YNkkeX9ZoIZJ5RbHQmaZJ56JChiLCjjZgR2lXhlTsHMS5ERIDaDW dPdsXtxH5l4spIfkYdt/DEg9LlIIDUNXq8z+leSzYwpsZe2tscSU5/9ARrbLak8ngz7vHd FLdpIpVQXT2nIJwISydaVenbPGHkDyE= 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-130-zIaUMGqcOLq83ISerJWznw-1; Thu, 17 Sep 2020 04:07:50 -0400 X-MC-Unique: zIaUMGqcOLq83ISerJWznw-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 967591019625; Thu, 17 Sep 2020 08:07:49 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-114-66.ams2.redhat.com [10.36.114.66]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 3D26119D6C; Thu, 17 Sep 2020 08:07:49 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id AF5C1113864A; Thu, 17 Sep 2020 10:07:47 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: [PATCH 09/37] qapi/common.py: Add indent manager References: <20200915224027.2529813-1-jsnow@redhat.com> <20200915224027.2529813-10-jsnow@redhat.com> <87k0wtiwlb.fsf@dusky.pond.sub.org> <37ea889c-746e-bea9-a719-6bee9e86f1a8@redhat.com> Date: Thu, 17 Sep 2020 10:07:47 +0200 In-Reply-To: <37ea889c-746e-bea9-a719-6bee9e86f1a8@redhat.com> (John Snow's message of "Wed, 16 Sep 2020 18:25:04 -0400") Message-ID: <87v9gcesh8.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Received-SPF: pass client-ip=63.128.21.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/16 20:51:18 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -50 X-Spam_score: -5.1 X-Spam_bar: ----- X-Spam_report: (-5.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.999, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=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: Peter Maydell , Alex =?utf-8?Q?Benn=C3=A9e?= , qemu-devel@nongnu.org, Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" John Snow writes: > On 9/16/20 11:13 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> Code style tools really dislike the use of global keywords, because it >>> generally involves re-binding the name at runtime which can have strange >>> effects depending on when and how that global name is referenced in >>> other modules. >>> >>> Make a little indent level manager instead. >>> >>> Signed-off-by: John Snow >>> --- >>> scripts/qapi/common.py | 50 +++++++++++++++++++++++++++++------------- >>> scripts/qapi/visit.py | 7 +++--- >>> 2 files changed, 38 insertions(+), 19 deletions(-) >>> >>> diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py >>> index 4fb265a8bf..87d87b95e5 100644 >>> --- a/scripts/qapi/common.py >>> +++ b/scripts/qapi/common.py >>> @@ -93,33 +93,53 @@ def c_name(name, protect=True): >>> pointer_suffix = ' *' + eatspace >>> >>> -def genindent(count): >>> - ret = '' >>> - for _ in range(count): >>> - ret += ' ' >>> - return ret >>> +class Indent: >> Since this class name will be used just once... Indentation or >> IndentationManager? >> > > Indentation is fine, if you'd like. IndentationManager makes me feel > ashamed for writing this patch, like I am punishing myself with Java. Hah! Point taken. >>> + """ >>> + Indent-level management. >>> + :param initial: Initial value, default 0. >> The only caller passes 0. >> Let's drop the parameter, and hardcode the default initial value >> until >> we have an actual use for another initial value. >> > > The parameter is nice because it gives meaning to the output of > repr(), see below. > >>> + """ >>> + def __init__(self, initial: int = 0) -> None: >>> + self._level = initial >>> -indent_level = 0 >>> + def __int__(self) -> int: >>> + """Return the indent as an integer.""" >> Isn't "as an integer" obvious? > > Just a compulsion to write complete sentences that got lost in the sea > of many patches. I'll nix this one, because dunder methods do not need > to be documented. > >> Let's replace "the indent" by "the indentation" globally. >> > > They're both cromulent as nouns and one is shorter. > > I'll switch in good faith; do you prefer "Indentation" as a noun? Use of "indent" as a noun was new to me, but what do I know; you're the native speaker. Use your judgement. Applies to the class name, too. >>> + return self._level >>> + def __repr__(self) -> str: >>> + return "{}({:d})".format(type(self).__name__, self._level) >> Is __repr__ needed? >> > > Yes; it's used in the underflow exception , and it is nice when using > the python shell interactively. > > repr(Indent(4)) == "Indent(4)" Meh. There's another three dozen classes for you to put lipstick on :) >>> -def push_indent(indent_amount=4): >>> - global indent_level >>> - indent_level += indent_amount >>> + def __str__(self) -> str: >>> + """Return the indent as a string.""" >>> + return ' ' * self._level >>> + def __bool__(self) -> bool: >>> + """True when there is a non-zero indent.""" >>> + return bool(self._level) >> This one lets us shorten >> if int(INDENT): >> to >> if INDENT: >> There's just one instance. Marginal. I'm not rejecting it. >> > > Yep, it's trivial in either direction. Still, because it's a custom > type, I thought I'd be courteous and have it support bool(). > >>> -def pop_indent(indent_amount=4): >>> - global indent_level >>> - indent_level -= indent_amount >>> + def push(self, amount: int = 4) -> int: >>> + """Push `amount` spaces onto the indent, default four.""" >>> + self._level += amount >>> + return self._level >>> + >>> + def pop(self, amount: int = 4) -> int: >>> + """Pop `amount` spaces off of the indent, default four.""" >>> + if self._level < amount: >>> + raise ArithmeticError( >>> + "Can't pop {:d} spaces from {:s}".format(amount, repr(self))) I think assert(amount <= self._level) would do just fine. >>> + self._level -= amount >>> + return self._level >> The push / pop names never made sense. The functions don't push >> onto / >> pop from a stack, they increment / decrement a counter, and so do the >> methods. Good opportunity to fix the naming. >> > > OK. > > I briefly thought about using __isub__ and __iadd__ to support > e.g. indent += 4, but actually it'd be annoying to have to specify 4 > everywhere. > > Since you didn't suggest anything, I am going to change it to > 'increase' and 'decrease'. Works for me. So would inc and dec. >> The @amount parameter has never been used. I don't mind keeping it. >> > I'll keep it, because I like having the default amount show up in the > signature instead of as a magic constant in the function body. > >>> + >>> + >>> +INDENT = Indent(0) >> Uh, does this really qualify as a constant? It looks quite variable >> to >> me... >> > > Ever make a mistake? I thought I did once, but I was mistaken. "If I had any humility, I'd be perfect!"