qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, John Snow <jsnow@redhat.com>
Subject: [PULL 06/13] qapi/parser: clarify _end_section() logic
Date: Sat,  2 Oct 2021 11:56:48 +0200	[thread overview]
Message-ID: <20211002095655.1944970-7-armbru@redhat.com> (raw)
In-Reply-To: <20211002095655.1944970-1-armbru@redhat.com>

From: John Snow <jsnow@redhat.com>

The "if self._section" clause in end_section is mysterious: In which
circumstances might we end a section when we don't have one?

QAPIDoc always expects there to be a "current section", only except
after a call to end_comment(). This actually *shouldn't* ever be 'None',
so let's remove that logic so I don't wonder why it's like this again in
three months.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210930205716.1148693-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/parser.py | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 23898ab1dc..82f1d952b1 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -718,13 +718,21 @@ def _start_section(self, name=None, indent=0):
         self.sections.append(self._section)
 
     def _end_section(self):
-        if self._section:
-            text = self._section.text = self._section.text.strip()
-            if self._section.name and (not text or text.isspace()):
-                raise QAPIParseError(
-                    self._parser,
-                    "empty doc section '%s'" % self._section.name)
-            self._section = None
+        assert self._section is not None
+
+        text = self._section.text = self._section.text.strip()
+
+        # Only the 'body' section is allowed to have an empty body.
+        # All other sections, including anonymous ones, must have text.
+        if self._section != self.body and not text:
+            # We do not create anonymous sections unless there is
+            # something to put in them; this is a parser bug.
+            assert self._section.name
+            raise QAPIParseError(
+                self._parser,
+                "empty doc section '%s'" % self._section.name)
+
+        self._section = None
 
     def _append_freeform(self, line):
         match = re.match(r'(@\S+:)', line)
-- 
2.31.1



  parent reply	other threads:[~2021-10-02 10:04 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-02  9:56 [PULL 00/13] QAPI patches patches for 2021-10-02 Markus Armbruster
2021-10-02  9:56 ` [PULL 01/13] qapi/pylintrc: ignore 'consider-using-f-string' warning Markus Armbruster
2021-10-02  9:56 ` [PULL 02/13] qapi/gen: use dict.items() to iterate over _modules Markus Armbruster
2021-10-02  9:56 ` [PULL 03/13] qapi/parser: fix unused check_args_section arguments Markus Armbruster
2021-10-02  9:56 ` [PULL 04/13] qapi: Add spaces after symbol declaration for consistency Markus Armbruster
2021-10-02  9:56 ` [PULL 05/13] qapi/parser: remove FIXME comment from _append_body_line Markus Armbruster
2021-10-02  9:56 ` Markus Armbruster [this message]
2021-10-02  9:56 ` [PULL 07/13] qapi/parser: Introduce NullSection Markus Armbruster
2021-10-02  9:56 ` [PULL 08/13] qapi/parser: add import cycle workaround Markus Armbruster
2021-10-02  9:56 ` [PULL 09/13] qapi/parser: add type hint annotations (QAPIDoc) Markus Armbruster
2021-10-02  9:56 ` [PULL 10/13] qapi/parser: Add FIXME for consolidating JSON-related types Markus Armbruster
2021-10-02  9:56 ` [PULL 11/13] qapi/parser: enable mypy checks Markus Armbruster
2021-10-02  9:56 ` [PULL 12/13] qapi/parser: Silence too-few-public-methods warning Markus Armbruster
2021-10-02  9:56 ` [PULL 13/13] qapi/parser: enable pylint checks Markus Armbruster
2021-10-02 20:31 ` [PULL 00/13] QAPI patches patches for 2021-10-02 Richard Henderson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211002095655.1944970-7-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).