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=-9.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,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 6C7E8C41604 for ; Wed, 7 Oct 2020 11:56:36 +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 654B220789 for ; Wed, 7 Oct 2020 11:56:35 +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="cMiL9hcW" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 654B220789 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]:39642 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kQ83e-0000aQ-A8 for qemu-devel@archiver.kernel.org; Wed, 07 Oct 2020 07:56:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35130) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kQ82V-0008JQ-4x for qemu-devel@nongnu.org; Wed, 07 Oct 2020 07:55:23 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:44735) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kQ82Q-0001LW-30 for qemu-devel@nongnu.org; Wed, 07 Oct 2020 07:55:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602071716; 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: in-reply-to:in-reply-to:references:references; bh=c1NoVrI09JRbslAyZUEGLsOTawO0VJGEpO2dhQXcRC8=; b=cMiL9hcWeiQaSvcr1Vfw5EufyTz2rJAWDjYbEIzaDewkW0u5X3K4rCcSHQrcQxUEXWZ/qM k/rBwRyT9qkK9fLm/hL96v9mxFZHIXFafMzd9wzvpjVUDP5bxNRNmSX1x2u9baK7kQcZ5y +Zssi0RGRnKh8KWBLJJu0gJGNAzntFw= 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-361-6GWmAYpqNn2iR2LP6PzoEg-1; Wed, 07 Oct 2020 07:55:15 -0400 X-MC-Unique: 6GWmAYpqNn2iR2LP6PzoEg-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 2A150879516 for ; Wed, 7 Oct 2020 11:55:14 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-182.ams2.redhat.com [10.36.112.182]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C75E85C1BD; Wed, 7 Oct 2020 11:55:13 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 4A62411329C1; Wed, 7 Oct 2020 13:55:12 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: [PATCH v5 24/36] qapi/source.py: add type hint annotations References: <20201005195158.2348217-1-jsnow@redhat.com> <20201005195158.2348217-25-jsnow@redhat.com> Date: Wed, 07 Oct 2020 13:55:12 +0200 In-Reply-To: <20201005195158.2348217-25-jsnow@redhat.com> (John Snow's message of "Mon, 5 Oct 2020 15:51:46 -0400") Message-ID: <87lfgicktb.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) 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=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Received-SPF: pass client-ip=216.205.24.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/07 00:54:30 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.742, 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_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: qemu-devel@nongnu.org, Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" John Snow writes: > Annotations do not change runtime behavior. > This commit *only* adds annotations. > > A note on typing of __init__: mypy requires init functions with no > parameters to document a return type of None to be considered fully > typed. In the case when there are input parameters, None may be omitted. > > Since __init__ may never return any value, it is preferred to omit the > return annotation whenever possible. > > Signed-off-by: John Snow > Reviewed-by: Eduardo Habkost > Reviewed-by: Cleber Rosa > Tested-by: Cleber Rosa > --- > scripts/qapi/mypy.ini | 5 ----- > scripts/qapi/source.py | 31 ++++++++++++++++++------------- > 2 files changed, 18 insertions(+), 18 deletions(-) > > diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini > index 8ab9ac52cc4..1b8555dfa39 100644 > --- a/scripts/qapi/mypy.ini > +++ b/scripts/qapi/mypy.ini > @@ -34,11 +34,6 @@ 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 > diff --git a/scripts/qapi/source.py b/scripts/qapi/source.py > index e97b9a8e15e..1cc6a5b82dc 100644 > --- a/scripts/qapi/source.py > +++ b/scripts/qapi/source.py > @@ -11,37 +11,42 @@ > > import copy > import sys > +from typing import List, Optional, TypeVar > > > class QAPISchemaPragma: > - def __init__(self): > + def __init__(self) -> None: > # Are documentation comments required? > self.doc_required = False > # Whitelist of commands allowed to return a non-dictionary > - self.returns_whitelist = [] > + self.returns_whitelist: List[str] = [] > # Whitelist of entities allowed to violate case conventions > - self.name_case_whitelist = [] > + self.name_case_whitelist: List[str] = [] > > > class QAPISourceInfo: > - def __init__(self, fname, line, parent): > + T = TypeVar('T', bound='QAPISourceInfo') > + > + def __init__(self: T, fname: str, line: int, parent: Optional[T]): More ignorant questions (I'm abusing the review process to learn Python type hints)... Why do you need to annotate self here, but not elsewhere? Why do you use T instead of QAPISourceInfo? > self.fname = fname > self.line = line > self.parent = parent > - self.pragma = parent.pragma if parent else QAPISchemaPragma() > - self.defn_meta = None > - self.defn_name = None > + self.pragma: QAPISchemaPragma = ( > + parent.pragma if parent else QAPISchemaPragma() > + ) Type inference fail? > + self.defn_meta: Optional[str] = None > + self.defn_name: Optional[str] = None > > - def set_defn(self, meta, name): > + def set_defn(self, meta: str, name: str) -> None: > self.defn_meta = meta > self.defn_name = name > > - def next_line(self): > + def next_line(self: T) -> T: > info = copy.copy(self) > info.line += 1 > return info > > - def loc(self): > + def loc(self) -> str: > if self.fname is None: > return sys.argv[0] > ret = self.fname > @@ -49,13 +54,13 @@ def loc(self): > ret += ':%d' % self.line > return ret > > - def in_defn(self): > + def in_defn(self) -> str: > if self.defn_name: > return "%s: In %s '%s':\n" % (self.fname, > self.defn_meta, self.defn_name) > return '' > > - def include_path(self): > + def include_path(self) -> str: > ret = '' > parent = self.parent > while parent: > @@ -63,5 +68,5 @@ def include_path(self): > parent = parent.parent > return ret > > - def __str__(self): > + def __str__(self) -> str: > return self.include_path() + self.in_defn() + self.loc()