[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing
From: |
John Snow |
Subject: |
[PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing |
Date: |
Wed, 16 Dec 2020 20:53:37 -0500 |
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
- [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes, (continued)
- [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes, John Snow, 2020/12/16
- [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2020/12/16
- [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse, John Snow, 2020/12/16
- [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree(), John Snow, 2020/12/16
- [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure, John Snow, 2020/12/16
- [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message, John Snow, 2020/12/16
- [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit, John Snow, 2020/12/16
- [PATCH v3 11/13] qapi/introspect.py: add type hint annotations, John Snow, 2020/12/16
- [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types, John Snow, 2020/12/16
- [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit, John Snow, 2020/12/16
- [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing,
John Snow <=