* [PATCH v3 00/13] qapi: static typing conversion, pt2
@ 2020-12-17 1:53 John Snow
2020-12-17 1:53 ` [PATCH v3 01/13] qapi/introspect.py: assert schema is not None John Snow
` (12 more replies)
0 siblings, 13 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Hi, this series adds static type hints to the QAPI module.
This is part two, and covers introspect.py.
Part 2: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt2
Everything: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt6
- Requires Python 3.6+
- Requires mypy 0.770 or newer (for type analysis only)
- Requires pylint 2.6.0 or newer (for lint checking only)
Type hints are added in patches that add *only* type hints and change no
other behavior. Any necessary changes to behavior to accommodate typing
are split out into their own tiny patches.
Every commit should pass with:
- flake8 qapi/
- pylint --rcfile=qapi/pylintrc qapi/
- mypy --config-file=qapi/mypy.ini qapi/
V3:
- Dropped all the R-Bs again...
- Re-re-ordered to put type annotations last again.
- Rebased on top of "pt1.5".
- Ensured compliance with strict-optional typing.
- Forgive me if I missed a specific critique;
I probably just lost it in the shuffle.
V2:
- Dropped all R-B from previous series; enough has changed.
- pt2 is now introspect.py, expr.py is pushed to pt3.
- Reworked again to have less confusing (?) type names
- Added an assertion to prevent future accidental breakage
John Snow (13):
qapi/introspect.py: assert schema is not None
qapi/introspect.py: use _make_tree for features nodes
qapi/introspect.py: add _gen_features helper
qapi/introspect.py: guard against ifcond/comment misuse
qapi/introspect.py: Unify return type of _make_tree()
qapi/introspect.py: replace 'extra' dict with 'comment' argument
qapi/introspect.py: Introduce preliminary tree typing
qapi/introspect.py: create a typed 'Annotated' data strutcure
qapi/introspect.py: improve _tree_to_qlit error message
qapi/introspect.py: improve readability of _tree_to_qlit
qapi/introspect.py: add type hint annotations
qapi/instrospect.py: add introspect.json dummy types
qapi/introspect.py: Add docstring to _tree_to_qlit
scripts/qapi/introspect.py | 309 ++++++++++++++++++++++++++-----------
scripts/qapi/mypy.ini | 5 -
scripts/qapi/schema.py | 2 +-
3 files changed, 219 insertions(+), 97 deletions(-)
--
2.26.2
^ permalink raw reply [flat|nested] 14+ messages in thread
* [PATCH v3 01/13] qapi/introspect.py: assert schema is not None
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes John Snow
` (11 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
The introspect visitor is stateful, but expects that it will have a
schema to refer to. Add assertions that state this.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index fafec94e022..43ab4be1f77 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -147,6 +147,8 @@ def _name(self, name):
return self._name_map[name]
def _use_type(self, typ):
+ assert self._schema is not None
+
# Map the various integer types to plain int
if typ.json_type() == 'int':
typ = self._schema.lookup_type('int')
@@ -225,6 +227,8 @@ def visit_alternate_type(self, name, info, ifcond, features, variants):
def visit_command(self, name, info, ifcond, features,
arg_type, ret_type, gen, success_response, boxed,
allow_oob, allow_preconfig, coroutine):
+ assert self._schema is not None
+
arg_type = arg_type or self._schema.the_empty_object_type
ret_type = ret_type or self._schema.the_empty_object_type
obj = {'arg-type': self._use_type(arg_type),
@@ -234,6 +238,7 @@ def visit_command(self, name, info, ifcond, features,
self._gen_tree(name, 'command', obj, ifcond, features)
def visit_event(self, name, info, ifcond, features, arg_type, boxed):
+ assert self._schema is not None
arg_type = arg_type or self._schema.the_empty_object_type
self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)},
ifcond, features)
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
2020-12-17 1:53 ` [PATCH v3 01/13] qapi/introspect.py: assert schema is not None John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 03/13] qapi/introspect.py: add _gen_features helper John Snow
` (10 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
At present, we open-code this in _make_tree itself; but if the structure
of the tree changes, this is brittle. Use an explicit recursive call to
_make_tree when appropriate to help keep the interior node typing
consistent.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 43ab4be1f77..3295a15c98e 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -30,7 +30,9 @@ def _make_tree(obj, ifcond, features, extra=None):
if ifcond:
extra['if'] = ifcond
if features:
- obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
+ obj['features'] = [
+ _make_tree(f.name, f.ifcond, None) for f in features
+ ]
if extra:
return (obj, extra)
return obj
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 03/13] qapi/introspect.py: add _gen_features helper
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
2020-12-17 1:53 ` [PATCH v3 01/13] qapi/introspect.py: assert schema is not None John Snow
2020-12-17 1:53 ` [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse John Snow
` (9 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
_make_tree might receive a dict (a SchemaInfo object) or some other type
(usually, a string) for its obj parameter. Adding features information
should arguably be performed by the caller at such a time when we know
the type of the object and don't have to re-interrogate it.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 3295a15c98e..4749f65ea3c 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -24,15 +24,11 @@
)
-def _make_tree(obj, ifcond, features, extra=None):
+def _make_tree(obj, ifcond, extra=None):
if extra is None:
extra = {}
if ifcond:
extra['if'] = ifcond
- if features:
- obj['features'] = [
- _make_tree(f.name, f.ifcond, None) for f in features
- ]
if extra:
return (obj, extra)
return obj
@@ -169,6 +165,10 @@ def _use_type(self, typ):
return '[' + self._use_type(typ.element_type) + ']'
return self._name(typ.name)
+ @staticmethod
+ def _gen_features(features):
+ return [_make_tree(f.name, f.ifcond) for f in features]
+
def _gen_tree(self, name, mtype, obj, ifcond, features):
extra = None
if mtype not in ('command', 'event', 'builtin', 'array'):
@@ -179,13 +179,17 @@ def _gen_tree(self, name, mtype, obj, ifcond, features):
name = self._name(name)
obj['name'] = name
obj['meta-type'] = mtype
- self._trees.append(_make_tree(obj, ifcond, features, extra))
+ if features:
+ obj['features'] = self._gen_features(features)
+ self._trees.append(_make_tree(obj, ifcond, extra))
def _gen_member(self, member):
obj = {'name': member.name, 'type': self._use_type(member.type)}
if member.optional:
obj['default'] = None
- return _make_tree(obj, member.ifcond, member.features)
+ if member.features:
+ obj['features'] = self._gen_features(member.features)
+ return _make_tree(obj, member.ifcond)
def _gen_variants(self, tag_name, variants):
return {'tag': tag_name,
@@ -193,7 +197,7 @@ def _gen_variants(self, tag_name, variants):
def _gen_variant(self, variant):
obj = {'case': variant.name, 'type': self._use_type(variant.type)}
- return _make_tree(obj, variant.ifcond, None)
+ return _make_tree(obj, variant.ifcond)
def visit_builtin_type(self, name, info, json_type):
self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None)
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (2 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 03/13] qapi/introspect.py: add _gen_features helper John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree() John Snow
` (8 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
_tree_to_qlit is called recursively on dict values alone; 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.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 4749f65ea3c..ccdf4f1c0d0 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -43,6 +43,12 @@ def indent(level):
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 suppress_first_indent, msg
+
ret = ''
if comment:
ret += indent(level) + '/* %s */\n' % comment
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree()
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (3 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument John Snow
` (7 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Returning two different types conditionally can be complicated to
type. Return one type for consistency.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index ccdf4f1c0d0..d3fbf694ad2 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -29,9 +29,7 @@ def _make_tree(obj, ifcond, extra=None):
extra = {}
if ifcond:
extra['if'] = ifcond
- if extra:
- return (obj, extra)
- return obj
+ return (obj, extra)
def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (4 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree() John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing John Snow
` (6 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
This is only used to pass in a dictionary with a comment already set, so
skip the runaround and just accept the comment.
This works because _tree_to_qlit() treats 'if': None; 'comment': None
exactly like absent 'if'; 'comment'.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index d3fbf694ad2..0aa3b77109f 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -10,6 +10,8 @@
See the COPYING file in the top-level directory.
"""
+from typing import Optional
+
from .common import (
c_name,
gen_endif,
@@ -24,11 +26,11 @@
)
-def _make_tree(obj, ifcond, extra=None):
- if extra is None:
- extra = {}
- if ifcond:
- extra['if'] = ifcond
+def _make_tree(obj, ifcond, comment=None):
+ extra = {
+ 'if': ifcond,
+ 'comment': comment,
+ }
return (obj, extra)
@@ -174,18 +176,18 @@ def _gen_features(features):
return [_make_tree(f.name, f.ifcond) for f in features]
def _gen_tree(self, name, mtype, obj, ifcond, features):
- extra = None
+ comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask:
# Output a comment to make it easy to map masked names
# back to the source when reading the generated output.
- extra = {'comment': '"%s" = %s' % (self._name(name), name)}
+ comment = f'"{self._name(name)}" = {name}'
name = self._name(name)
obj['name'] = name
obj['meta-type'] = mtype
if features:
obj['features'] = self._gen_features(features)
- self._trees.append(_make_tree(obj, ifcond, extra))
+ self._trees.append(_make_tree(obj, ifcond, comment))
def _gen_member(self, member):
obj = {'name': member.name, 'type': self._use_type(member.type)}
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (5 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure John Snow
` (5 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
The types will be used in forthcoming patches to add typing. These types
describe the layout and structure of the objects passed to
_tree_to_qlit, but lack the power to describe annotations until the next
commit.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 30 +++++++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 0aa3b77109f..b82efe16f6e 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -10,7 +10,13 @@
See the COPYING file in the top-level directory.
"""
-from typing import Optional
+from typing import (
+ Any,
+ Dict,
+ List,
+ Optional,
+ Union,
+)
from .common import (
c_name,
@@ -26,6 +32,28 @@
)
+# This module constructs a tree data structure that is used to
+# generate the introspection information for QEMU. It behaves similarly
+# to a JSON value.
+#
+# A complexity over JSON is that our values may or may not be annotated.
+#
+# Un-annotated values may be:
+# Scalar: str, bool, None.
+# Non-scalar: List, Dict
+# _value = Union[str, bool, None, Dict[str, TreeValue], List[TreeValue]]
+#
+# With optional annotations, the type of all values is:
+# TreeValue = Union[_value, Annotated[_value]]
+#
+# Sadly, mypy does not support recursive types, so we must approximate this.
+_stub = Any
+_scalar = Union[str, bool, None]
+_nonscalar = Union[Dict[str, _stub], List[_stub]]
+_value = Union[_scalar, _nonscalar]
+# TreeValue = Union[_value, 'Annotated[_value]']
+
+
def _make_tree(obj, ifcond, comment=None):
extra = {
'if': ifcond,
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (6 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message John Snow
` (4 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Presently, we use a tuple to attach a dict containing annotations
(comments and compile-time conditionals) to a tree node. This is
undesirable because dicts are difficult to strongly type; promoting it
to a real class allows us to name the values and types of the
annotations we are expecting.
In terms of typing, the Annotated<T> type serves as a generic container
where the annotated node's type is preserved, allowing for greater
specificity than we'd be able to provide without a generic.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 77 ++++++++++++++++++++++----------------
1 file changed, 44 insertions(+), 33 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index b82efe16f6e..2b90a52f016 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -13,8 +13,12 @@
from typing import (
Any,
Dict,
+ Generic,
+ Iterable,
List,
Optional,
+ Tuple,
+ TypeVar,
Union,
)
@@ -51,15 +55,25 @@
_scalar = Union[str, bool, None]
_nonscalar = Union[Dict[str, _stub], List[_stub]]
_value = Union[_scalar, _nonscalar]
-# TreeValue = Union[_value, 'Annotated[_value]']
+TreeValue = Union[_value, 'Annotated[_value]']
-def _make_tree(obj, ifcond, comment=None):
- extra = {
- 'if': ifcond,
- 'comment': comment,
- }
- return (obj, extra)
+_NodeT = TypeVar('_NodeT', bound=TreeValue)
+
+
+class Annotated(Generic[_NodeT]):
+ """
+ Annotated generally contains a SchemaInfo-like type (as a dict),
+ But it also used to wrap comments/ifconds around scalar leaf values,
+ for the benefit of features and enums.
+ """
+ # Remove after 3.7 adds @dataclass:
+ # pylint: disable=too-few-public-methods
+ def __init__(self, value: _NodeT, ifcond: Iterable[str],
+ comment: Optional[str] = None):
+ self.value = value
+ self.comment: Optional[str] = comment
+ self.ifcond: Tuple[str, ...] = tuple(ifcond)
def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
@@ -67,24 +81,20 @@ def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
def indent(level):
return level * 4 * ' '
- if isinstance(obj, tuple):
- ifobj, extra = obj
- ifcond = extra.get('if')
- comment = extra.get('comment')
-
+ if isinstance(obj, Annotated):
# 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 suppress_first_indent, msg
ret = ''
- if comment:
- ret += indent(level) + '/* %s */\n' % comment
- if ifcond:
- ret += gen_if(ifcond)
- ret += _tree_to_qlit(ifobj, level)
- if ifcond:
- ret += '\n' + gen_endif(ifcond)
+ if obj.comment:
+ ret += indent(level) + '/* %s */\n' % obj.comment
+ if obj.ifcond:
+ ret += gen_if(obj.ifcond)
+ ret += _tree_to_qlit(obj.value, level, suppress_first_indent)
+ if obj.ifcond:
+ ret += '\n' + gen_endif(obj.ifcond)
return ret
ret = ''
@@ -201,7 +211,7 @@ def _use_type(self, typ):
@staticmethod
def _gen_features(features):
- return [_make_tree(f.name, f.ifcond) for f in features]
+ return [Annotated(f.name, f.ifcond) for f in features]
def _gen_tree(self, name, mtype, obj, ifcond, features):
comment: Optional[str] = None
@@ -215,7 +225,7 @@ def _gen_tree(self, name, mtype, obj, ifcond, features):
obj['meta-type'] = mtype
if features:
obj['features'] = self._gen_features(features)
- self._trees.append(_make_tree(obj, ifcond, comment))
+ self._trees.append(Annotated(obj, ifcond, comment))
def _gen_member(self, member):
obj = {'name': member.name, 'type': self._use_type(member.type)}
@@ -223,7 +233,7 @@ def _gen_member(self, member):
obj['default'] = None
if member.features:
obj['features'] = self._gen_features(member.features)
- return _make_tree(obj, member.ifcond)
+ return Annotated(obj, member.ifcond)
def _gen_variants(self, tag_name, variants):
return {'tag': tag_name,
@@ -231,16 +241,17 @@ def _gen_variants(self, tag_name, variants):
def _gen_variant(self, variant):
obj = {'case': variant.name, 'type': self._use_type(variant.type)}
- return _make_tree(obj, variant.ifcond)
+ return Annotated(obj, variant.ifcond)
def visit_builtin_type(self, name, info, json_type):
self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None)
def visit_enum_type(self, name, info, ifcond, features, members, prefix):
- self._gen_tree(name, 'enum',
- {'values': [_make_tree(m.name, m.ifcond, None)
- for m in members]},
- ifcond, features)
+ self._gen_tree(
+ name, 'enum',
+ {'values': [Annotated(m.name, m.ifcond) for m in members]},
+ ifcond, features
+ )
def visit_array_type(self, name, info, ifcond, element_type):
element = self._use_type(element_type)
@@ -257,12 +268,12 @@ def visit_object_type_flat(self, name, info, ifcond, features,
self._gen_tree(name, 'object', obj, ifcond, features)
def visit_alternate_type(self, name, info, ifcond, features, variants):
- self._gen_tree(name, 'alternate',
- {'members': [
- _make_tree({'type': self._use_type(m.type)},
- m.ifcond, None)
- for m in variants.variants]},
- ifcond, features)
+ self._gen_tree(name, 'alternate', {'members': [
+ Annotated({'type': self._use_type(m.type)}, m.ifcond)
+ for m in variants.variants
+ ]},
+ ifcond, features
+ )
def visit_command(self, name, info, ifcond, features,
arg_type, ret_type, gen, success_response, boxed,
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (7 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit John Snow
` (3 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Trivial; make the error message just a pinch more explicit in case we
trip this by accident in the future.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 2b90a52f016..c72beeeed27 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -124,7 +124,9 @@ def indent(level):
elif isinstance(obj, bool):
ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false')
else:
- assert False # not implemented
+ raise NotImplementedError(
+ f"type '{type(obj).__name__}' not implemented"
+ )
if level > 0:
ret += ','
return ret
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (8 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 11/13] qapi/introspect.py: add type hint annotations John Snow
` (2 subsequent siblings)
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Subjective, but I find getting rid of the comprehensions helps. Also,
divide the sections into scalar and non-scalar sections, and remove
old-style string formatting.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 33 ++++++++++++++++++---------------
1 file changed, 18 insertions(+), 15 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index c72beeeed27..60ec326d2c7 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -89,7 +89,7 @@ def indent(level):
ret = ''
if obj.comment:
- ret += indent(level) + '/* %s */\n' % obj.comment
+ ret += indent(level) + f"/* {obj.comment} */\n"
if obj.ifcond:
ret += gen_if(obj.ifcond)
ret += _tree_to_qlit(obj.value, level, suppress_first_indent)
@@ -100,33 +100,36 @@ def indent(level):
ret = ''
if not suppress_first_indent:
ret += indent(level)
+
+ # Scalars:
if obj is None:
ret += 'QLIT_QNULL'
elif isinstance(obj, str):
- ret += 'QLIT_QSTR(' + to_c_string(obj) + ')'
+ ret += f"QLIT_QSTR({to_c_string(obj)})"
+ elif isinstance(obj, bool):
+ ret += f"QLIT_QBOOL({str(obj).lower()})"
+
+ # Non-scalars:
elif isinstance(obj, list):
- elts = [_tree_to_qlit(elt, level + 1).strip('\n')
- for elt in obj]
- elts.append(indent(level + 1) + "{}")
ret += 'QLIT_QLIST(((QLitObject[]) {\n'
- ret += '\n'.join(elts) + '\n'
+ for value in obj:
+ ret += _tree_to_qlit(value, level + 1).strip('\n') + '\n'
+ ret += indent(level + 1) + '{}\n'
ret += indent(level) + '}))'
elif isinstance(obj, dict):
- elts = []
- for key, value in sorted(obj.items()):
- elts.append(indent(level + 1) + '{ %s, %s }' %
- (to_c_string(key),
- _tree_to_qlit(value, level + 1, True)))
- elts.append(indent(level + 1) + '{}')
ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n'
- ret += ',\n'.join(elts) + '\n'
+ for key, value in sorted(obj.items()):
+ ret += indent(level + 1) + "{{ {:s}, {:s} }},\n".format(
+ to_c_string(key),
+ _tree_to_qlit(value, level + 1, suppress_first_indent=True)
+ )
+ ret += indent(level + 1) + '{}\n'
ret += indent(level) + '}))'
- elif isinstance(obj, bool):
- ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false')
else:
raise NotImplementedError(
f"type '{type(obj).__name__}' not implemented"
)
+
if level > 0:
ret += ','
return ret
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 11/13] qapi/introspect.py: add type hint annotations
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (9 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types John Snow
2020-12-17 1:53 ` [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit John Snow
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 114 ++++++++++++++++++++++++++-----------
scripts/qapi/mypy.ini | 5 --
scripts/qapi/schema.py | 2 +-
3 files changed, 81 insertions(+), 40 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 60ec326d2c7..590898baf93 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -30,10 +30,19 @@
)
from .gen import QAPISchemaMonolithicCVisitor
from .schema import (
+ QAPISchema,
QAPISchemaArrayType,
QAPISchemaBuiltinType,
+ QAPISchemaEntity,
+ QAPISchemaEnumMember,
+ QAPISchemaFeature,
+ QAPISchemaObjectType,
+ QAPISchemaObjectTypeMember,
QAPISchemaType,
+ QAPISchemaVariant,
+ QAPISchemaVariants,
)
+from .source import QAPISourceInfo
# This module constructs a tree data structure that is used to
@@ -57,6 +66,8 @@
_value = Union[_scalar, _nonscalar]
TreeValue = Union[_value, 'Annotated[_value]']
+# This is a (strict) alias for an arbitrary object non-scalar, as above:
+_DObject = Dict[str, object]
_NodeT = TypeVar('_NodeT', bound=TreeValue)
@@ -76,9 +87,11 @@ def __init__(self, value: _NodeT, ifcond: Iterable[str],
self.ifcond: Tuple[str, ...] = tuple(ifcond)
-def _tree_to_qlit(obj, level=0, suppress_first_indent=False):
+def _tree_to_qlit(obj: TreeValue,
+ level: int = 0,
+ suppress_first_indent: bool = False) -> str:
- def indent(level):
+ def indent(level: int) -> str:
return level * 4 * ' '
if isinstance(obj, Annotated):
@@ -135,21 +148,21 @@ def indent(level):
return ret
-def to_c_string(string):
+def to_c_string(string: str) -> str:
return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"'
class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor):
- def __init__(self, prefix, unmask):
+ def __init__(self, prefix: str, unmask: bool):
super().__init__(
prefix, 'qapi-introspect',
' * QAPI/QMP schema introspection', __doc__)
self._unmask = unmask
- self._schema = None
- self._trees = []
- self._used_types = []
- self._name_map = {}
+ self._schema: Optional[QAPISchema] = None
+ self._trees: List[Annotated[_DObject]] = []
+ self._used_types: List[QAPISchemaType] = []
+ self._name_map: Dict[str, str] = {}
self._genc.add(mcgen('''
#include "qemu/osdep.h"
#include "%(prefix)sqapi-introspect.h"
@@ -157,10 +170,10 @@ def __init__(self, prefix, unmask):
''',
prefix=prefix))
- def visit_begin(self, schema):
+ def visit_begin(self, schema: QAPISchema) -> None:
self._schema = schema
- def visit_end(self):
+ def visit_end(self) -> None:
# visit the types that are actually used
for typ in self._used_types:
typ.visit(self)
@@ -182,18 +195,18 @@ def visit_end(self):
self._used_types = []
self._name_map = {}
- def visit_needed(self, entity):
+ def visit_needed(self, entity: QAPISchemaEntity) -> bool:
# Ignore types on first pass; visit_end() will pick up used types
return not isinstance(entity, QAPISchemaType)
- def _name(self, name):
+ def _name(self, name: str) -> str:
if self._unmask:
return name
if name not in self._name_map:
self._name_map[name] = '%d' % len(self._name_map)
return self._name_map[name]
- def _use_type(self, typ):
+ def _use_type(self, typ: QAPISchemaType) -> str:
assert self._schema is not None
# Map the various integer types to plain int
@@ -215,10 +228,13 @@ def _use_type(self, typ):
return self._name(typ.name)
@staticmethod
- def _gen_features(features):
+ def _gen_features(features: List[QAPISchemaFeature]
+ ) -> List[Annotated[str]]:
return [Annotated(f.name, f.ifcond) for f in features]
- def _gen_tree(self, name, mtype, obj, ifcond, features):
+ def _gen_tree(self, name: str, mtype: str, obj: _DObject,
+ ifcond: List[str],
+ features: Optional[List[QAPISchemaFeature]]) -> None:
comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask:
@@ -232,47 +248,67 @@ def _gen_tree(self, name, mtype, obj, ifcond, features):
obj['features'] = self._gen_features(features)
self._trees.append(Annotated(obj, ifcond, comment))
- def _gen_member(self, member):
- obj = {'name': member.name, 'type': self._use_type(member.type)}
+ def _gen_member(self, member: QAPISchemaObjectTypeMember
+ ) -> Annotated[_DObject]:
+ obj: _DObject = {
+ 'name': member.name,
+ 'type': self._use_type(member.type)
+ }
if member.optional:
obj['default'] = None
if member.features:
obj['features'] = self._gen_features(member.features)
return Annotated(obj, member.ifcond)
- def _gen_variants(self, tag_name, variants):
+ def _gen_variants(self, tag_name: str,
+ variants: List[QAPISchemaVariant]) -> _DObject:
return {'tag': tag_name,
'variants': [self._gen_variant(v) for v in variants]}
- def _gen_variant(self, variant):
- obj = {'case': variant.name, 'type': self._use_type(variant.type)}
+ def _gen_variant(self, variant: QAPISchemaVariant) -> Annotated[_DObject]:
+ obj: _DObject = {
+ 'case': variant.name,
+ 'type': self._use_type(variant.type)
+ }
return Annotated(obj, variant.ifcond)
- def visit_builtin_type(self, name, info, json_type):
+ def visit_builtin_type(self, name: str, info: QAPISourceInfo,
+ json_type: str) -> None:
self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None)
- def visit_enum_type(self, name, info, ifcond, features, members, prefix):
+ def visit_enum_type(self, name: str, info: QAPISourceInfo,
+ ifcond: List[str], features: List[QAPISchemaFeature],
+ members: List[QAPISchemaEnumMember],
+ prefix: Optional[str]) -> None:
self._gen_tree(
name, 'enum',
{'values': [Annotated(m.name, m.ifcond) for m in members]},
ifcond, features
)
- def visit_array_type(self, name, info, ifcond, element_type):
+ def visit_array_type(self, name: str, info: QAPISourceInfo,
+ ifcond: List[str],
+ element_type: QAPISchemaType) -> None:
element = self._use_type(element_type)
self._gen_tree('[' + element + ']', 'array', {'element-type': element},
ifcond, None)
- def visit_object_type_flat(self, name, info, ifcond, features,
- members, variants):
- obj = {'members': [self._gen_member(m) for m in members]}
+ def visit_object_type_flat(self, name: str, info: QAPISourceInfo,
+ ifcond: List[str],
+ features: List[QAPISchemaFeature],
+ members: List[QAPISchemaObjectTypeMember],
+ variants: Optional[QAPISchemaVariants]) -> None:
+ obj: _DObject = {'members': [self._gen_member(m) for m in members]}
if variants:
obj.update(self._gen_variants(variants.tag_member.name,
variants.variants))
self._gen_tree(name, 'object', obj, ifcond, features)
- def visit_alternate_type(self, name, info, ifcond, features, variants):
+ def visit_alternate_type(self, name: str, info: QAPISourceInfo,
+ ifcond: List[str],
+ features: List[QAPISchemaFeature],
+ variants: QAPISchemaVariants) -> None:
self._gen_tree(name, 'alternate', {'members': [
Annotated({'type': self._use_type(m.type)}, m.ifcond)
for m in variants.variants
@@ -280,27 +316,37 @@ def visit_alternate_type(self, name, info, ifcond, features, variants):
ifcond, features
)
- def visit_command(self, name, info, ifcond, features,
- arg_type, ret_type, gen, success_response, boxed,
- allow_oob, allow_preconfig, coroutine):
+ def visit_command(self, name: str, info: QAPISourceInfo, ifcond: List[str],
+ features: List[QAPISchemaFeature],
+ arg_type: Optional[QAPISchemaObjectType],
+ ret_type: Optional[QAPISchemaType], gen: bool,
+ success_response: bool, boxed: bool, allow_oob: bool,
+ allow_preconfig: bool, coroutine: bool) -> None:
assert self._schema is not None
arg_type = arg_type or self._schema.the_empty_object_type
ret_type = ret_type or self._schema.the_empty_object_type
- obj = {'arg-type': self._use_type(arg_type),
- 'ret-type': self._use_type(ret_type)}
+ obj: _DObject = {
+ 'arg-type': self._use_type(arg_type),
+ 'ret-type': self._use_type(ret_type)
+ }
if allow_oob:
obj['allow-oob'] = allow_oob
self._gen_tree(name, 'command', obj, ifcond, features)
- def visit_event(self, name, info, ifcond, features, arg_type, boxed):
+ def visit_event(self, name: str, info: QAPISourceInfo,
+ ifcond: List[str], features: List[QAPISchemaFeature],
+ arg_type: Optional[QAPISchemaObjectType],
+ boxed: bool) -> None:
assert self._schema is not None
+
arg_type = arg_type or self._schema.the_empty_object_type
self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)},
ifcond, features)
-def gen_introspect(schema, output_dir, prefix, opt_unmask):
+def gen_introspect(schema: QAPISchema, output_dir: str, prefix: str,
+ opt_unmask: bool) -> None:
vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask)
schema.visit(vis)
vis.write(output_dir)
diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini
index 04bd5db5278..0a000d58b37 100644
--- a/scripts/qapi/mypy.ini
+++ b/scripts/qapi/mypy.ini
@@ -13,11 +13,6 @@ disallow_untyped_defs = False
disallow_incomplete_defs = False
check_untyped_defs = False
-[mypy-qapi.introspect]
-disallow_untyped_defs = False
-disallow_incomplete_defs = False
-check_untyped_defs = False
-
[mypy-qapi.parser]
disallow_untyped_defs = False
disallow_incomplete_defs = False
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index 0235208966a..1e5f5aee4d8 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -29,7 +29,7 @@
class QAPISchemaEntity:
meta: Optional[str] = None
- def __init__(self, name, info, doc, ifcond=None, features=None):
+ def __init__(self, name: str, info, doc, ifcond=None, features=None):
assert name is None or isinstance(name, str)
for f in features or []:
assert isinstance(f, QAPISchemaFeature)
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (10 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 11/13] qapi/introspect.py: add type hint annotations John Snow
@ 2020-12-17 1:53 ` John Snow
2020-12-17 1:53 ` [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit John Snow
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Add some aliases that declare intent for some of the "dictly-typed"
objects we pass around in introspect.py.
Signed-off-by: John Snow <jsnow@redhat.com>
---
This patch is optional, it can be dropped if desired.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 48 ++++++++++++++++++++++++--------------
1 file changed, 30 insertions(+), 18 deletions(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 590898baf93..428397a6954 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -66,8 +66,14 @@
_value = Union[_scalar, _nonscalar]
TreeValue = Union[_value, 'Annotated[_value]']
-# This is a (strict) alias for an arbitrary object non-scalar, as above:
-_DObject = Dict[str, object]
+# We lack precise object types, so SchemaInfo, children, and related types are
+# typed here loosely as simply python Dicts.
+SchemaInfo = Dict[str, object]
+SchemaInfoObject = Dict[str, object]
+SchemaInfoObjectVariant = Dict[str, object]
+SchemaInfoObjectMember = Dict[str, object]
+SchemaInfoCommand = Dict[str, object]
+
_NodeT = TypeVar('_NodeT', bound=TreeValue)
@@ -160,7 +166,7 @@ def __init__(self, prefix: str, unmask: bool):
' * QAPI/QMP schema introspection', __doc__)
self._unmask = unmask
self._schema: Optional[QAPISchema] = None
- self._trees: List[Annotated[_DObject]] = []
+ self._trees: List[Annotated[SchemaInfo]] = []
self._used_types: List[QAPISchemaType] = []
self._name_map: Dict[str, str] = {}
self._genc.add(mcgen('''
@@ -232,9 +238,18 @@ def _gen_features(features: List[QAPISchemaFeature]
) -> List[Annotated[str]]:
return [Annotated(f.name, f.ifcond) for f in features]
- def _gen_tree(self, name: str, mtype: str, obj: _DObject,
+ def _gen_tree(self, name: str, mtype: str, obj: Dict[str, object],
ifcond: List[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: List of conditionals that apply to this entire entity.
+ :param features: Optional features field for SchemaInfo.
+ """
comment: Optional[str] = None
if mtype not in ('command', 'event', 'builtin', 'array'):
if not self._unmask:
@@ -249,8 +264,8 @@ def _gen_tree(self, name: str, mtype: str, obj: _DObject,
self._trees.append(Annotated(obj, ifcond, comment))
def _gen_member(self, member: QAPISchemaObjectTypeMember
- ) -> Annotated[_DObject]:
- obj: _DObject = {
+ ) -> Annotated[SchemaInfoObjectMember]:
+ obj: SchemaInfoObjectMember = {
'name': member.name,
'type': self._use_type(member.type)
}
@@ -260,13 +275,9 @@ def _gen_member(self, member: QAPISchemaObjectTypeMember
obj['features'] = self._gen_features(member.features)
return Annotated(obj, member.ifcond)
- def _gen_variants(self, tag_name: str,
- variants: List[QAPISchemaVariant]) -> _DObject:
- return {'tag': tag_name,
- 'variants': [self._gen_variant(v) for v in variants]}
-
- def _gen_variant(self, variant: QAPISchemaVariant) -> Annotated[_DObject]:
- obj: _DObject = {
+ def _gen_variant(self, variant: QAPISchemaVariant
+ ) -> Annotated[SchemaInfoObjectVariant]:
+ obj: SchemaInfoObjectVariant = {
'case': variant.name,
'type': self._use_type(variant.type)
}
@@ -298,11 +309,12 @@ def visit_object_type_flat(self, name: str, info: QAPISourceInfo,
features: List[QAPISchemaFeature],
members: List[QAPISchemaObjectTypeMember],
variants: Optional[QAPISchemaVariants]) -> None:
- obj: _DObject = {'members': [self._gen_member(m) for m in members]}
+ obj: SchemaInfoObject = {
+ 'members': [self._gen_member(m) for m in members]
+ }
if variants:
- obj.update(self._gen_variants(variants.tag_member.name,
- variants.variants))
-
+ obj['tag'] = variants.tag_member.name
+ obj['variants'] = [self._gen_variant(v) for v in variants.variants]
self._gen_tree(name, 'object', obj, ifcond, features)
def visit_alternate_type(self, name: str, info: QAPISourceInfo,
@@ -326,7 +338,7 @@ def visit_command(self, name: str, info: QAPISourceInfo, ifcond: List[str],
arg_type = arg_type or self._schema.the_empty_object_type
ret_type = ret_type or self._schema.the_empty_object_type
- obj: _DObject = {
+ obj: SchemaInfoCommand = {
'arg-type': self._use_type(arg_type),
'ret-type': self._use_type(ret_type)
}
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
` (11 preceding siblings ...)
2020-12-17 1:53 ` [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types John Snow
@ 2020-12-17 1:53 ` John Snow
12 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2020-12-17 1:53 UTC (permalink / raw)
To: Markus Armbruster, qemu-devel; +Cc: John Snow, Eduardo Habkost, Cleber Rosa
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index 428397a6954..8d5b8513fc8 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -1,10 +1,11 @@
"""
QAPI introspection generator
-Copyright (C) 2015-2018 Red Hat, Inc.
+Copyright (C) 2015-2020 Red Hat, Inc.
Authors:
Markus Armbruster <armbru@redhat.com>
+ John Snow <jsnow@redhat.com>
This work is licensed under the terms of the GNU GPL, version 2.
See the COPYING file in the top-level directory.
@@ -96,6 +97,13 @@ def __init__(self, value: _NodeT, ifcond: Iterable[str],
def _tree_to_qlit(obj: TreeValue,
level: int = 0,
suppress_first_indent: bool = False) -> str:
+ """
+ Convert the type tree into a QLIT C string, recursively.
+
+ :param obj: The value to convert.
+ :param level: The indentation level for this particular value.
+ :param suppress_first_indent: True for dict value children.
+ """
def indent(level: int) -> str:
return level * 4 * ' '
--
2.26.2
^ permalink raw reply related [flat|nested] 14+ messages in thread
end of thread, other threads:[~2020-12-17 2:06 UTC | newest]
Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-17 1:53 [PATCH v3 00/13] qapi: static typing conversion, pt2 John Snow
2020-12-17 1:53 ` [PATCH v3 01/13] qapi/introspect.py: assert schema is not None John Snow
2020-12-17 1:53 ` [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes John Snow
2020-12-17 1:53 ` [PATCH v3 03/13] qapi/introspect.py: add _gen_features helper John Snow
2020-12-17 1:53 ` [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse John Snow
2020-12-17 1:53 ` [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree() John Snow
2020-12-17 1:53 ` [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument John Snow
2020-12-17 1:53 ` [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing John Snow
2020-12-17 1:53 ` [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure John Snow
2020-12-17 1:53 ` [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message John Snow
2020-12-17 1:53 ` [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit John Snow
2020-12-17 1:53 ` [PATCH v3 11/13] qapi/introspect.py: add type hint annotations John Snow
2020-12-17 1:53 ` [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types John Snow
2020-12-17 1:53 ` [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit John Snow
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).