openkylin
/
qemu
mirror of https://gitee.com/openkylin/qemu.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit 

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>
This commit is contained in:
John Snow 2021-02-15 21:18:05 -05:00 committed by Markus Armbruster
parent 82b52f6b84
commit 5444dedfc7
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
scripts/qapi/introspect.py
View File

@ -100,6 +100,15 @@ def __init__(self, value: _ValueT, ifcond: Iterable[str],
def _tree_to_qlit(obj: JSONValue, def _tree_to_qlit(obj: JSONValue,
level: int = 0, level: int = 0,
dict_value: bool = False) -> str: 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: def indent(level: int) -> str:
return level * 4 * ' ' return level * 4 * ' '
@ -246,6 +255,17 @@ def _gen_features(features: List[QAPISchemaFeature]
def _gen_tree(self, name: str, mtype: str, obj: Dict[str, object], def _gen_tree(self, name: str, mtype: str, obj: Dict[str, object],
ifcond: Sequence[str], ifcond: Sequence[str],
features: Optional[List[QAPISchemaFeature]]) -> None: 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 comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'): if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask: if not self._unmask: