From nobody Tue Jul 1 10:26:27 2025 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1621451493; cv=none; d=zohomail.com; s=zohoarc; b=KSAjEouZ1Xg98BqtvyKCJl8qkl1cE2IOzJhkKc8BmEZbWr6FugdScGC9PHwGKw6u5PV0ClSGTWeNT7XpJdo4oGKXLgL3R51fjz5lEFcAWym6frvjBc4pQBgnQ6ZGnZDPOZGv8gd+qrDNcTOKwqqFkviHNhyjdHJ3+QKht+AyffY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1621451493; 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=CaB/dKZi3LA71EToFZxutHlVaVmHVneNDElkORGEuDI=; b=h+17yTYk2COB5+3uu1p1LS7Yl6wlT9V2IczZGIYfI09YTEQuFk/3EIjh1Tx6BHGN7HaswrUh7+RRrmDM/GF2VT0AR+ZAbO0wkHjCepul/nPy4G/kDcP8RDODAalu0F+33JgWSrSzNDDW5qgotOvHIYyHgR75JP7ZO5OGF/aL1K8= 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+importer2=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 1621451493856854.3580013530768; Wed, 19 May 2021 12:11:33 -0700 (PDT) Received: from localhost ([::1]:44324 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ljRbQ-0003Cv-Ki for importer2@patchew.org; Wed, 19 May 2021 15:11:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55390) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljR7K-00067g-C0 for qemu-devel@nongnu.org; Wed, 19 May 2021 14:40:27 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:47750) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljR78-00025M-Fl for qemu-devel@nongnu.org; Wed, 19 May 2021 14:40:25 -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-303-zSc9SlF5OsGj90YO8vgqzw-1; Wed, 19 May 2021 14:40:10 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 74858501E8; Wed, 19 May 2021 18:40:09 +0000 (UTC) Received: from scv.redhat.com (ovpn-117-64.rdu2.redhat.com [10.10.117.64]) by smtp.corp.redhat.com (Postfix) with ESMTP id 67F6D50FA2; Wed, 19 May 2021 18:40:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1621449613; 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=CaB/dKZi3LA71EToFZxutHlVaVmHVneNDElkORGEuDI=; b=KAafdv6YT6iX8KBxZC2a9+Uujy5tshozp9/CU77t/tl2lVhG53Bqj42IDCnM6dxyNbf10t UdglRpSa/Uf0b5+FMnuUPns/YyGXFRmjMCBQZ6sSt0+oEQz9krhdJXuRF55GoYubhdHB9p moiRj/y1cr9T5+gkAVCcHrh8bd8QZ4Y= X-MC-Unique: zSc9SlF5OsGj90YO8vgqzw-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 12/15] qapi/parser: add type hint annotations Date: Wed, 19 May 2021 14:39:48 -0400 Message-Id: <20210519183951.3946870-13-jsnow@redhat.com> In-Reply-To: <20210519183951.3946870-1-jsnow@redhat.com> References: <20210519183951.3946870-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 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+importer2=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-Spam_score_int: -31 X-Spam_score: -3.2 X-Spam_bar: --- X-Spam_report: (-3.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.39, 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 , Cleber Rosa , John Snow , Eduardo Habkost , Markus Armbruster Errors-To: qemu-devel-bounces+importer2=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. (Annotations for QAPIDoc are in a forthcoming commit.) Signed-off-by: John Snow --- scripts/qapi/parser.py | 58 +++++++++++++++++++++++++++--------------- 1 file changed, 38 insertions(+), 20 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 8a58e1228f0..419e36c8702 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -17,16 +17,26 @@ from collections import OrderedDict import os import re -from typing import List +from typing import ( + Dict, + List, + Optional, + Set, + Union, +) =20 from .common import must_match from .error import QAPISemError, QAPISourceError from .source import QAPISourceInfo =20 =20 +# Return value alias for get_expr(). +_ExprValue =3D Union[List[object], Dict[str, object], str, bool] + + class QAPIParseError(QAPISourceError): """Error class for all QAPI schema parsing errors.""" - def __init__(self, parser, msg): + def __init__(self, parser: 'QAPISchemaParser', msg: str): col =3D 1 for ch in parser.src[parser.line_pos:parser.pos]: if ch =3D=3D '\t': @@ -38,7 +48,10 @@ def __init__(self, parser, msg): =20 class QAPISchemaParser: =20 - def __init__(self, fname, previously_included=3DNone, incl_info=3DNone= ): + def __init__(self, + fname: str, + previously_included: Optional[Set[str]] =3D None, + incl_info: Optional[QAPISourceInfo] =3D None): self._fname =3D fname self._included =3D previously_included or set() self._included.add(os.path.abspath(self._fname)) @@ -46,20 +59,20 @@ def __init__(self, fname, previously_included=3DNone, i= ncl_info=3DNone): =20 # Lexer state (see `accept` for details): self.info =3D QAPISourceInfo(self._fname, incl_info) - self.tok =3D None + self.tok: Union[None, str] =3D None self.pos =3D 0 self.cursor =3D 0 - self.val =3D None + self.val: Optional[Union[bool, str]] =3D None self.line_pos =3D 0 =20 # Parser output: - self.exprs =3D [] - self.docs =3D [] + self.exprs: List[Dict[str, object]] =3D [] + self.docs: List[QAPIDoc] =3D [] =20 # Showtime! self._parse() =20 - def _parse(self): + def _parse(self) -> None: cur_doc =3D None =20 # May raise OSError; allow the caller to handle it. @@ -125,7 +138,7 @@ def _parse(self): self.reject_expr_doc(cur_doc) =20 @staticmethod - def reject_expr_doc(doc): + def reject_expr_doc(doc: Optional['QAPIDoc']) -> None: if doc and doc.symbol: raise QAPISemError( doc.info, @@ -133,10 +146,14 @@ def reject_expr_doc(doc): % doc.symbol) =20 @staticmethod - def _include(include, info, incl_fname, previously_included): + def _include(include: str, + info: QAPISourceInfo, + incl_fname: str, + previously_included: Set[str] + ) -> Optional['QAPISchemaParser']: incl_abs_fname =3D os.path.abspath(incl_fname) # catch inclusion cycle - inf =3D info + inf: Optional[QAPISourceInfo] =3D info while inf: if incl_abs_fname =3D=3D os.path.abspath(inf.fname): raise QAPISemError(info, "inclusion loop for %s" % include) @@ -155,9 +172,9 @@ def _include(include, info, incl_fname, previously_incl= uded): ) from err =20 @staticmethod - def _pragma(name, value, info): + def _pragma(name: str, value: object, info: QAPISourceInfo) -> None: =20 - def check_list_str(name, value) -> List[str]: + def check_list_str(name: str, value: object) -> List[str]: if (not isinstance(value, list) or any([not isinstance(elt, str) for elt in value])): raise QAPISemError( @@ -181,7 +198,7 @@ def check_list_str(name, value) -> List[str]: else: raise QAPISemError(info, "unknown pragma '%s'" % name) =20 - def accept(self, skip_comment=3DTrue): + def accept(self, skip_comment: bool =3D True) -> None: while True: self.tok =3D self.src[self.cursor] self.pos =3D self.cursor @@ -245,8 +262,8 @@ def accept(self, skip_comment=3DTrue): self.src[self.cursor-1:]) raise QAPIParseError(self, "stray '%s'" % match.group(0)) =20 - def get_members(self): - expr =3D OrderedDict() + def get_members(self) -> Dict[str, object]: + expr: Dict[str, object] =3D OrderedDict() if self.tok =3D=3D '}': self.accept() return expr @@ -272,8 +289,8 @@ def get_members(self): if self.tok !=3D "'": raise QAPIParseError(self, "expected string") =20 - def get_values(self): - expr =3D [] + def get_values(self) -> List[object]: + expr: List[object] =3D [] if self.tok =3D=3D ']': self.accept() return expr @@ -289,7 +306,8 @@ def get_values(self): raise QAPIParseError(self, "expected ',' or ']'") self.accept() =20 - def get_expr(self): + def get_expr(self) -> _ExprValue: + expr: _ExprValue if self.tok =3D=3D '{': self.accept() expr =3D self.get_members() @@ -305,7 +323,7 @@ def get_expr(self): self, "expected '{', '[', string, or boolean") return expr =20 - def get_doc(self, info): + def get_doc(self, info: QAPISourceInfo) -> List['QAPIDoc']: if self.val !=3D '##': raise QAPIParseError( self, "junk after '##' at start of documentation comment") --=20 2.30.2