From patchwork Mon Oct 5 19:51:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 303679 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 9395BC4727D for ; Mon, 5 Oct 2020 19:56:14 +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 E2FD42100A for ; Mon, 5 Oct 2020 19:56:13 +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="i/anr2KU" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E2FD42100A 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]:46524 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kPWai-0005DQ-OQ for qemu-devel@archiver.kernel.org; Mon, 05 Oct 2020 15:56:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56650) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kPWWn-00086C-A3 for qemu-devel@nongnu.org; Mon, 05 Oct 2020 15:52:09 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:58575) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kPWWj-00075H-53 for qemu-devel@nongnu.org; Mon, 05 Oct 2020 15:52:08 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1601927524; 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=DZSd31JrC4uoHSjlcc4hpIVP2Ypy+WtRopVfDBA+EBY=; b=i/anr2KUVxtyLd54kcpP/82Io9oszq/s0wyIBOvlTWtIUST2Mgdo8Tj8MrOp9cJtLCe9jn y1TuioOaXTklnbU+OtFlHMWzES4sPWby6htY5KJNKAd7WADOGQel0LE2tllgnFd31YsQxE Q+mQuHj8rRBy4HNtZO5Xa1n3P0tFmuM= 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-380-wicE_L1eP8OPccrbhgJmYw-1; Mon, 05 Oct 2020 15:52:00 -0400 X-MC-Unique: wicE_L1eP8OPccrbhgJmYw-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7F92318A0762 for ; Mon, 5 Oct 2020 19:51:59 +0000 (UTC) Received: from scv.redhat.com (ovpn-120-38.rdu2.redhat.com [10.10.120.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id D51E65C1BD; Mon, 5 Oct 2020 19:51:58 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v5 00/36] qapi: static typing conversion, pt1 Date: Mon, 5 Oct 2020 15:51:22 -0400 Message-Id: <20201005195158.2348217-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 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=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/10/05 01:25:11 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.733, 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: Cleber Rosa , John Snow , Eduardo Habkost , Markus Armbruster 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. Notes: - After patch 07, `isort -c` should pass 100% on this and every future commit. - After patch 08, `flake8 qapi/` should pass 100% on this and every future commit. - After patch 09, `pylint --rcfile=qapi/pylintrc qapi/` should pass 100% on this and every future commit. - After patch 18, `mypy --config-file=qapi/mypy.ini qapi/` should pass 100% on this and every future commit. Review Status: [01] docs-repair-broken-references # [02] qapi-modify-docstrings-to-be # [03] qapi-gen-separate-arg-parsing # [RB] CR,EH [TB] CR [SOB] JS [04] qapi-move-generator-entrypoint # [RB] CR,EH [TB] CR [SOB] JS [05] qapi-prefer-explicit-relative # [RB] CR,EH [SOB] JS [06] qapi-remove-wildcard-includes # [RB] CR,EH [SOB] JS [07] qapi-enforce-import-order # [RB] CR [TB] CR [SOB] JS [08] qapi-delint-using-flake8 # [RB] CR,EH [SOB] JS [09] qapi-add-pylintrc # [RB] CR [TB] CR,EH [SOB] JS [10] qapi-common-py-remove-python # [RB] CR,EH [SOB] JS [11] qapi-common-add-indent-manager # [RB] CR,EH [SOB] JS [12] qapi-common-py-delint-with # [RB] CR,EH [SOB] JS [13] replace-c-by-char # [RB] CR,EH [SOB] JS [14] qapi-common-py-check-with # [RB] CR [TB] CR,EH [SOB] JS [15] qapi-common-py-add-notational # [RB] CR,EH [SOB] JS [16] qapi-common-move-comments-into # [RB] CR,EH [SOB] JS [17] qapi-split-build_params-into # [RB] CR,EH [SOB] JS [18] qapi-establish-mypy-type # [RB] CR [TB] CR,EH [SOB] JS [19] qapi-events-py-add-notational # [RB] CR,EH [SOB] JS [20] qapi-events-move-comments-into # [RB] CR,EH [SOB] JS [21] qapi-commands-py-don-t-re-bind # [RB] CR,EH [SOB] JS [22] qapi-commands-py-add # [RB] CR,EH [SOB] JS [23] qapi-commands-py-enable # [RB] CR,EH [SOB] JS [24] qapi-source-py-add-notational # [RB] CR,EH [TB] CR [SOB] JS [25] qapi-source-py-delint-with # [RB] CR,EH [TB] CR [SOB] JS [26] qapi-gen-py-fix-edge-case-of # [RB] CR,EH [SOB] JS [27] qapi-gen-py-add-notational # [RB] CR,EH [SOB] JS [28] qapi-gen-py-enable-checking # [RB] CR,EH [TB] CR [SOB] JS [29] qapi-gen-py-remove-unused # [RB] CR,EH [SOB] JS [30] qapi-gen-py-update-write-to-be # [RB] CR,EH [SOB] JS [31] qapi-gen-py-delint-with-pylint # [RB] CR,EH [SOB] JS [32] qapi-types-py-add-type-hint # [RB] CR,EH [SOB] JS [33] qapi-types-py-remove-one # [RB] CR,EH [SOB] JS [34] qapi-visit-py-assert # [RB] CR,EH [SOB] JS [35] qapi-visit-py-remove-unused # [RB] CR,EH [TB] CR [SOB] JS [36] qapi-visit-py-add-notational # [RB] CR,EH [TB] CR [SOB] JS Changelog: 002/36:[0012] [FC] 'qapi: modify docstrings to be sphinx-compatible' 027/36:[----] [-C] 'qapi/gen.py: add type hint annotations' V5: - Remove DO-NOT-MERGE patches (Now in Part2) - Remove introspect.py patches (Now in Part2) - 02: Docstring formatting, more commit message (Markus) V4: - Rebase on Peter Maydell's work; - 05: Context differences from Peter Maydell's work - 06: Remove qapi.doc - 07: Remove qapi.doc, remove superfluous "if match" - 09: Remove qapi.doc - 13: remove qapi.doc - 18: remove qapi.doc - 22: remove qapi.doc - 31: remove QAPIGenDoc changes - Minor adjustments from list feedback; - 01: More backticks for QAPI json files, now that they are in Sphinx-exe - 02: Use :ref: role for the `docker-ref` cross-reference - 04: Remove doc.py work changes; add references for start_if/end_if - 10: Changes to accommodate isort - 11: Added lines_after_imports=2 - 16: isort whitespace changes - 24: Take Markus's docstring phrasing - 34: add comment explaining os.open() - 37: isort differences V3: - Use isort to enforce import consistency - Use sphinx apidoc to check docstring format V2: - Removed Python3.6 patch in favor of Thomas Huth's - Addressed (most) feedback from Markus - Renamed type hint annotation commits John Snow (36): docs: repair broken references qapi: modify docstrings to be sphinx-compatible qapi-gen: Separate arg-parsing from generation qapi: move generator entrypoint into module qapi: Prefer explicit relative imports qapi: Remove wildcard includes qapi: enforce import order/styling with isort 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 type hint annotations 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/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 docs/devel/multi-thread-tcg.rst | 2 +- docs/devel/testing.rst | 2 +- scripts/qapi-gen.py | 57 ++-------- scripts/qapi/.flake8 | 2 + scripts/qapi/.isort.cfg | 7 ++ scripts/qapi/commands.py | 87 +++++++++++---- scripts/qapi/common.py | 163 +++++++++++++++------------- scripts/qapi/events.py | 58 +++++++--- scripts/qapi/expr.py | 7 +- scripts/qapi/gen.py | 182 ++++++++++++++++++++------------ scripts/qapi/introspect.py | 16 ++- scripts/qapi/main.py | 89 ++++++++++++++++ scripts/qapi/mypy.ini | 30 ++++++ scripts/qapi/parser.py | 7 +- scripts/qapi/pylintrc | 70 ++++++++++++ scripts/qapi/schema.py | 33 +++--- scripts/qapi/source.py | 34 +++--- scripts/qapi/types.py | 125 +++++++++++++++------- scripts/qapi/visit.py | 116 ++++++++++++++------ 19 files changed, 752 insertions(+), 335 deletions(-) create mode 100644 scripts/qapi/.flake8 create mode 100644 scripts/qapi/.isort.cfg create mode 100644 scripts/qapi/main.py create mode 100644 scripts/qapi/mypy.ini create mode 100644 scripts/qapi/pylintrc -- 2.26.2