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=-16.3 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_1 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 AA91BC4363D for ; Thu, 24 Sep 2020 20:13:03 +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 E459223899 for ; Thu, 24 Sep 2020 20:13:02 +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="awcdXy6H" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E459223899 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]:45010 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kLXbx-00005D-LM for qemu-devel@archiver.kernel.org; Thu, 24 Sep 2020 16:13:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58664) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kLXU6-0004Pj-Dn for qemu-devel@nongnu.org; Thu, 24 Sep 2020 16:04:54 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:56548) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kLXU4-0002pU-Ad for qemu-devel@nongnu.org; Thu, 24 Sep 2020 16:04:54 -0400 Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1600977891; 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=WBklpBnSLDJ11psorG8UH8oRTpPyGWqn6KutHJydULA=; b=awcdXy6Hr6YbO6a19cchn1PNb70ycXnfQ94oVN2pKMbHhgIBEEcXomJZ+GDg8CcrcWR8vV 28hM9wYivaboVGhcQ4l8VeadDO4jAKlp+UYRSa14uFlKvgnJjxjsP1ywi8zYAfG2R6da1S 5+H/hD+N0XyLqK2zNH3ZaL4BwZC8p00= 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-14-Pu2MUWnGNYaMiD80zl0SpA-1; Thu, 24 Sep 2020 16:04:47 -0400 X-MC-Unique: Pu2MUWnGNYaMiD80zl0SpA-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 45021801002; Thu, 24 Sep 2020 20:04:46 +0000 (UTC) Received: from [10.10.119.140] (ovpn-119-140.rdu2.redhat.com [10.10.119.140]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6676C5D9D2; Thu, 24 Sep 2020 20:04:45 +0000 (UTC) Subject: Re: [PATCH v2 05/38] qapi: Remove wildcard includes From: John Snow To: Cleber Rosa References: <20200922210101.4081073-1-jsnow@redhat.com> <20200922210101.4081073-6-jsnow@redhat.com> <20200923132735.GE191229@localhost.localdomain> Message-ID: <7c4fa58a-220c-c253-a98c-1eeeecf95d28@redhat.com> Date: Thu, 24 Sep 2020 16:04:44 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 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=WINDOWS-1252; format=flowed Content-Language: en-US Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=63.128.21.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/24 01:10:00 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.199, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.214, 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 , Eduardo Habkost , qemu-devel@nongnu.org, Michael Roth , Markus Armbruster , =?UTF-8?Q?Alex_Benn=c3=a9e?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 9/23/20 1:21 PM, John Snow wrote: > On 9/23/20 9:27 AM, Cleber Rosa wrote: >> On Tue, Sep 22, 2020 at 05:00:28PM -0400, John Snow wrote: >>> Wildcard includes become hard to manage when refactoring and dealing >>> with circular dependencies with strictly typed mypy. >>> >>> flake8 also flags each one as a warning, as it is not smart enough to >>> know which names exist in the imported file. >>> >>> Remove them and include things explicitly by name instead. >>> >>> Signed-off-by: John Snow >>> --- >>>   scripts/qapi/commands.py   |  6 +++++- >>>   scripts/qapi/events.py     |  7 ++++++- >>>   scripts/qapi/gen.py        | 12 +++++++++--- >>>   scripts/qapi/introspect.py |  7 ++++++- >>>   scripts/qapi/types.py      |  8 +++++++- >>>   scripts/qapi/visit.py      | 10 +++++++++- >>>   6 files changed, 42 insertions(+), 8 deletions(-) >>> >>> diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py >>> index ce5926146a..e1df0e341f 100644 >>> --- a/scripts/qapi/commands.py >>> +++ b/scripts/qapi/commands.py >>> @@ -13,7 +13,11 @@ >>>   See the COPYING file in the top-level directory. >>>   """ >>> -from .common import * >>> +from .common import ( >>> +    build_params, >>> +    c_name, >>> +    mcgen, >>> +) >>>   from .gen import QAPIGenCCode, QAPISchemaModularCVisitor, ifcontext >> >> Is this import style being suggested or enforced by any tool?  I've >> been using isort with very good results (both as a check tool, and as >> an emacs extension).  For instance, the block about would look like: >> >>     from .common import build_params, c_name, mcgen >>     from .gen import QAPIGenCCode, QAPISchemaModularCVisitor, ifcontext >> > > Not enforced by any tool, no. Just subjective preference for > git-friendly import lines. They conflict on rebase a lot less. > > I have been using emacs sort-lines to order the names in a group. > >>> diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py >>> index 0467272438..6b3afa14d7 100644 >>> --- a/scripts/qapi/events.py >>> +++ b/scripts/qapi/events.py >>> @@ -12,7 +12,12 @@ >>>   See the COPYING file in the top-level directory. >>>   """ >>> -from .common import * >>> +from .common import ( >>> +    build_params, >>> +    c_enum_const, >>> +    c_name, >>> +    mcgen, >>> +) >>>   from .gen import QAPISchemaModularCVisitor, ifcontext >>>   from .schema import QAPISchemaEnumMember >>>   from .types import gen_enum, gen_enum_lookup >>> diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py >>> index 8df19a0df0..11472ba043 100644 >>> --- a/scripts/qapi/gen.py >>> +++ b/scripts/qapi/gen.py >>> @@ -11,13 +11,19 @@ >>>   # This work is licensed under the terms of the GNU GPL, version 2. >>>   # See the COPYING file in the top-level directory. >>> - >>> +from contextlib import contextmanager >>>   import errno >>>   import os >>>   import re >>> -from contextlib import contextmanager >>> -from .common import * >>> +from .common import ( >>> +    c_fname, >>> +    gen_endif, >>> +    gen_if, >>> +    guardend, >>> +    guardstart, >>> +    mcgen, >>> +) >>>   from .schema import QAPISchemaVisitor >>> diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py >>> index 2a34cd1e8e..b036fcf9ce 100644 >>> --- a/scripts/qapi/introspect.py >>> +++ b/scripts/qapi/introspect.py >>> @@ -10,7 +10,12 @@ >>>   See the COPYING file in the top-level directory. >>>   """ >>> -from .common import * >>> +from .common import ( >>> +    c_name, >>> +    gen_endif, >>> +    gen_if, >>> +    mcgen, >>> +) >>>   from .gen import QAPISchemaMonolithicCVisitor >>>   from .schema import (QAPISchemaArrayType, QAPISchemaBuiltinType, >>>                        QAPISchemaType) >>> diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py >>> index ca9a5aacb3..53b47f9e58 100644 >>> --- a/scripts/qapi/types.py >>> +++ b/scripts/qapi/types.py >>> @@ -13,7 +13,13 @@ >>>   # See the COPYING file in the top-level directory. >>>   """ >>> -from .common import * >>> +from .common import ( >>> +    c_enum_const, >>> +    c_name, >>> +    gen_endif, >>> +    gen_if, >>> +    mcgen, >>> +) >>>   from .gen import QAPISchemaModularCVisitor, ifcontext >>>   from .schema import QAPISchemaEnumMember, QAPISchemaObjectType >>> diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py >>> index 7850f6e848..ea277e7704 100644 >>> --- a/scripts/qapi/visit.py >>> +++ b/scripts/qapi/visit.py >>> @@ -13,7 +13,15 @@ >>>   See the COPYING file in the top-level directory. >>>   """ >>> -from .common import * >>> +from .common import ( >>> +    c_enum_const, >>> +    c_name, >>> +    gen_endif, >>> +    gen_if, >>> +    mcgen, >>> +    pop_indent, >>> +    push_indent, >>> +) >> >> And here, isort will add the paranthesis (it does so based on space >> demands): >> >>     from .common import (c_enum_const, c_name, gen_endif, gen_if, mcgen, >>                          pop_indent, push_indent) >>     from .gen import QAPISchemaModularCVisitor, ifcontext >>     from .schema import QAPISchemaObjectType >> >> Other than those suggestions, it LGTM. >> > > OK. We can add a check that asserts that isort(file) == file to keep our > include regimes consistent. I'll look into the tool, but it will be > after this marathon of a series. > > Here's a gitlab issue I made on my QEMU fork to help me keep track of > Python-related issues that I intend to use: > https://gitlab.com/jsnow/qemu/-/issues/6 > I've found that `isort --force-sort-within-sections --force-grid-wrap 4 --multi-line 3 --trailing-comma` is pretty close to what I was already doing, so I'll adopt this for the respin on good faith that nobody will retract an R-B for new import orderings. force sort: I prefer to sort by module, so I intersperse "from x" and "import x" style in one section. This keeps the module reference absolutely consistent regardless of HOW we import from it. force grid: 4 or more imports from a module will get wrapped using the one-per-line style. multi-line: '3' just refers to the one-per-line style of imports that I already use. trailing comma: A little buddy that hangs out with you. >> Reviewed-by: Cleber Rosa >> > > Thanks! > > --js