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=-11.1 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, 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 69F35C43465 for ; Mon, 21 Sep 2020 14:46:02 +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 DFABB221EC for ; Mon, 21 Sep 2020 14:46:01 +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="UmpRj80k" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DFABB221EC 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]:33352 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kKN4q-00073x-QC for qemu-devel@archiver.kernel.org; Mon, 21 Sep 2020 10:46:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52250) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kKN0r-0003wL-53 for qemu-devel@nongnu.org; Mon, 21 Sep 2020 10:41:53 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:32962) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kKN0o-0005nW-TF for qemu-devel@nongnu.org; Mon, 21 Sep 2020 10:41:52 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1600699308; 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=FoUvRNd8+A3TxCzgsIMjrZMp12N5JQFjlSQohA0vwL8=; b=UmpRj80kP/hLusPPMt9xewVa6Frxz2LJHrJrfnn2K6RNl/a4wnEQHyHPCP2uKc/gR8u4Zy mr4SRuMJAfKqRT1eGijXdsKu6BMPO2/O97vUiVEUp09ubHh6/QG9rWt7GA87TsK+UY5b1R mOiYOQ/MOzJ3oW76Ib6uXGlk9mOsrrM= 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-428-ETZfnpQMOp6jYQC6iZPmDw-1; Mon, 21 Sep 2020 10:41:29 -0400 X-MC-Unique: ETZfnpQMOp6jYQC6iZPmDw-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 5FA65802B76; Mon, 21 Sep 2020 14:41:28 +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 999BC619B5; Mon, 21 Sep 2020 14:41:27 +0000 (UTC) Subject: Re: [PATCH 16/37] qapi: establish mypy type-checking baseline To: Markus Armbruster References: <20200915224027.2529813-1-jsnow@redhat.com> <20200915224027.2529813-17-jsnow@redhat.com> <874knvguzb.fsf@dusky.pond.sub.org> <87k0wna723.fsf@dusky.pond.sub.org> From: John Snow Message-ID: <510ead18-a91c-8d25-880a-99a9d628a25e@redhat.com> Date: Mon, 21 Sep 2020 10:41:27 -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: <87k0wna723.fsf@dusky.pond.sub.org> 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 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US 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/21 01:44:53 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, NICE_REPLY_A=-0.001, 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 , =?UTF-8?Q?Alex_Benn=c3=a9e?= , qemu-devel@nongnu.org, Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 9/21/20 4:05 AM, Markus Armbruster wrote: > John Snow writes: > >> On 9/18/20 7:55 AM, Markus Armbruster wrote: >>> Ignorant question: why does this come after PATCH 13 "qapi/common.py: >>> add notational type hints", but before all the other patches adding type >>> hints? >>> John Snow writes: >>> >>>> Fix two very minor issues, and then establish a mypy type-checking >>>> baseline. >>>> >>>> Like pylint, this should be run from the folder above: >>>> >>>> > mypy --config-file=qapi/mypy.ini qapi/ >>> I get: >>> $ mypy --config-file qapi/mypy.ini qapi >>> qapi/mypy.ini: [mypy]: Strict mode is not supported in configuration files: specify individual flags instead (see 'mypy -h' for the list of flags enabled in strict mode) >>> qapi/types.py:29: error: Need type annotation for 'objects_seen' (hint: "objects_seen: Set[] = ...") >>> Found 1 error in 1 file (checked 18 source files) >>> Is this expected? >>> >> >> Nope. >> >>> In case it matters: >>> $ mypy --version >>> mypy 0.761 >>> >> >> I am using mypy 0.782. >> >> I will investigate to see if there is an *easy* win to allow older >> versions to work. >> >> In the meantime, please consider trying this: >> >> pip install --user mypy==0.782 >> ~/.local/bin/mypy --config-file=qapi/mypy.ini qapi/ > > I'll consider dragging my feet until upgrading Fedora gives it to me for > free. > > The less I interact with package managers, the happier I am. > I'll probably be working on making sure CI runs in a virtual environment with specifically pinned versions. We don't need mypy to run or build, so I have been less worried about requiring bleeding edge versions for development and regression testing. >>>> Signed-off-by: John Snow >>>> --- >>>> scripts/qapi/doc.py | 3 +- >>>> scripts/qapi/mypy.ini | 65 ++++++++++++++++++++++++++++++++++++++++++ >>>> scripts/qapi/schema.py | 3 +- >>>> 3 files changed, 69 insertions(+), 2 deletions(-) >>>> create mode 100644 scripts/qapi/mypy.ini >>>> >>>> diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py >>>> index cbf7076ed9..70f7cdfaa6 100644 >>>> --- a/scripts/qapi/doc.py >>>> +++ b/scripts/qapi/doc.py >>>> @@ -5,7 +5,8 @@ >>>> """This script produces the documentation of a qapi schema in texinfo format""" >>>> import re >>>> -from .gen import QAPIGenDoc, QAPISchemaVisitor >>>> +from .gen import QAPIGenDoc >>>> +from .schema import QAPISchemaVisitor >>> Your mypy doesn't like such lazy imports? Mine seems not to care. >>> >> >> Yeah, it specifically complained that no such definition existed in >> that file. > > I sense a certain wobbliness in mypy. Perhaps to be expected from a > tool with major version zero. There's a risk that developers' local > "make check" and our gating CI differ too much. We'll see. > It is indeed very cutting edge. It wasn't really viable to use until Python 3.6. >>>> >>>> MSG_FMT = """ >>>> diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini >>>> new file mode 100644 >>>> index 0000000000..a0f2365a53 >>>> --- /dev/null >>>> +++ b/scripts/qapi/mypy.ini >>>> @@ -0,0 +1,65 @@ >>>> +[mypy] >>>> +strict = True >>>> +strict_optional = False >>>> +disallow_untyped_calls = False >>>> +python_version = 3.6 >>>> + >>>> +[mypy-qapi.commands] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.doc] >>>> +disallow_subclassing_any = False >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> + >>>> +[mypy-qapi.error] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.events] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.expr] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.gen] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.introspect] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.parser] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.schema] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.source] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.types] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>>> + >>>> +[mypy-qapi.visit] >>>> +disallow_untyped_defs = False >>>> +disallow_incomplete_defs = False >>>> +check_untyped_defs = False >>> Greek to me. I'll learn in due time. >>> >> >> I am using these options: >> >> --strict, which is effectively -Wall. >> >> --no-strict-optional, which disables type checking errors on conflict >> between Optional[T] and T. Namely, when you initialize a class field >> to None and set that variable after initialization, callers must be >> prepared to see if that field was None or not. We do that effectively >> nowhere. >> >> As Python will surely explode in a noticeable way if we got an >> unexpected 'None', I am just suppressing these warnings "for now". > > Okay. > > We may want to rethink how we define and initialize these variables. We > initialize mostly to keep pylint happy. We initialize to None precisely > to make use before the real initialization explode. > The pattern we have is roughly correct; it's just that we rely on that implicit explosion, which mypy will warn about if I don't disable this option. It's not worth addressing in our first pass, but if you look at schema.py's @property ifcond code, that's the type of thing that would "fix" this warning -- basically access shims that add a "real" error message when it's None, but convert the return type from Optional[T] to T. It's later stuff. >> --allow-untyped-calls silences errors in files that have calls to >> functions in files I still have not typed. By the end of the series, >> this option goes away, because there's nothing untyped left. >> >> >> For each untyped file, we are actually starting with all of the above >> options and then layering these options on top. Any egregious typing >> errors present in these "ignored" files will be spotted. >> >> To get the bad files to pass, we only need three options: >> >> allow untyped defs -- Simply permits us to have functions without >> annotations. >> >> allow incomplete defs -- allows functions that are only partially typed. >> >> check untyped defs = False -- Don't try to type check untyped definitions. > > Thanks! > > [...] >