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=-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 09DA4C2D0A8 for ; Wed, 30 Sep 2020 04:33:49 +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 739C62075A for ; Wed, 30 Sep 2020 04:33:48 +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="i2riVtJw" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 739C62075A 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]:55102 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kNToJ-0001O9-CS for qemu-devel@archiver.kernel.org; Wed, 30 Sep 2020 00:33:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36678) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kNTmb-0008H2-At for qemu-devel@nongnu.org; Wed, 30 Sep 2020 00:32:01 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:56999) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kNTmY-0000VG-Tr for qemu-devel@nongnu.org; Wed, 30 Sep 2020 00:32:00 -0400 Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1601440318; 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=vqJIc+VXblnmTUQ0sqCZV1SThZy4+NCqIeXNLAHOnKg=; b=i2riVtJwgaClDICj9m6ZXVJkhjuZEbE4w61aFUwmJqmN3j1gyAMXhancblinK4Fyi5JsFf XHYtr/4aVbKyuYwiUgJK7Vs/t7ldI896iqJEMvsjdtX7KSGdnVzw9MsULmCTu7vjI7ZxuM A21ZXnbE53OTjcV7U+P9stn1UbiC2XU= 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-557-wSVXEPwqNI2dQsRIafHV_Q-1; Wed, 30 Sep 2020 00:31:54 -0400 X-MC-Unique: wSVXEPwqNI2dQsRIafHV_Q-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F052F1921FB3; Wed, 30 Sep 2020 04:31:52 +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 1CD8173678; Wed, 30 Sep 2020 04:31:50 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v4 00/46] qapi: static typing conversion, pt1 Date: Wed, 30 Sep 2020 00:31:04 -0400 Message-Id: <20200930043150.1454766-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 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: quoted-printable 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/30 00:26:33 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.687, 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 , Thomas Huth , Eduardo Habkost , Markus Armbruster , John Snow , Cleber Rosa , =?UTF-8?q?Alex=20Benn=C3=A9e?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Based-on: <20200925162316.21205-1-peter.maydell@linaro.org>=0D =0D Hi, this series adds static type hints to the QAPI module.=0D This is part one!=0D =0D Part 1: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt1=0D Everything: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt6=0D =0D - Requires Python 3.6+=0D - Requires mypy 0.770 or newer (for type analysis only)=0D - Requires pylint 2.6.0 or newer (for lint checking only)=0D =0D In general, this series tackles the cleanup of one individual QAPI=0D module at a time. Once it passes pylint or mypy checks, those checks are=0D enabled for that file.=0D =0D Type hints are added in patches that add *only* type hints and change no=0D other behavior. Any necessary changes to behavior to accommodate typing=0D are split out into their own tiny patches.=0D =0D Notes:=0D =0D - `make sphinxdocs` should work on every commit. It begins to include=0D docstring content after the DO-NOT-MERGE patch 5.=0D =0D - After patch 11, `isort -c` should pass 100% on this and every=0D future commit.=0D =0D - After patch 12, `flake8 qapi/` should pass 100% on this and every=0D future commit.=0D =0D - After patch 13, `pylint --rcfile=3D3Dqapi/pylintrc qapi/` should pass 100= %=0D on this and every future commit.=0D =0D - After patch 22, `mypy --config-file=3D3Dqapi/mypy.ini qapi/` should pass= =0D 100% on this and every future commit.=0D =0D V4:=0D - Rebase on Peter Maydell's work;=0D - 05: Context differences from Peter Maydell's work=0D - 06: Remove qapi.doc=0D - 07: Remove qapi.doc, remove superfluous "if match"=0D - 09: Remove qapi.doc=0D - 13: remove qapi.doc=0D - 18: remove qapi.doc=0D - 22: remove qapi.doc=0D - 31: remove QAPIGenDoc changes=0D =0D - Minor adjustments from list feedback;=0D - 01: More backticks for QAPI json files, now that they are in Sphinx-exe= =0D - 02: Use :ref: role for the `docker-ref` cross-reference=0D - 04: Remove doc.py work changes; add references for start_if/end_if=0D - 10: Changes to accommodate isort=0D - 11: Added lines_after_imports=3D3D2=0D - 16: isort whitespace changes=0D - 24: Take Markus's docstring phrasing=0D - 34: add comment explaining os.open()=0D - 37: isort differences=0D =0D Status:=0D =0D (This is my stgit summary with reviewer tags visible.)=0D =0D [01] do-not-merge-docs-replace #=0D [02] docs-repair-broken-references #=0D [03] docs-sphinx-change-default #=0D [04] qapi-modify-docstrings-to-be #=0D [05] do-not-merge-docs-enable #=0D [06] qapi-gen-separate-arg-parsing # [SOB] JS [RB] CR,EH [TB] CR=0D [07] qapi-move-generator-entrypoint # [SOB] JS [RB] CR,EH [TB] CR=0D [08] do-not-merge-more-apidoc #=0D [09] qapi-prefer-explicit-relative # [SOB] JS [RB] CR,EH=0D [10] qapi-remove-wildcard-includes # [SOB] JS [RB] CR,EH=0D [11] qapi-enforce-import-order # [SOB] JS [RB] CR [TB] CR=0D [12] qapi-delint-using-flake8 # [SOB] JS [RB] CR,EH=0D [13] qapi-add-pylintrc # [SOB] JS [TB] CR,EH [RB] CR=0D [14] qapi-common-py-remove-python # [SOB] JS [RB] CR,EH=0D [15] qapi-common-add-indent-manager # [SOB] JS [RB] CR,EH=0D [16] qapi-common-py-delint-with # [SOB] JS [RB] CR,EH=0D [17] replace-c-by-char # [SOB] JS [RB] CR,EH=0D [18] qapi-common-py-check-with # [SOB] JS [RB] CR [TB] CR,EH=0D [19] qapi-common-py-add-notational # [SOB] JS [RB] CR,EH=0D [20] qapi-common-move-comments-into # [SOB] JS [RB] CR,EH=0D [21] qapi-split-build_params-into # [SOB] JS [RB] CR,EH=0D [22] qapi-establish-mypy-type # [SOB] JS [TB] CR,EH [RB] CR=0D [23] qapi-events-py-add-notational # [SOB] JS [RB] CR,EH=0D [24] qapi-events-move-comments-into # [SOB] JS [RB] CR,EH=0D [25] qapi-commands-py-don-t-re-bind # [SOB] JS [RB] CR,EH=0D [26] qapi-commands-py-add # [SOB] JS [RB] CR,EH=0D [27] qapi-commands-py-enable # [SOB] JS [RB] CR,EH=0D [28] qapi-source-py-add-notational # [SOB] JS [RB] CR,EH [TB] CR=0D [29] qapi-source-py-delint-with # [SOB] JS [RB] CR,EH [TB] CR=0D [30] qapi-gen-py-fix-edge-case-of # [SOB] JS [RB] CR=0D [31] qapi-gen-py-add-notational # [SOB] JS [RB] CR,EH=0D [32] qapi-gen-py-enable-checking # [SOB] JS [RB] CR,EH [TB] CR=0D [33] qapi-gen-py-remove-unused # [SOB] JS [RB] CR,EH=0D [34] qapi-gen-py-update-write-to-be # [SOB] JS [RB] CR,EH=0D [35] qapi-gen-py-delint-with-pylint # [SOB] JS [RB] CR,EH=0D [36] qapi-introspect-py-assert-obj #=0D [37] qapi-introspect-py-create-a # [SOB] EH,JS=0D [38] qapi-introspect-py-add #=0D [39] qapi-introspect-py-unify #=0D [40] qapi-introspect-py-replace #=0D [41] qapi-introspect-py-create-a-0 #=0D [42] qapi-types-py-add-type-hint # [SOB] JS [RB] CR,EH=0D [43] qapi-types-py-remove-one # [SOB] JS [RB] CR,EH=0D [44] qapi-visit-py-assert # [SOB] JS [RB] CR,EH=0D [45] qapi-visit-py-remove-unused # [SOB] JS [RB] CR,EH [TB] CR=0D [46] qapi-visit-py-add-notational # [SOB] JS [RB] CR,EH [TB] CR=0D =0D Changelog:=0D =0D (Patches without changes elided)=0D =0D 001/46:[0004] [FC] '[DO-NOT-MERGE] docs: replace single backtick (`) with d= ou=3D=0D ble-backtick (``)'=0D 002/46:[0002] [FC] 'docs: repair broken references'=0D 004/46:[0014] [FC] 'qapi: modify docstrings to be sphinx-compatible'=0D 005/46:[0015] [FC] '[DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/= qa=3D=0D pi'=0D 006/46:[0004] [FC] 'qapi-gen: Separate arg-parsing from generation'=0D 007/46:[0008] [FC] 'qapi: move generator entrypoint into module'=0D 009/46:[0004] [FC] 'qapi: Prefer explicit relative imports'=0D 010/46:[0006] [FC] 'qapi: Remove wildcard includes'=0D 011/46:[0023] [FC] 'qapi: enforce import order/styling with isort'=0D 013/46:[0001] [FC] 'qapi: add pylintrc'=0D 016/46:[0001] [FC] 'qapi/common.py: delint with pylint'=0D 018/46:[0004] [FC] 'qapi/common.py: check with pylint'=0D 022/46:[0008] [FC] 'qapi: establish mypy type-checking baseline'=0D 024/46:[0004] [FC] 'qapi/events.py: Move comments into docstrings'=0D 031/46:[0003] [FC] 'qapi/gen.py: add type hint annotations'=0D 034/46:[0001] [FC] 'qapi/gen.py: update write() to be more idiomatic'=0D 037/46:[0009] [FC] 'qapi/instrospect.py: add preliminary type hint annotati= on=3D=0D s'=0D =0D V3:=0D - Use isort to enforce import consistency=0D - Use sphinx apidoc to check docstring format=0D =0D V2:=0D - Removed Python3.6 patch in favor of Thomas Huth's=0D - Addressed (most) feedback from Markus=0D - Renamed type hint annotation commits=0D =0D Eduardo Habkost (1):=0D qapi/instrospect.py: add preliminary type hint annotations=0D =0D John Snow (45):=0D [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick=0D (``)=0D docs: repair broken references=0D [DO-NOT-MERGE] docs/sphinx: change default role to "any"=0D qapi: modify docstrings to be sphinx-compatible=0D [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi=0D qapi-gen: Separate arg-parsing from generation=0D qapi: move generator entrypoint into module=0D [DO-NOT-MERGE] docs: add scripts/qapi/main to python manual=0D qapi: Prefer explicit relative imports=0D qapi: Remove wildcard includes=0D qapi: enforce import order/styling with isort=0D qapi: delint using flake8=0D qapi: add pylintrc=0D qapi/common.py: Remove python compatibility workaround=0D qapi/common.py: Add indent manager=0D qapi/common.py: delint with pylint=0D qapi/common.py: Replace one-letter 'c' variable=0D qapi/common.py: check with pylint=0D qapi/common.py: add type hint annotations=0D qapi/common.py: Convert comments into docstrings, and elaborate=0D qapi/common.py: move build_params into gen.py=0D qapi: establish mypy type-checking baseline=0D qapi/events.py: add type hint annotations=0D qapi/events.py: Move comments into docstrings=0D qapi/commands.py: Don't re-bind to variable of different type=0D qapi/commands.py: add type hint annotations=0D qapi/commands.py: enable checking with mypy=0D qapi/source.py: add type hint annotations=0D qapi/source.py: delint with pylint=0D qapi/gen.py: Fix edge-case of _is_user_module=0D qapi/gen.py: add type hint annotations=0D qapi/gen.py: Enable checking with mypy=0D qapi/gen.py: Remove unused parameter=0D qapi/gen.py: update write() to be more idiomatic=0D qapi/gen.py: delint with pylint=0D qapi/introspect.py: assert obj is a dict when features are given=0D qapi/introspect.py: add _gen_features helper=0D qapi/introspect.py: Unify return type of _make_tree()=0D qapi/introspect.py: replace 'extra' dict with 'comment' argument=0D qapi/introspect.py: create a typed 'Node' data structure=0D qapi/types.py: add type hint annotations=0D qapi/types.py: remove one-letter variables=0D qapi/visit.py: assert tag_member contains a QAPISchemaEnumType=0D qapi/visit.py: remove unused parameters from gen_visit_object=0D qapi/visit.py: add type hint annotations=0D =0D docs/conf.py | 6 +-=0D docs/devel/build-system.rst | 118 +++++++-------=0D docs/devel/index.rst | 1 +=0D docs/devel/migration.rst | 59 +++----=0D docs/devel/multi-thread-tcg.rst | 2 +-=0D docs/devel/python/index.rst | 7 +=0D docs/devel/python/qapi.commands.rst | 7 +=0D docs/devel/python/qapi.common.rst | 7 +=0D docs/devel/python/qapi.error.rst | 7 +=0D docs/devel/python/qapi.events.rst | 7 +=0D docs/devel/python/qapi.expr.rst | 7 +=0D docs/devel/python/qapi.gen.rst | 7 +=0D docs/devel/python/qapi.introspect.rst | 7 +=0D docs/devel/python/qapi.main.rst | 7 +=0D docs/devel/python/qapi.parser.rst | 8 +=0D docs/devel/python/qapi.rst | 26 +++=0D docs/devel/python/qapi.schema.rst | 7 +=0D docs/devel/python/qapi.source.rst | 7 +=0D docs/devel/python/qapi.types.rst | 7 +=0D docs/devel/python/qapi.visit.rst | 7 +=0D docs/devel/tcg-plugins.rst | 14 +-=0D docs/devel/testing.rst | 4 +-=0D docs/interop/live-block-operations.rst | 4 +-=0D docs/system/arm/cpu-features.rst | 110 ++++++-------=0D docs/system/arm/nuvoton.rst | 2 +-=0D docs/system/s390x/protvirt.rst | 10 +-=0D qapi/block-core.json | 4 +-=0D scripts/qapi-gen.py | 57 ++-----=0D scripts/qapi/.flake8 | 2 +=0D scripts/qapi/.isort.cfg | 7 +=0D scripts/qapi/commands.py | 87 +++++++---=0D scripts/qapi/common.py | 163 ++++++++++---------=0D scripts/qapi/events.py | 58 +++++--=0D scripts/qapi/expr.py | 7 +-=0D scripts/qapi/gen.py | 182 +++++++++++++--------=0D scripts/qapi/introspect.py | 210 +++++++++++++++++--------=0D scripts/qapi/main.py | 89 +++++++++++=0D scripts/qapi/mypy.ini | 25 +++=0D scripts/qapi/parser.py | 15 +-=0D scripts/qapi/pylintrc | 70 +++++++++=0D scripts/qapi/schema.py | 35 +++--=0D scripts/qapi/source.py | 34 ++--=0D scripts/qapi/types.py | 125 ++++++++++-----=0D scripts/qapi/visit.py | 116 ++++++++++----=0D 44 files changed, 1175 insertions(+), 566 deletions(-)=0D create mode 100644 docs/devel/python/index.rst=0D create mode 100644 docs/devel/python/qapi.commands.rst=0D create mode 100644 docs/devel/python/qapi.common.rst=0D create mode 100644 docs/devel/python/qapi.error.rst=0D create mode 100644 docs/devel/python/qapi.events.rst=0D create mode 100644 docs/devel/python/qapi.expr.rst=0D create mode 100644 docs/devel/python/qapi.gen.rst=0D create mode 100644 docs/devel/python/qapi.introspect.rst=0D create mode 100644 docs/devel/python/qapi.main.rst=0D create mode 100644 docs/devel/python/qapi.parser.rst=0D create mode 100644 docs/devel/python/qapi.rst=0D create mode 100644 docs/devel/python/qapi.schema.rst=0D create mode 100644 docs/devel/python/qapi.source.rst=0D create mode 100644 docs/devel/python/qapi.types.rst=0D create mode 100644 docs/devel/python/qapi.visit.rst=0D create mode 100644 scripts/qapi/.flake8=0D create mode 100644 scripts/qapi/.isort.cfg=0D create mode 100644 scripts/qapi/main.py=0D create mode 100644 scripts/qapi/mypy.ini=0D create mode 100644 scripts/qapi/pylintrc=0D =0D --=3D20=0D 2.26.2=0D =0D