From patchwork Thu Mar 25 06:03:37 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 12162981 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,INCLUDES_PATCH,MAILING_LIST_MULTI, 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 A6537C433DB for ; Thu, 25 Mar 2021 06:07:06 +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 09A5761A1E for ; Thu, 25 Mar 2021 06:07:06 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 09A5761A1E 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]:33366 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lPJ96-0003bY-W5 for qemu-devel@archiver.kernel.org; Thu, 25 Mar 2021 02:07:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39778) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lPJ6E-00022c-Ji for qemu-devel@nongnu.org; Thu, 25 Mar 2021 02:04:06 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:29355) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lPJ6B-0008Ir-Q9 for qemu-devel@nongnu.org; Thu, 25 Mar 2021 02:04:06 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1616652241; 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=Vkd3lbJyJdV4cUWdRqdCfjx3ZK1SkT26aBHC26WmGV8=; b=Yx1T9NA7zVmf3bbv57Om6rUCzKOR6b7A3iv3ALDDKcVRXpFagL0GtV3L6MQP2KjwvD9FLW QrproSmE3rMXgZs//71iA+71WQgpo8aly3LyQws+6WZ5EhfXvJOs7uLn+HaYffNuIDJUYo oLWCwdT7tOboib7pgT/NpOWeEVyolOQ= 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-203-0sHmnJBhNaSW6xab1x2Vrw-1; Thu, 25 Mar 2021 02:03:59 -0400 X-MC-Unique: 0sHmnJBhNaSW6xab1x2Vrw-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 13F34190B2A3; Thu, 25 Mar 2021 06:03:58 +0000 (UTC) Received: from scv.redhat.com (ovpn-117-181.rdu2.redhat.com [10.10.117.181]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5CD9A88EE3; Thu, 25 Mar 2021 06:03:57 +0000 (UTC) From: John Snow To: Markus Armbruster , qemu-devel@nongnu.org Subject: [PATCH v4 00/19] qapi: static typing conversion, pt3 Date: Thu, 25 Mar 2021 02:03:37 -0400 Message-Id: <20210325060356.4040114-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 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-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.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=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: Michael Roth , John Snow , Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Hi, this series adds static types to the QAPI module. This is part three, and it focuses on expr.py. Environment: - Python >= 3.6, <= 3.8 * - mypy >= 0.770 - pylint >= 2.6.0 - flake8 - isort Every commit should pass with (from ./scripts/): - flake8 qapi/ - pylint --rcfile=qapi/pylintrc qapi/ - mypy --config-file=qapi/mypy.ini qapi/ - pushd qapi && isort -c . && popd V4: Patch 2 is exploratory. Patch 8 is broken and should be merged into Patch 9. Patches 17-19 are optional and I'd sooner you drop them than have to respin. 001/19:[down] 'qapi/expr: Comment cleanup' 002/19:[down] 'flake8: Enforce shorter line length for comments and docstrings' 003/19:[----] [--] 'qapi/expr.py: Remove 'info' argument from nested check_if_str' 004/19:[----] [--] 'qapi/expr.py: Check for dict instead of OrderedDict' 005/19:[0011] [FC] 'qapi/expr.py: constrain incoming expression types' 006/19:[0006] [FC] 'qapi/expr.py: Add assertion for union type 'check_dict'' 007/19:[----] [--] 'qapi/expr.py: move string check upwards in check_type' 008/19:[down] 'qapi: add tests for invalid 'data' field type' 009/19:[0004] [FC] 'qapi/expr.py: Check type of 'data' member' 010/19:[0008] [FC] 'qapi/expr.py: Add casts in a few select cases' 011/19:[0005] [FC] 'qapi/expr.py: Modify check_keys to accept any Collection' 012/19:[0057] [FC] 'qapi/expr.py: add type hint annotations' 013/19:[0032] [FC] 'qapi/expr.py: Consolidate check_if_str calls in check_if' 014/19:[0016] [FC] 'qapi/expr.py: Remove single-letter variable' 015/19:[----] [--] 'qapi/expr.py: enable pylint checks' 016/19:[0168] [FC] 'qapi/expr.py: Add docstrings' 017/19:[----] [-C] 'qapi/expr.py: Use tuples instead of lists for static data' 018/19:[----] [-C] 'qapi/expr.py: move related checks inside check_xxx functions' 019/19:[0003] [FC] 'qapi/expr.py: Use an expression checker dispatch table' - Add test patch to demonstrate 72col docstring enforcement. (Not a fan.) - Changed MutableMapping type to regular ol' dict. - Added tests for alternate and union to see what happens when we pass a list for 'data' instead. (It crashes.) - Rewrote a bunch of the docstrings. - Updated type hints for rc0 - Rebased on latest master, incorporating latest qapi changes. - Addressed most feedback, some exceptions; - Kept isinstance check for dict; it is strictly more convenient to me and it does not cause breakages. It won't cause breakages. RFCs/notes: - I'd be flabbergasted if anyone reads these. John Snow (19): qapi/expr: Comment cleanup flake8: Enforce shorter line length for comments and docstrings qapi/expr.py: Remove 'info' argument from nested check_if_str qapi/expr.py: Check for dict instead of OrderedDict qapi/expr.py: constrain incoming expression types qapi/expr.py: Add assertion for union type 'check_dict' qapi/expr.py: move string check upwards in check_type qapi: add tests for invalid 'data' field type qapi/expr.py: Check type of 'data' member qapi/expr.py: Add casts in a few select cases qapi/expr.py: Modify check_keys to accept any Collection qapi/expr.py: add type hint annotations qapi/expr.py: Consolidate check_if_str calls in check_if qapi/expr.py: Remove single-letter variable qapi/expr.py: enable pylint checks qapi/expr.py: Add docstrings qapi/expr.py: Use tuples instead of lists for static data qapi/expr.py: move related checks inside check_xxx functions qapi/expr.py: Use an expression checker dispatch table scripts/qapi/.flake8 | 1 + scripts/qapi/common.py | 8 +- scripts/qapi/events.py | 9 +- scripts/qapi/expr.py | 499 +++++++++++++----- scripts/qapi/gen.py | 8 +- scripts/qapi/introspect.py | 8 +- scripts/qapi/main.py | 4 +- scripts/qapi/mypy.ini | 5 - scripts/qapi/parser.py | 15 +- scripts/qapi/pylintrc | 1 - scripts/qapi/schema.py | 23 +- scripts/qapi/types.py | 7 +- .../alternate-invalid-data-type.err | 2 + .../alternate-invalid-data-type.json | 4 + .../alternate-invalid-data-type.out | 0 tests/qapi-schema/meson.build | 2 + tests/qapi-schema/union-invalid-data-type.err | 2 + .../qapi-schema/union-invalid-data-type.json | 13 + tests/qapi-schema/union-invalid-data-type.out | 0 19 files changed, 449 insertions(+), 162 deletions(-) create mode 100644 tests/qapi-schema/alternate-invalid-data-type.err create mode 100644 tests/qapi-schema/alternate-invalid-data-type.json create mode 100644 tests/qapi-schema/alternate-invalid-data-type.out create mode 100644 tests/qapi-schema/union-invalid-data-type.err create mode 100644 tests/qapi-schema/union-invalid-data-type.json create mode 100644 tests/qapi-schema/union-invalid-data-type.out