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=-13.5 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,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 BDDF1C433E0 for ; Wed, 24 Feb 2021 15:54:49 +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 2B7D664EC4 for ; Wed, 24 Feb 2021 15:54:49 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 2B7D664EC4 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]:55334 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lEwUy-0004eQ-2l for qemu-devel@archiver.kernel.org; Wed, 24 Feb 2021 10:54:48 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:51802) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lEwOV-0006ph-Nt for qemu-devel@nongnu.org; Wed, 24 Feb 2021 10:48:07 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:29397) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1lEwOS-0007HS-FF for qemu-devel@nongnu.org; Wed, 24 Feb 2021 10:48:07 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1614181683; 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=ZR/WJK5e8hQ7SrlUyIaNmguE76rj63iv2U+Q6Cw11OE=; b=hRSC8oiGLL5YxMEjlKIYD6GgGLnrcm9ajBzBxUmHxaBCCinKfGWbClup9d+4ivckNQ3xgt d0TrqrJ34nO4pWF6nU7S7CTlCFU3uxrAqB5kk9cLC0LnNs1NjwvnKiZSwfBMmkkCHJ54sS LMD0kA7XX8iKt0YVJLjy9EPzQqWpAn8= 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-518-F91jjI7bPauOmMgt3FThqw-1; Wed, 24 Feb 2021 10:48:00 -0500 X-MC-Unique: F91jjI7bPauOmMgt3FThqw-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 521198EF4A5; Wed, 24 Feb 2021 15:27:24 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-115-79.ams2.redhat.com [10.36.115.79]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 578465D9D3; Wed, 24 Feb 2021 15:27:22 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id DAF22113860F; Wed, 24 Feb 2021 16:27:20 +0100 (CET) From: Markus Armbruster To: John Snow Subject: Re: [PATCH v3 08/16] qapi/expr.py: add type hint annotations References: <20210223003408.964543-1-jsnow@redhat.com> <20210223003408.964543-9-jsnow@redhat.com> Date: Wed, 24 Feb 2021 16:27:20 +0100 In-Reply-To: <20210223003408.964543-9-jsnow@redhat.com> (John Snow's message of "Mon, 22 Feb 2021 19:34:00 -0500") Message-ID: <87y2fdzdt3.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.14 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=63.128.21.124; envelope-from=armbru@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 , Cleber Rosa , qemu-devel@nongnu.org, Eduardo Habkost 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. > > Signed-off-by: John Snow > Reviewed-by: Eduardo Habkost > Reviewed-by: Cleber Rosa > --- > scripts/qapi/expr.py | 71 ++++++++++++++++++++++++++++--------------- > scripts/qapi/mypy.ini | 5 --- > 2 files changed, 46 insertions(+), 30 deletions(-) > > diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py > index f45d6be1f4c..df6c64950fa 100644 > --- a/scripts/qapi/expr.py > +++ b/scripts/qapi/expr.py > @@ -15,7 +15,14 @@ > # See the COPYING file in the top-level directory. > > import re > -from typing import MutableMapping, Optional, cast > +from typing import ( > + Iterable, > + List, > + MutableMapping, > + Optional, > + Union, > + cast, > +) > > from .common import c_name > from .error import QAPISemError > @@ -23,9 +30,10 @@ > from .source import QAPISourceInfo > > > -# Expressions in their raw form are JSON-like structures with arbitrary forms. > -# Minimally, their top-level form must be a mapping of strings to values. > -Expression = MutableMapping[str, object] > +# Arbitrary form for a JSON-like object. > +_JSObject = MutableMapping[str, object] > +# Expressions in their raw form are (just) JSON-like objects. > +Expression = _JSObject Wat? > > > # Names must be letters, numbers, -, and _. They must start with letter, > @@ -35,14 +43,19 @@ > '[a-zA-Z][a-zA-Z0-9_-]*$') > > > -def check_name_is_str(name, info, source): > +def check_name_is_str(name: object, > + info: QAPISourceInfo, > + source: str) -> None: > if not isinstance(name, str): > raise QAPISemError(info, "%s requires a string name" % source) > > > -def check_name_str(name, info, source, > - allow_optional=False, enum_member=False, > - permit_upper=False): > +def check_name_str(name: str, > + info: QAPISourceInfo, > + source: str, > + allow_optional: bool = False, > + enum_member: bool = False, > + permit_upper: bool = False) -> None: > membername = name > > if allow_optional and name.startswith('*'): > @@ -62,16 +75,20 @@ def check_name_str(name, info, source, > assert not membername.startswith('*') > > > -def check_defn_name_str(name, info, meta): > +def check_defn_name_str(name: str, info: QAPISourceInfo, meta: str) -> None: > check_name_str(name, info, meta, permit_upper=True) > if name.endswith('Kind') or name.endswith('List'): > raise QAPISemError( > info, "%s name should not end in '%s'" % (meta, name[-4:])) > > > -def check_keys(value, info, source, required, optional): > +def check_keys(value: _JSObject, > + info: QAPISourceInfo, > + source: str, > + required: List[str], > + optional: List[str]) -> None: > > - def pprint(elems): > + def pprint(elems: Iterable[str]) -> str: > return ', '.join("'" + e + "'" for e in sorted(elems)) > > missing = set(required) - set(value) > @@ -91,7 +108,7 @@ def pprint(elems): > pprint(unknown), pprint(allowed))) > > > -def check_flags(expr, info): > +def check_flags(expr: Expression, info: QAPISourceInfo) -> None: > for key in ['gen', 'success-response']: > if key in expr and expr[key] is not False: > raise QAPISemError( > @@ -109,9 +126,9 @@ def check_flags(expr, info): > "are incompatible") > > > -def check_if(expr, info, source): > +def check_if(expr: _JSObject, info: QAPISourceInfo, source: str) -> None: > > - def check_if_str(ifcond): > + def check_if_str(ifcond: object) -> None: > if not isinstance(ifcond, str): > raise QAPISemError( > info, > @@ -137,7 +154,7 @@ def check_if_str(ifcond): > expr['if'] = [ifcond] > > > -def normalize_members(members): > +def normalize_members(members: object) -> None: > if isinstance(members, dict): > for key, arg in members.items(): > if isinstance(arg, dict): > @@ -145,8 +162,11 @@ def normalize_members(members): > members[key] = {'type': arg} > > > -def check_type(value, info, source, > - allow_array=False, allow_dict=False): > +def check_type(value: Optional[object], > + info: QAPISourceInfo, > + source: str, > + allow_array: bool = False, > + allow_dict: Union[bool, str] = False) -> None: > if value is None: > return > > @@ -190,7 +210,8 @@ def check_type(value, info, source, > check_type(arg['type'], info, key_source, allow_array=True) > > > -def check_features(features, info): > +def check_features(features: Optional[object], > + info: QAPISourceInfo) -> None: > if features is None: > return > if not isinstance(features, list): > @@ -207,7 +228,7 @@ def check_features(features, info): > check_if(f, info, source) > > > -def check_enum(expr, info): > +def check_enum(expr: Expression, info: QAPISourceInfo) -> None: > name = expr['enum'] > members = expr['data'] > prefix = expr.get('prefix') > @@ -231,7 +252,7 @@ def check_enum(expr, info): > check_if(member, info, source) > > > -def check_struct(expr, info): > +def check_struct(expr: Expression, info: QAPISourceInfo) -> None: > name = cast(str, expr['struct']) # Asserted in check_exprs > members = expr['data'] > > @@ -239,7 +260,7 @@ def check_struct(expr, info): > check_type(expr.get('base'), info, "'base'") > > > -def check_union(expr, info): > +def check_union(expr: Expression, info: QAPISourceInfo) -> None: > name = cast(str, expr['union']) # Asserted in check_exprs > base = expr.get('base') > discriminator = expr.get('discriminator') > @@ -265,7 +286,7 @@ def check_union(expr, info): > check_type(value['type'], info, source, allow_array=not base) > > > -def check_alternate(expr, info): > +def check_alternate(expr: Expression, info: QAPISourceInfo) -> None: > members = expr['data'] > > if not members: > @@ -282,7 +303,7 @@ def check_alternate(expr, info): > check_type(value['type'], info, source) > > > -def check_command(expr, info): > +def check_command(expr: Expression, info: QAPISourceInfo) -> None: > args = expr.get('data') > rets = expr.get('returns') > boxed = expr.get('boxed', False) > @@ -293,7 +314,7 @@ def check_command(expr, info): > check_type(rets, info, "'returns'", allow_array=True) > > > -def check_event(expr, info): > +def check_event(expr: Expression, info: QAPISourceInfo) -> None: > args = expr.get('data') > boxed = expr.get('boxed', False) > > @@ -302,7 +323,7 @@ def check_event(expr, info): > check_type(args, info, "'data'", allow_dict=not boxed) > > > -def check_exprs(exprs): > +def check_exprs(exprs: List[_JSObject]) -> List[_JSObject]: > for expr_elem in exprs: > # Expression > assert isinstance(expr_elem['expr'], dict) > diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini > index 0a000d58b37..7797c834328 100644 > --- a/scripts/qapi/mypy.ini > +++ b/scripts/qapi/mypy.ini > @@ -8,11 +8,6 @@ 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.parser] > disallow_untyped_defs = False > disallow_incomplete_defs = False When to use _JSObject, and when Expression?