[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 05/18] qapi/introspect.py: guard against ifcond/comment misuse
From: |
Markus Armbruster |
Subject: |
[PULL 05/18] qapi/introspect.py: guard against ifcond/comment misuse |
Date: |
Fri, 19 Feb 2021 15:49:26 +0100 |
From: John Snow <jsnow@redhat.com>
_tree_to_qlit is called recursively on dict values (isolated from their
keys); at such a point in generating output it is too late to apply an
ifcond. Similarly, comments do not necessarily have a "tidy" place they
can be printed in such a circumstance.
Forbid this usage by renaming "suppress_first_indent" to "dict_value" to
emphasize that indents are suppressed only for the benefit of dict
values; then add an assertion assuring we do not pass ifcond/comments
in this case.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210216021809.134886-6-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Comment wrapped to conform to PEP 8]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/introspect.py | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 4749f65ea3..a111cec725 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -34,7 +34,7 @@ def _make_tree(obj, ifcond, extra=None):
return obj
-def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
+def _tree_to_qlit(obj, level=0, dict_value=False):
def indent(level):
return level * 4 * ' '
@@ -43,6 +43,13 @@ def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
ifobj, extra = obj
ifcond = extra.get('if')
comment = extra.get('comment')
+
+ # NB: _tree_to_qlit is called recursively on the values of a
+ # key:value pair; those values can't be decorated with
+ # comments or conditionals.
+ msg = "dict values cannot have attached comments or if-conditionals."
+ assert not dict_value, msg
+
ret = ''
if comment:
ret += indent(level) + '/* %s */\n' % comment
@@ -54,7 +61,7 @@ def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
return ret
ret = ''
- if not suppress_first_indent:
+ if not dict_value:
ret += indent(level)
if obj is None:
ret += 'QLIT_QNULL'
--
2.26.2
- [PULL 00/18] QAPI patches patches for 2021-02-18, Markus Armbruster, 2021/02/19
- [PULL 02/18] qapi/introspect.py: assert schema is not None, Markus Armbruster, 2021/02/19
- [PULL 11/18] qapi/introspect.py: improve _tree_to_qlit error message, Markus Armbruster, 2021/02/19
- [PULL 15/18] qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit, Markus Armbruster, 2021/02/19
- [PULL 12/18] qapi/introspect.py: improve readability of _tree_to_qlit, Markus Armbruster, 2021/02/19
- [PULL 05/18] qapi/introspect.py: guard against ifcond/comment misuse,
Markus Armbruster <=
- [PULL 18/18] qapi/introspect.py: set _gen_tree's default ifcond argument to (), Markus Armbruster, 2021/02/19
- [PULL 17/18] qapi/introspect.py: Type _gen_tree variants as Sequence[str], Markus Armbruster, 2021/02/19
- [PULL 01/18] qapi: Replace List[str] with Sequence[str] for ifcond, Markus Armbruster, 2021/02/19
- [PULL 13/18] qapi/introspect.py: remove _gen_variants helper, Markus Armbruster, 2021/02/19
- [PULL 08/18] qapi/introspect.py: Always define all 'extra' dict keys, Markus Armbruster, 2021/02/19
- [PULL 07/18] qapi/introspect.py: replace 'extra' dict with 'comment' argument, Markus Armbruster, 2021/02/19
- [PULL 06/18] qapi/introspect.py: Unify return type of _make_tree(), Markus Armbruster, 2021/02/19
- [PULL 09/18] qapi/introspect.py: Introduce preliminary tree typing, Markus Armbruster, 2021/02/19
- [PULL 10/18] qapi/introspect.py: create a typed 'Annotated' data strutcure, Markus Armbruster, 2021/02/19
- [PULL 14/18] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/19