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 76AC3C47095 for ; Wed, 7 Oct 2020 12:24:11 +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 C98EA20789 for ; Wed, 7 Oct 2020 12:24:10 +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="U27VNOs2" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C98EA20789 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]:44814 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kQ8UL-0002Of-OS for qemu-devel@archiver.kernel.org; Wed, 07 Oct 2020 08:24:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:40792) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kQ8S2-0000eb-FD for qemu-devel@nongnu.org; Wed, 07 Oct 2020 08:21:47 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:44348) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kQ8Rw-0004V6-0p for qemu-devel@nongnu.org; Wed, 07 Oct 2020 08:21:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602073293; 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=X/om/HOGFBqbvplgykHTLxX+SAESpVu96DuilRjaw/g=; b=U27VNOs28QDylfCqSlay6lIprZxAKnzwDGZsQLrmBCO4zqlz6boVP2ELlgOfwDmde3GQ3J hBUvYUEh1vBCpbealN0a8x4CvpF04T5chMx1bQTQPKOiOBpaFQqTrkTwUdnTZWKq2+N/mR x0QTzZvf7v6y36+ixDFZUEjyfy5+QIo= 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-93-wihlv9KcMS-yI-_Fn6PM0g-1; Wed, 07 Oct 2020 08:21:31 -0400 X-MC-Unique: wihlv9KcMS-yI-_Fn6PM0g-1 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 F096F57001 for ; Wed, 7 Oct 2020 12:21:30 +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 1E3378CD44; Wed, 7 Oct 2020 12:21:05 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 9BE2711329C1; Wed, 7 Oct 2020 14:21:03 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: [PATCH v5 27/36] qapi/gen.py: add type hint annotations References: <20201005195158.2348217-1-jsnow@redhat.com> <20201005195158.2348217-28-jsnow@redhat.com> Date: Wed, 07 Oct 2020 14:21:03 +0200 In-Reply-To: <20201005195158.2348217-28-jsnow@redhat.com> (John Snow's message of "Mon, 5 Oct 2020 15:51:49 -0400") Message-ID: <875z7mcjm8.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.11 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. > > Signed-off-by: John Snow > Reviewed-by: Eduardo Habkost > Reviewed-by: Cleber Rosa > --- > scripts/qapi/gen.py | 104 ++++++++++++++++++++++++-------------------- > 1 file changed, 57 insertions(+), 47 deletions(-) > > diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py > index 1bad37fc06b..d0391cd8718 100644 > --- a/scripts/qapi/gen.py > +++ b/scripts/qapi/gen.py > @@ -17,7 +17,13 @@ > import errno > import os > import re > -from typing import Optional > +from typing import ( > + Dict, > + Iterator, > + List, > + Optional, > + Tuple, > +) > > from .common import ( > c_fname, > @@ -29,31 +35,31 @@ > mcgen, > ) > from .schema import QAPISchemaObjectType, QAPISchemaVisitor > +from .source import QAPISourceInfo > > > class QAPIGen: > - > - def __init__(self, fname): > + def __init__(self, fname: Optional[str]): I'd expect fname: str. Can you point me to the spot that passes None? > self.fname = fname > self._preamble = '' > self._body = '' > > - def preamble_add(self, text): > + def preamble_add(self, text: str) -> None: > self._preamble += text > > - def add(self, text): > + def add(self, text: str) -> None: > self._body += text > > - def get_content(self): > + def get_content(self) -> str: > return self._top() + self._preamble + self._body + self._bottom() > > - def _top(self): > + def _top(self) -> str: > return '' > > - def _bottom(self): > + def _bottom(self) -> str: > return '' > > - def write(self, output_dir): > + def write(self, output_dir: str) -> None: > # Include paths starting with ../ are used to reuse modules of the main > # schema in specialised schemas. Don't overwrite the files that are > # already generated for the main schema. > @@ -78,7 +84,7 @@ def write(self, output_dir): > f.close() > > > -def _wrap_ifcond(ifcond, before, after): > +def _wrap_ifcond(ifcond: List[str], before: str, after: str) -> str: > if before == after: > return after # suppress empty #if ... #endif > > @@ -118,40 +124,38 @@ def build_params(arg_type: Optional[QAPISchemaObjectType], > > > class QAPIGenCCode(QAPIGen): > - > - def __init__(self, fname): > + def __init__(self, fname: Optional[str]): Likewise. > super().__init__(fname) > - self._start_if = None > + self._start_if: Optional[Tuple[List[str], str, str]] = None > > - def start_if(self, ifcond): > + def start_if(self, ifcond: List[str]) -> None: > assert self._start_if is None > self._start_if = (ifcond, self._body, self._preamble) > > - def end_if(self): > + def end_if(self) -> None: > assert self._start_if > self._wrap_ifcond() > self._start_if = None > > - def _wrap_ifcond(self): > + def _wrap_ifcond(self) -> None: > self._body = _wrap_ifcond(self._start_if[0], > self._start_if[1], self._body) > self._preamble = _wrap_ifcond(self._start_if[0], > self._start_if[2], self._preamble) > > - def get_content(self): > + def get_content(self) -> str: > assert self._start_if is None > return super().get_content() > > > class QAPIGenC(QAPIGenCCode): > - > - def __init__(self, fname, blurb, pydoc): > + def __init__(self, fname: str, blurb: str, pydoc: str): Here it's just str. > super().__init__(fname) > self._blurb = blurb > self._copyright = '\n * '.join(re.findall(r'^Copyright .*', pydoc, > re.MULTILINE)) > > - def _top(self): > + def _top(self) -> str: > return mcgen(''' > /* AUTOMATICALLY GENERATED, DO NOT MODIFY */ > > @@ -167,7 +171,7 @@ def _top(self): > ''', > blurb=self._blurb, copyright=self._copyright) > > - def _bottom(self): > + def _bottom(self) -> str: > return mcgen(''' > > /* Dummy declaration to prevent empty .o file */ > @@ -177,16 +181,15 @@ def _bottom(self): > > > class QAPIGenH(QAPIGenC): > - > - def _top(self): > + def _top(self) -> str: > return super()._top() + guardstart(self.fname) > > - def _bottom(self): > + def _bottom(self) -> str: > return guardend(self.fname) > > > @contextmanager > -def ifcontext(ifcond, *args): > +def ifcontext(ifcond: List[str], *args: QAPIGenCCode) -> Iterator[None]: Oh, the type hint for a *args is QAPIGenCCode, even though args is a tuple of excess positional arguments (which are all QAPIGenCCode). > """ > A with-statement context manager that wraps with `start_if()` / `end_if()`. > > @@ -214,8 +217,11 @@ def ifcontext(ifcond, *args): > > > class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor): > - > - def __init__(self, prefix, what, blurb, pydoc): > + def __init__(self, > + prefix: str, > + what: str, > + blurb: str, > + pydoc: str): > self._prefix = prefix > self._what = what > self._genc = QAPIGenC(self._prefix + self._what + '.c', > @@ -223,38 +229,42 @@ def __init__(self, prefix, what, blurb, pydoc): > self._genh = QAPIGenH(self._prefix + self._what + '.h', > blurb, pydoc) > > - def write(self, output_dir): > + def write(self, output_dir: str) -> None: > self._genc.write(output_dir) > self._genh.write(output_dir) > > > class QAPISchemaModularCVisitor(QAPISchemaVisitor): > - > - def __init__(self, prefix, what, user_blurb, builtin_blurb, pydoc): > + def __init__(self, > + prefix: str, > + what: str, > + user_blurb: str, > + builtin_blurb: Optional[str], > + pydoc: str): > self._prefix = prefix > self._what = what > self._user_blurb = user_blurb > self._builtin_blurb = builtin_blurb > self._pydoc = pydoc > - self._genc = None > - self._genh = None > - self._module = {} > - self._main_module = None > + self._genc: Optional[QAPIGenC] = None > + self._genh: Optional[QAPIGenH] = None > + self._module: Dict[Optional[str], Tuple[QAPIGenC, QAPIGenH]] = {} > + self._main_module: Optional[str] = None > > @staticmethod > - def _is_user_module(name): > + def _is_user_module(name: Optional[str]) -> bool: > return bool(name and not name.startswith('./')) > > @staticmethod > - def _is_builtin_module(name): > + def _is_builtin_module(name: Optional[str]) -> bool: > return not name > > - def _module_dirname(self, what, name): > + def _module_dirname(self, what: str, name: Optional[str]) -> str: > if self._is_user_module(name): > return os.path.dirname(name) > return '' > > - def _module_basename(self, what, name): > + def _module_basename(self, what: str, name: Optional[str]) -> str: > ret = '' if self._is_builtin_module(name) else self._prefix > if self._is_user_module(name): > basename = os.path.basename(name) > @@ -266,27 +276,27 @@ def _module_basename(self, what, name): > ret += re.sub(r'-', '-' + name + '-', what) > return ret > > - def _module_filename(self, what, name): > + def _module_filename(self, what: str, name: Optional[str]) -> str: > return os.path.join(self._module_dirname(what, name), > self._module_basename(what, name)) > > - def _add_module(self, name, blurb): > + def _add_module(self, name: Optional[str], blurb: str) -> None: > basename = self._module_filename(self._what, name) > genc = QAPIGenC(basename + '.c', blurb, self._pydoc) > genh = QAPIGenH(basename + '.h', blurb, self._pydoc) > self._module[name] = (genc, genh) > self._genc, self._genh = self._module[name] > > - def _add_user_module(self, name, blurb): > + def _add_user_module(self, name: str, blurb: str) -> None: > assert self._is_user_module(name) > if self._main_module is None: > self._main_module = name > self._add_module(name, blurb) > > - def _add_system_module(self, name, blurb): > + def _add_system_module(self, name: Optional[str], blurb: str) -> None: > self._add_module(name and './' + name, blurb) > > - def write(self, output_dir, opt_builtins=False): > + def write(self, output_dir: str, opt_builtins: bool = False) -> None: > for name in self._module: > if self._is_builtin_module(name) and not opt_builtins: > continue > @@ -294,13 +304,13 @@ def write(self, output_dir, opt_builtins=False): > genc.write(output_dir) > genh.write(output_dir) > > - def _begin_system_module(self, name): > + def _begin_system_module(self, name: None) -> None: I figure the type hint None signals a simplifcation opportunity. No need to worry about it now. > pass > > - def _begin_user_module(self, name): > + def _begin_user_module(self, name: str) -> None: > pass > > - def visit_module(self, name): > + def visit_module(self, name: Optional[str]) -> None: > if name is None: > if self._builtin_blurb: > self._add_system_module(None, self._builtin_blurb) > @@ -314,7 +324,7 @@ def visit_module(self, name): > self._add_user_module(name, self._user_blurb) > self._begin_user_module(name) > > - def visit_include(self, name, info): > + def visit_include(self, name: str, info: QAPISourceInfo) -> None: > relname = os.path.relpath(self._module_filename(self._what, name), > os.path.dirname(self._genh.fname)) > self._genh.preamble_add(mcgen('''