From nobody Mon Feb 9 07:55:15 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1602261116; cv=none; d=zohomail.com; s=zohoarc; b=WXW1ipuNHSi6NV1PK283hApJithWR+r28uSIRDnYV+F52V0fC6798S6lYui501Cy/L7mtcHY0LkKrR3h8fZUZUycPsNLP4vnWBDOQ6LuGHtOOC2jAMweSyqPFDxfkh/W3aonSMAMr5HSUu3oes7lnIOVYTv0/VeccY2HXdxCGFQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1602261116; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=UJq+HLT6QYFG43guFEY7AAqwPzkZedXznbKiUUzhshA=; b=cZFKuPTLmHjRdJxRTQ6sm6OiOQCS/OENWpTl1qSU8cvj+3jCvRTgUlmNv7HqN+SiEKb3/x5YUu/f26+uxUzchSfYKwjQQnAQx0POFjKs/OQV+wYDv13a39ahpz1Ez0OWLYthDD0KH0uwqmubZ5b+lVn1vRw9Qjm1V1t9WukHpo0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1602261116993766.4371985690237; Fri, 9 Oct 2020 09:31:56 -0700 (PDT) Received: from localhost ([::1]:49814 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kQvJC-0007gR-KC for importer@patchew.org; Fri, 09 Oct 2020 12:31:54 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:34690) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kQv4O-0004JN-Ih for qemu-devel@nongnu.org; Fri, 09 Oct 2020 12:16:36 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:25923) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kQv4M-0003K6-4a for qemu-devel@nongnu.org; Fri, 09 Oct 2020 12:16:36 -0400 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-595-olqv-7gDN0KvKlBTp9hzRA-1; Fri, 09 Oct 2020 12:16:31 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 84CF280B713; Fri, 9 Oct 2020 16:16:30 +0000 (UTC) Received: from scv.redhat.com (ovpn-112-203.rdu2.redhat.com [10.10.112.203]) by smtp.corp.redhat.com (Postfix) with ESMTP id C424219936; Fri, 9 Oct 2020 16:16:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602260193; 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=UJq+HLT6QYFG43guFEY7AAqwPzkZedXznbKiUUzhshA=; b=PEz6FfcyHt4WBx4fqfgl8BxwNpPj3oEIZorELBTHcIIX2H4q28HgQADqjF4o3BOPSqYKdR IkMW+AE8Jm6KZAtYKrJfQtdVaL39STkNb+BGE3wnOLpxyjj0uFkbwwU9MDvR3mF1MHju91 I0HPcfwG4wI87ms/h9KW3MBRZDc35w8= X-MC-Unique: olqv-7gDN0KvKlBTp9hzRA-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v6 24/36] qapi/source.py: add type hint annotations Date: Fri, 9 Oct 2020 12:15:46 -0400 Message-Id: <20201009161558.107041-25-jsnow@redhat.com> In-Reply-To: <20201009161558.107041-1-jsnow@redhat.com> References: <20201009161558.107041-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 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-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; 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/10/09 02:34:37 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_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: Michael Roth , John Snow , Markus Armbruster , Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" 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 | 32 +++++++++++++++++++------------- 2 files changed, 19 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 =3D False disallow_incomplete_defs =3D False check_untyped_defs =3D False =20 -[mypy-qapi.source] -disallow_untyped_defs =3D False -disallow_incomplete_defs =3D False -check_untyped_defs =3D False - [mypy-qapi.types] disallow_untyped_defs =3D False disallow_incomplete_defs =3D False diff --git a/scripts/qapi/source.py b/scripts/qapi/source.py index e97b9a8e15e..27af5295a85 100644 --- a/scripts/qapi/source.py +++ b/scripts/qapi/source.py @@ -11,37 +11,43 @@ =20 import copy import sys +from typing import List, Optional, TypeVar =20 =20 class QAPISchemaPragma: - def __init__(self): + def __init__(self) -> None: # Are documentation comments required? self.doc_required =3D False # Whitelist of commands allowed to return a non-dictionary - self.returns_whitelist =3D [] + self.returns_whitelist: List[str] =3D [] # Whitelist of entities allowed to violate case conventions - self.name_case_whitelist =3D [] + self.name_case_whitelist: List[str] =3D [] =20 =20 class QAPISourceInfo: - def __init__(self, fname, line, parent): + T =3D TypeVar('T', bound=3D'QAPISourceInfo') + + def __init__(self, fname: str, line: int, + parent: Optional['QAPISourceInfo']): self.fname =3D fname self.line =3D line self.parent =3D parent - self.pragma =3D parent.pragma if parent else QAPISchemaPragma() - self.defn_meta =3D None - self.defn_name =3D None + self.pragma: QAPISchemaPragma =3D ( + parent.pragma if parent else QAPISchemaPragma() + ) + self.defn_meta: Optional[str] =3D None + self.defn_name: Optional[str] =3D None =20 - def set_defn(self, meta, name): + def set_defn(self, meta: str, name: str) -> None: self.defn_meta =3D meta self.defn_name =3D name =20 - def next_line(self): + def next_line(self: T) -> T: info =3D copy.copy(self) info.line +=3D 1 return info =20 - def loc(self): + def loc(self) -> str: if self.fname is None: return sys.argv[0] ret =3D self.fname @@ -49,13 +55,13 @@ def loc(self): ret +=3D ':%d' % self.line return ret =20 - 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 '' =20 - def include_path(self): + def include_path(self) -> str: ret =3D '' parent =3D self.parent while parent: @@ -63,5 +69,5 @@ def include_path(self): parent =3D parent.parent return ret =20 - def __str__(self): + def __str__(self) -> str: return self.include_path() + self.in_defn() + self.loc() --=20 2.26.2