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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 7371CC77B7D for ; Wed, 10 May 2023 08:13:14 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pwew4-0008Mu-34; Wed, 10 May 2023 04:12:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pwew2-0008M1-2n for qemu-devel@nongnu.org; Wed, 10 May 2023 04:12:30 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pwew0-00061x-9e for qemu-devel@nongnu.org; Wed, 10 May 2023 04:12:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1683706347; 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=nV35MzSFtc7uPxX12V1mXV6FzoJL+dUkE5FFH6OC+io=; b=Cc5OD8KpTBQAyZXZJy4iwQTJ0fkx2/Mu6yzgJuqw2oUHN6JxOpcgrS5c6juc3SVZhsVu6b CZ1u/o5kkNr+1dJseGvTUvNeIT15Da09QwqA+psAW71ZIp9+EyhEB0EMOt6udQqsclSqEF 8tKbRiO3CWYTm/6EADUBBh0pd10FuM4= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-631-44nKmaqdMTClqlznYupKXw-1; Wed, 10 May 2023 04:12:26 -0400 X-MC-Unique: 44nKmaqdMTClqlznYupKXw-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E9C7C100F650; Wed, 10 May 2023 08:12:25 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.121]) by smtp.corp.redhat.com (Postfix) with ESMTPS id A883B2166B29; Wed, 10 May 2023 08:12:25 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6F1F821E692E; Wed, 10 May 2023 10:12:24 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: richard.henderson@linaro.org, Juan Quintela Subject: [PULL v2 12/17] qapi: Rewrite parsing of doc comment section symbols and tags Date: Wed, 10 May 2023 10:12:22 +0200 Message-Id: <20230510081224.3588673-2-armbru@redhat.com> In-Reply-To: <20230510081224.3588673-1-armbru@redhat.com> References: <20230510081224.3588673-1-armbru@redhat.com> MIME-Version: 1.0 Content-type: text/plain Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.1 on 10.11.54.6 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com 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, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org To recognize a line starting with a section symbol and or tag, we first split it at the first space, then examine the part left of the space. We can just as well examine the unsplit line, so do that. Signed-off-by: Markus Armbruster Message-Id: <20230428105429.1687850-13-armbru@redhat.com> Reviewed-by: Juan Quintela [Work around lack of walrus operator in Python 3.7 and older] --- scripts/qapi/parser.py | 55 +++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index ddc14ceaba..a4ff9b6dbf 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -560,12 +560,12 @@ def end_comment(self) -> None: self._switch_section(QAPIDoc.NullSection(self._parser)) @staticmethod - def _is_section_tag(name: str) -> bool: - return name in ('Returns:', 'Since:', - # those are often singular or plural - 'Note:', 'Notes:', - 'Example:', 'Examples:', - 'TODO:') + def _match_at_name_colon(string: str) -> re.Match: + return re.match(r'@([^:]*): *', string) + + @staticmethod + def _match_section_tag(string: str) -> re.Match: + return re.match(r'(Returns|Since|Notes?|Examples?|TODO): *', string) def _append_body_line(self, line: str) -> None: """ @@ -581,7 +581,6 @@ def _append_body_line(self, line: str) -> None: Else, append the line to the current section. """ - name = line.split(' ', 1)[0] # FIXME not nice: things like '# @foo:' and '# @foo: ' aren't # recognized, and get silently treated as ordinary text if not self.symbol and not self.body.text and line.startswith('@'): @@ -595,12 +594,12 @@ def _append_body_line(self, line: str) -> None: self._parser, "name required after '@'") elif self.symbol: # This is a definition documentation block - if name.startswith('@') and name.endswith(':'): + if self._match_at_name_colon(line): self._append_line = self._append_args_line self._append_args_line(line) elif line == 'Features:': self._append_line = self._append_features_line - elif self._is_section_tag(name): + elif self._match_section_tag(line): self._append_line = self._append_various_line self._append_various_line(line) else: @@ -621,16 +620,16 @@ def _append_args_line(self, line: str) -> None: Else, append the line to the current section. """ - name = line.split(' ', 1)[0] - - if name.startswith('@') and name.endswith(':'): + match = self._match_at_name_colon(line) + if match: # If line is "@arg: first line of description", find # the index of 'f', which is the indent we expect for any # following lines. We then remove the leading "@arg:" # from line and replace it with spaces so that 'f' has the # same index as it did in the original line and can be # handled the same way we will handle following lines. - indent = must_match(r'@\S*:\s*', line).end() + name = match.group(1) + indent = match.end() line = line[indent:] if not line: # Line was just the "@arg:" header @@ -638,8 +637,8 @@ def _append_args_line(self, line: str) -> None: indent = -1 else: line = ' ' * indent + line - self._start_args_section(name[1:-1], indent) - elif self._is_section_tag(name): + self._start_args_section(name, indent) + elif self._match_section_tag(line): self._append_line = self._append_various_line self._append_various_line(line) return @@ -656,16 +655,16 @@ def _append_args_line(self, line: str) -> None: self._append_freeform(line) def _append_features_line(self, line: str) -> None: - name = line.split(' ', 1)[0] - - if name.startswith('@') and name.endswith(':'): + match = self._match_at_name_colon(line) + if match: # If line is "@arg: first line of description", find # the index of 'f', which is the indent we expect for any # following lines. We then remove the leading "@arg:" # from line and replace it with spaces so that 'f' has the # same index as it did in the original line and can be # handled the same way we will handle following lines. - indent = must_match(r'@\S*:\s*', line).end() + name = match.group(1) + indent = match.end() line = line[indent:] if not line: # Line was just the "@arg:" header @@ -673,8 +672,8 @@ def _append_features_line(self, line: str) -> None: indent = -1 else: line = ' ' * indent + line - self._start_features_section(name[1:-1], indent) - elif self._is_section_tag(name): + self._start_features_section(name, indent) + elif self._match_section_tag(line): self._append_line = self._append_various_line self._append_various_line(line) return @@ -698,13 +697,13 @@ def _append_various_line(self, line: str) -> None: Else, append the line to the current section. """ - name = line.split(' ', 1)[0] - - if name.startswith('@') and name.endswith(':'): + match = self._match_at_name_colon(line) + if match: raise QAPIParseError(self._parser, - "'%s' can't follow '%s' section" - % (name, self.sections[0].name)) - if self._is_section_tag(name): + "'@%s:' can't follow '%s' section" + % (match.group(1), self.sections[0].name)) + match = self._match_section_tag(line) + if match: # If line is "Section: first line of description", find # the index of 'f', which is the indent we expect for any # following lines. We then remove the leading "Section:" @@ -719,7 +718,7 @@ def _append_various_line(self, line: str) -> None: indent = 0 else: line = ' ' * indent + line - self._start_section(name[:-1], indent) + self._start_section(match.group(1), indent) self._append_freeform(line) -- 2.39.2