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.6 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 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 A94A0C433ED for ; Thu, 20 May 2021 15:10:19 +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 3053260C3D for ; Thu, 20 May 2021 15:10:19 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3053260C3D 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]:41764 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ljkJW-0002iW-7p for qemu-devel@archiver.kernel.org; Thu, 20 May 2021 11:10:18 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43082) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljkFQ-0003j0-P0 for qemu-devel@nongnu.org; Thu, 20 May 2021 11:06:04 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:57753) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljkFL-0005Q3-Pl for qemu-devel@nongnu.org; Thu, 20 May 2021 11:06:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1621523158; 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=Hz/PNyEUW5jul73FLBehXxNMzfWlmSCEWXq0VtrWGgU=; b=RmZtgHNUa9Gu9Np9TdcadX5jiFRDhLAFT/+G6zp2iP1dUkWHRykg6l5b0y+f9kCPw5Jkq3 48sIUAOE7nk1LETTvyjCxjv5Jrir6ghBkIZoznjqZZaJzBZJhGDIupKubNZqkTTQ1y49jR G3f9ftMx41FtsXhpglSwX/iOb+yJI3c= 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-391-VV_jbnrBO7uffUlyHygIRg-1; Thu, 20 May 2021 11:05:38 -0400 X-MC-Unique: VV_jbnrBO7uffUlyHygIRg-1 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 887C3107ACCA; Thu, 20 May 2021 15:05:37 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-114-17.ams2.redhat.com [10.36.114.17]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 32F1C19C71; Thu, 20 May 2021 15:05:37 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BFDEF113865F; Thu, 20 May 2021 17:05:35 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: [PATCH 3/6] qapi/parser.py: add type hint annotations (QAPIDoc) References: <20210519191718.3950330-1-jsnow@redhat.com> <20210519191718.3950330-4-jsnow@redhat.com> Date: Thu, 20 May 2021 17:05:35 +0200 In-Reply-To: <20210519191718.3950330-4-jsnow@redhat.com> (John Snow's message of "Wed, 19 May 2021 15:17:15 -0400") Message-ID: <87r1i14f9c.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.84 on 10.5.11.23 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-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 , 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 adds mostly annotations, but uses a TYPE_CHECKING runtime > check to conditionally import dependencies, which only triggers during > runs of mypy. > > Signed-off-by: John Snow > > --- > > TopLevelExpr, an idea from previous drafts, makes a return here in order > to give a semantic meaning to check_expr(). The type is intended to be > used more in forthcoming commits (pt5c), but I opted to include it now > instead of creating yet-another Dict[str, object] type hint that I would > forget to change later. There's just one use. Since you assure me it'll make sense later... > Signed-off-by: John Snow > --- > scripts/qapi/parser.py | 74 +++++++++++++++++++++++++----------------- > 1 file changed, 45 insertions(+), 29 deletions(-) > > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py > index 71e982bff57..fefe4c37f44 100644 > --- a/scripts/qapi/parser.py > +++ b/scripts/qapi/parser.py > @@ -18,6 +18,7 @@ > import os > import re > from typing import ( > + TYPE_CHECKING, > Dict, > List, > Optional, > @@ -30,6 +31,14 @@ > from .source import QAPISourceInfo > > > +if TYPE_CHECKING: > + # pylint: disable=cyclic-import > + from .schema import QAPISchemaFeature, QAPISchemaMember Oh boy :) Any ideas on how to clean this up later? > + > + > +#: Represents a single Top Level QAPI schema expression. > +TopLevelExpr = Dict[str, object] > + > # Return value alias for get_expr(). > _ExprValue = Union[List[object], Dict[str, object], str, bool] > > @@ -447,7 +456,8 @@ class QAPIDoc: > """ > > class Section: > - def __init__(self, parser, name=None, indent=0): > + def __init__(self, parser: QAPISchemaParser, > + name: Optional[str] = None, indent: int = 0): > # parser, for error messages about indentation > self._parser = parser > # optional section name (argument/member or section name) > @@ -459,7 +469,7 @@ def __init__(self, parser, name=None, indent=0): > def __bool__(self) -> bool: > return bool(self.name or self.text) > > - def append(self, line): > + def append(self, line: str) -> None: > # Strip leading spaces corresponding to the expected indent level > # Blank lines are always OK. > if line: > @@ -474,39 +484,40 @@ def append(self, line): > self.text += line.rstrip() + '\n' > > class ArgSection(Section): > - def __init__(self, parser, name, indent=0): > + def __init__(self, parser: QAPISchemaParser, > + name: Optional[str] = None, indent: int = 0): > super().__init__(parser, name, indent) > - self.member = None > + self.member: Optional['QAPISchemaMember'] = None > > - def connect(self, member): > + def connect(self, member: 'QAPISchemaMember') -> None: > self.member = member > > - def __init__(self, parser, info): > + def __init__(self, parser: QAPISchemaParser, info: QAPISourceInfo): > # self._parser is used to report errors with QAPIParseError. The > # resulting error position depends on the state of the parser. > # It happens to be the beginning of the comment. More or less > # servicable, but action at a distance. > self._parser = parser > self.info = info > - self.symbol = None > + self.symbol: Optional[str] = None > self.body = QAPIDoc.Section(parser) > # dict mapping parameter name to ArgSection > - self.args = OrderedDict() > - self.features = OrderedDict() > + self.args: Dict[str, QAPIDoc.ArgSection] = OrderedDict() > + self.features: Dict[str, QAPIDoc.ArgSection] = OrderedDict() > # a list of Section > - self.sections = [] > + self.sections: List[QAPIDoc.Section] = [] > # the current section > self._section = self.body > self._append_line = self._append_body_line > > - def has_section(self, name): > + def has_section(self, name: str) -> bool: > """Return True if we have a section with this name.""" > for i in self.sections: > if i.name == name: > return True > return False > > - def append(self, line): > + def append(self, line: str) -> None: > """ > Parse a comment line and add it to the documentation. > > @@ -527,18 +538,18 @@ def append(self, line): > line = line[1:] > self._append_line(line) > > - def end_comment(self): > + def end_comment(self) -> None: > self._end_section() > > @staticmethod > - def _is_section_tag(name): > + def _is_section_tag(name: str) -> bool: > return name in ('Returns:', 'Since:', > # those are often singular or plural > 'Note:', 'Notes:', > 'Example:', 'Examples:', > 'TODO:') > > - def _append_body_line(self, line): > + def _append_body_line(self, line: str) -> None: > """ > Process a line of documentation text in the body section. > > @@ -578,7 +589,7 @@ def _append_body_line(self, line): > # This is a free-form documentation block > self._append_freeform(line) > > - def _append_args_line(self, line): > + def _append_args_line(self, line: str) -> None: > """ > Process a line of documentation text in an argument section. > > @@ -624,7 +635,7 @@ def _append_args_line(self, line): > > self._append_freeform(line) > > - def _append_features_line(self, line): > + def _append_features_line(self, line: str) -> None: > name = line.split(' ', 1)[0] > > if name.startswith('@') and name.endswith(':'): > @@ -656,7 +667,7 @@ def _append_features_line(self, line): > > self._append_freeform(line) > > - def _append_various_line(self, line): > + def _append_various_line(self, line: str) -> None: > """ > Process a line of documentation text in an additional section. > > @@ -692,7 +703,11 @@ def _append_various_line(self, line): > > self._append_freeform(line) > > - def _start_symbol_section(self, symbols_dict, name, indent): > + def _start_symbol_section( > + self, > + symbols_dict: Dict[str, 'QAPIDoc.ArgSection'], Sure we need to quote QAPIDoc.ArgSection here? > + name: str, > + indent: int) -> None: > # FIXME invalid names other than the empty string aren't flagged > if not name: > raise QAPIParseError(self._parser, "invalid parameter name") > @@ -704,13 +719,14 @@ def _start_symbol_section(self, symbols_dict, name, indent): > self._section = QAPIDoc.ArgSection(self._parser, name, indent) > symbols_dict[name] = self._section > > - def _start_args_section(self, name, indent): > + def _start_args_section(self, name: str, indent: int) -> None: > self._start_symbol_section(self.args, name, indent) > > - def _start_features_section(self, name, indent): > + def _start_features_section(self, name: str, indent: int) -> None: > self._start_symbol_section(self.features, name, indent) > > - def _start_section(self, name=None, indent=0): > + def _start_section(self, name: Optional[str] = None, > + indent: int = 0) -> None: > if name in ('Returns', 'Since') and self.has_section(name): > raise QAPIParseError(self._parser, > "duplicated '%s' section" % name) > @@ -718,7 +734,7 @@ def _start_section(self, name=None, indent=0): > self._section = QAPIDoc.Section(self._parser, name, indent) > self.sections.append(self._section) > > - def _end_section(self): > + def _end_section(self) -> None: > if self._section: > text = self._section.text = self._section.text.strip() > if self._section.name and (not text or text.isspace()): > @@ -727,7 +743,7 @@ def _end_section(self): > "empty doc section '%s'" % self._section.name) > self._section = QAPIDoc.Section(self._parser) > > - def _append_freeform(self, line): > + def _append_freeform(self, line: str) -> None: > match = re.match(r'(@\S+:)', line) > if match: > raise QAPIParseError(self._parser, > @@ -735,28 +751,28 @@ def _append_freeform(self, line): > % match.group(1)) > self._section.append(line) > > - def connect_member(self, member): > + def connect_member(self, member: 'QAPISchemaMember') -> None: Sure we need to quote QAPISchemaMember here? > if member.name not in self.args: > # Undocumented TODO outlaw > self.args[member.name] = QAPIDoc.ArgSection(self._parser, > member.name) > self.args[member.name].connect(member) > > - def connect_feature(self, feature): > + def connect_feature(self, feature: 'QAPISchemaFeature') -> None: Sure we need to quote QAPISchemaFeature here? > if feature.name not in self.features: > raise QAPISemError(feature.info, > "feature '%s' lacks documentation" > % feature.name) > self.features[feature.name].connect(feature) > > - def check_expr(self, expr): > + def check_expr(self, expr: TopLevelExpr) -> None: > if self.has_section('Returns') and 'command' not in expr: > raise QAPISemError(self.info, > "'Returns:' is only valid for commands") > > - def check(self): > + def check(self) -> None: > > - def check_args_section(args): > + def check_args_section(args: Dict[str, QAPIDoc.ArgSection]) -> None: > bogus = [name for name, section in args.items() > if not section.member] > if bogus: