[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 15/19] qapi/introspect.py: Add docstrings to _gen_tree and _tr
From: |
John Snow |
Subject: |
[PATCH v6 15/19] qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit |
Date: |
Mon, 15 Feb 2021 21:18:05 -0500 |
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 45284af1330..5d4f5e23f7e 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -99,6 +99,15 @@ def __init__(self, value: _ValueT, ifcond: Iterable[str],
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 * ' '
@@ -244,6 +253,15 @@ def _gen_features(features: List[QAPISchemaFeature]
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 entity's name.
+ :param mtype: The entity's meta-type.
+ :param obj: Additional entity fields, as appropriate for the meta-type.
+ :param ifcond: Sequence of conditionals that apply to this entity.
+ :param features: Optional features field for SchemaInfo.
+ """
comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask:
--
2.29.2
- [PATCH v6 11/19] qapi/introspect.py: improve _tree_to_qlit error message, (continued)
- [PATCH v6 11/19] qapi/introspect.py: improve _tree_to_qlit error message, John Snow, 2021/02/15
- [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, John Snow, 2021/02/15
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/16
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/16
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, John Snow, 2021/02/16
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/16
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, John Snow, 2021/02/16
- Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/17
Re: [PATCH v6 14/19] qapi/introspect.py: add type hint annotations, Markus Armbruster, 2021/02/18
[PATCH v6 15/19] qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit,
John Snow <=
[PATCH v6 17/19] qapi/introspect.py: Type _gen_tree variants as Sequence[str], John Snow, 2021/02/15
[PATCH v6 07/19] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2021/02/15
[PATCH v6 10/19] qapi/introspect.py: create a typed 'Annotated' data strutcure, John Snow, 2021/02/15