From patchwork Tue Sep 22 21:00:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 304732 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=-8.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING, 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 E0E79C4727D for ; Tue, 22 Sep 2020 21:11:24 +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 6FF1020715 for ; Tue, 22 Sep 2020 21:11:24 +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="UKMBIL8d" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6FF1020715 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]:33238 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kKpZL-000605-F9 for qemu-devel@archiver.kernel.org; Tue, 22 Sep 2020 17:11:23 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36940) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kKpPb-0001zk-96 for qemu-devel@nongnu.org; Tue, 22 Sep 2020 17:01:25 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:55655) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kKpPY-0004Xn-Vc for qemu-devel@nongnu.org; Tue, 22 Sep 2020 17:01:18 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1600808476; 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; bh=P0vPMY365iP0scQ30oS8TUqlW7pNatr1SSOpqlNr8aY=; b=UKMBIL8dVkwEOpTYBT/LmbZDtOFjb9Zas/jFsY+2pZzGZbsR/1bIgFnfQUhmFv0TgHExgm kxNSMiGafPSp0E1mpqd+0Bdaxb7+VI7p2tsY3HBM2TgGbzpJ+ej8J7tIILsjLrVxOhkFio mmvZUZAJ8180SnmGsq4bVHXen3dyIFw= 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-187-gsrFPbeFOYmRwAv7FS9c-g-1; Tue, 22 Sep 2020 17:01:04 -0400 X-MC-Unique: gsrFPbeFOYmRwAv7FS9c-g-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 66C50100746D; Tue, 22 Sep 2020 21:01:03 +0000 (UTC) Received: from scv.redhat.com (ovpn-119-140.rdu2.redhat.com [10.10.119.140]) by smtp.corp.redhat.com (Postfix) with ESMTP id 433C855765; Tue, 22 Sep 2020 21:01:02 +0000 (UTC) From: John Snow To: Markus Armbruster , qemu-devel@nongnu.org Subject: [PATCH v2 00/38] qapi: static typing conversion, pt1 Date: Tue, 22 Sep 2020 17:00:23 -0400 Message-Id: <20200922210101.4081073-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 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 Received-SPF: pass client-ip=216.205.24.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/22 15:47:47 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -35 X-Spam_score: -3.6 X-Spam_bar: --- X-Spam_report: (-3.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.455, 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 , Eduardo Habkost , =?utf-8?q?Alex_Benn=C3=A9e?= , Michael Roth , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Hi, this series adds static type hints to the QAPI module. This is part one! Part 1: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt1 Everything: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt6 - Requires Python 3.6+ - Requires mypy 0.770 or newer (for type analysis only) - Requires pylint 2.6.0 or newer (for lint checking only) In general, this series tackles the cleanup of one individual QAPI module at a time. Once it passes pylint or mypy checks, those checks are enabled for that file. Type hints are added in patches that add *only* type hints and change no other behavior. Any necessary changes to behavior to accommodate typing are split out into their own tiny patches. - Patches 1-7: generic, qapi-wide cleanups, flake8 and pylint support - Patches 8-16: common.py cleanup (with mypy support added at the end) - Patches 17-18: events.py cleanup - Patches 19-21: commands.py cleanup - Patches 22-23: source.py cleanup - Patches 24-29: gen.py cleanup - Patches 30-33: introspect.py cleanup - Patches 34-35: types.py cleanup - Patches 36-37: visit.py cleanup Notes: - After patch 6, `flake8 qapi/` should pass 100% on this and every future commit. - After patch 7, `pylint --rcfile=3Dqapi/pylintrc qapi/` should pass 100% on this and every future commit. - After patch 16, `mypy --config-file=3Dqapi/mypy.ini qapi/` should pass 100% on this and every future commit. V2: - Removed Python3.6 patch in favor of Thomas Huth's - Addressed (most) feedback from Markus - Renamed type hint annotation commits Changelog: 003/38:[0082] [FC] 'qapi: move generator entrypoint into module' 004/38:[down] 'qapi: Prefer explicit relative imports' 006/38:[0027] [FC] 'qapi: delint using flake8' 007/38:[0006] [FC] 'qapi: add pylintrc' 008/38:[0002] [FC] 'qapi/common.py: Remove python compatibility workaround' 009/38:[0037] [FC] 'qapi/common.py: Add indent manager' 010/38:[0008] [FC] 'qapi/common.py: delint with pylint' 011/38:[0002] [FC] 'qapi/common.py: Replace one-letter 'c' variable' 012/38:[----] [-C] 'qapi/common.py: check with pylint' 013/38:[down] 'qapi/common.py: add type hint annotations' 014/38:[down] 'qapi/common.py: Convert comments into docstrings, and elaborat= e' 015/38:[down] 'qapi/common.py: move build_params into gen.py' 017/38:[down] 'qapi/events.py: add type hint annotations' 020/38:[0006] [FC] 'qapi/commands.py: add notational type hints' 022/38:[down] 'qapi/source.py: add type hint annotations' 025/38:[down] 'qapi/gen.py: add type hint annotations' 033/38:[down] 'qapi/introspect.py: add type hint annotations' 034/38:[down] 'qapi/types.py: add type hint annotations' 036/38:[down] 'qapi/visit.py: assert tag_member contains a QAPISchemaEnumType' 037/38:[----] [-C] 'qapi/visit.py: remove unused parameters from gen_visit_ob= ject' 038/38:[down] 'qapi/visit.py: add type hint annotations' John Snow (38): [DO-NOT-MERGE] qapi: add debugging tools qapi-gen: Separate arg-parsing from generation qapi: move generator entrypoint into module qapi: Prefer explicit relative imports qapi: Remove wildcard includes qapi: delint using flake8 qapi: add pylintrc qapi/common.py: Remove python compatibility workaround qapi/common.py: Add indent manager qapi/common.py: delint with pylint qapi/common.py: Replace one-letter 'c' variable qapi/common.py: check with pylint qapi/common.py: add type hint annotations qapi/common.py: Convert comments into docstrings, and elaborate qapi/common.py: move build_params into gen.py qapi: establish mypy type-checking baseline qapi/events.py: add type hint annotations qapi/events.py: Move comments into docstrings qapi/commands.py: Don't re-bind to variable of different type qapi/commands.py: add notational type hints qapi/commands.py: enable checking with mypy qapi/source.py: add type hint annotations qapi/source.py: delint with pylint qapi/gen.py: Fix edge-case of _is_user_module qapi/gen.py: add type hint annotations qapi/gen.py: Enable checking with mypy qapi/gen.py: Remove unused parameter qapi/gen.py: update write() to be more idiomatic qapi/gen.py: delint with pylint qapi/introspect.py: Add a typed 'extra' structure qapi/introspect.py: add _gen_features helper qapi/introspect.py: create a typed 'Node' data structure qapi/introspect.py: add type hint annotations qapi/types.py: add type hint annotations qapi/types.py: remove one-letter variables qapi/visit.py: assert tag_member contains a QAPISchemaEnumType qapi/visit.py: remove unused parameters from gen_visit_object qapi/visit.py: add type hint annotations scripts/qapi-gen.py | 59 ++--------- scripts/qapi/.flake8 | 2 + scripts/qapi/commands.py | 85 +++++++++++---- scripts/qapi/common.py | 163 +++++++++++++++------------- scripts/qapi/debug.py | 78 ++++++++++++++ scripts/qapi/doc.py | 3 +- scripts/qapi/events.py | 64 ++++++++--- scripts/qapi/expr.py | 4 +- scripts/qapi/gen.py | 176 ++++++++++++++++++------------ scripts/qapi/introspect.py | 212 +++++++++++++++++++++++++------------ scripts/qapi/main.py | 91 ++++++++++++++++ scripts/qapi/mypy.ini | 30 ++++++ scripts/qapi/parser.py | 4 +- scripts/qapi/pylintrc | 71 +++++++++++++ scripts/qapi/schema.py | 33 +++--- scripts/qapi/source.py | 34 +++--- scripts/qapi/types.py | 125 +++++++++++++++------- scripts/qapi/visit.py | 116 ++++++++++++++------ 18 files changed, 952 insertions(+), 398 deletions(-) create mode 100644 scripts/qapi/.flake8 create mode 100644 scripts/qapi/debug.py create mode 100644 scripts/qapi/main.py create mode 100644 scripts/qapi/mypy.ini create mode 100644 scripts/qapi/pylintrc --=20 2.26.2