[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 06/13] qapi/parser: clarify _end_section() logic
From: |
John Snow |
Subject: |
[PATCH v4 06/13] qapi/parser: clarify _end_section() logic |
Date: |
Thu, 30 Sep 2021 16:57:09 -0400 |
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>
---
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 23898ab1dcd..82f1d952b13 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
- [PATCH v4 00/13] qapi: static typing conversion, pt5b, John Snow, 2021/09/30
- [PATCH v4 01/13] qapi/pylintrc: ignore 'consider-using-f-string' warning, John Snow, 2021/09/30
- [PATCH v4 02/13] qapi/gen: use dict.items() to iterate over _modules, John Snow, 2021/09/30
- [PATCH v4 04/13] qapi: Add spaces after symbol declaration for consistency, John Snow, 2021/09/30
- [PATCH v4 05/13] qapi/parser: remove FIXME comment from _append_body_line, John Snow, 2021/09/30
- [PATCH v4 03/13] qapi/parser: fix unused check_args_section arguments, John Snow, 2021/09/30
- [PATCH v4 06/13] qapi/parser: clarify _end_section() logic,
John Snow <=
- [PATCH v4 07/13] qapi/parser: Introduce NullSection, John Snow, 2021/09/30
- [PATCH v4 08/13] qapi/parser: add import cycle workaround, John Snow, 2021/09/30
- [PATCH v4 11/13] qapi/parser: enable mypy checks, John Snow, 2021/09/30
- [PATCH v4 10/13] qapi/parser: Add FIXME for consolidating JSON-related types, John Snow, 2021/09/30
- [PATCH v4 12/13] qapi/parser: Silence too-few-public-methods warning, John Snow, 2021/09/30
- [PATCH v4 13/13] qapi/parser: enable pylint checks, John Snow, 2021/09/30
- [PATCH v4 09/13] qapi/parser: add type hint annotations (QAPIDoc), John Snow, 2021/09/30