[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 15/18] qapi/introspect.py: Add docstrings to _gen_tree and _tree_t
From: |
Markus Armbruster |
Subject: |
[PULL 15/18] qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit |
Date: |
Fri, 19 Feb 2021 15:49:36 +0100 |
From: John Snow <jsnow@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210216021809.134886-16-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Doc string improvements squashed in]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/introspect.py | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 05c1a196e9..15cce6854d 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -100,6 +100,15 @@ class Annotated(Generic[_ValueT]):
def _tree_to_qlit(obj: JSONValue,
level: int = 0,
dict_value: bool = False) -> str:
+ """
+ Convert the type tree into a QLIT C string, recursively.
+
+ :param obj: The value to convert.
+ This value may not be Annotated when dict_value is True.
+ :param level: The indentation level for this particular value.
+ :param dict_value: True when the value being processed belongs to a
+ dict key; which suppresses the output indent.
+ """
def indent(level: int) -> str:
return level * 4 * ' '
@@ -246,6 +255,17 @@ const QLitObject %(c_name)s = %(c_string)s;
def _gen_tree(self, name: str, mtype: str, obj: Dict[str, object],
ifcond: Sequence[str],
features: Optional[List[QAPISchemaFeature]]) -> None:
+ """
+ Build and append a SchemaInfo object to self._trees.
+
+ :param name: The SchemaInfo's name.
+ :param mtype: The SchemaInfo's meta-type.
+ :param obj: Additional SchemaInfo members, as appropriate for
+ the meta-type.
+ :param ifcond: Conditionals to apply to the SchemaInfo.
+ :param features: The SchemaInfo's features.
+ Will be omitted from the output if empty.
+ """
comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask:
--
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 <=
- [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, 2021/02/19
- [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