[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 03/16] qapi/expr.py: constrain incoming expression types
From: |
John Snow |
Subject: |
[PATCH v2 03/16] qapi/expr.py: constrain incoming expression types |
Date: |
Mon, 26 Oct 2020 17:36:24 -0400 |
mypy does not know the types of values stored in Dicts that masquerade
as objects. Help the type checker out by constraining the type.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
---
scripts/qapi/expr.py | 25 ++++++++++++++++++++++---
1 file changed, 22 insertions(+), 3 deletions(-)
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index 5694c501fa38..f7c7f91326ef 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -15,9 +15,17 @@
# See the COPYING file in the top-level directory.
import re
+from typing import MutableMapping, Optional
from .common import c_name
from .error import QAPISemError
+from .parser import QAPIDoc
+from .source import QAPISourceInfo
+
+
+# Expressions in their raw form are JSON-like structures with arbitrary forms.
+# Minimally, their top-level form must be a mapping of strings to values.
+Expression = MutableMapping[str, object]
# Names must be letters, numbers, -, and _. They must start with letter,
@@ -287,9 +295,20 @@ def check_event(expr, info):
def check_exprs(exprs):
for expr_elem in exprs:
- expr = expr_elem['expr']
- info = expr_elem['info']
- doc = expr_elem.get('doc')
+ # Expression
+ assert isinstance(expr_elem['expr'], dict)
+ expr: Expression = expr_elem['expr']
+ for key in expr.keys():
+ assert isinstance(key, str)
+
+ # QAPISourceInfo
+ assert isinstance(expr_elem['info'], QAPISourceInfo)
+ info: QAPISourceInfo = expr_elem['info']
+
+ # Optional[QAPIDoc]
+ tmp = expr_elem.get('doc')
+ assert tmp is None or isinstance(tmp, QAPIDoc)
+ doc: Optional[QAPIDoc] = tmp
if 'include' in expr:
continue
--
2.26.2
- [PATCH v2 00/16] qapi: static typing conversion, pt3, John Snow, 2020/10/26
- [PATCH v2 02/16] qapi/expr.py: Check for dict instead of OrderedDict, John Snow, 2020/10/26
- [PATCH v2 03/16] qapi/expr.py: constrain incoming expression types,
John Snow <=
- [PATCH v2 04/16] qapi/expr.py: Add assertion for union type 'check_dict', John Snow, 2020/10/26
- [PATCH v2 05/16] qapi/expr.py: move string check upwards in check_type, John Snow, 2020/10/26
- [PATCH v2 06/16] qapi/expr.py: Check type of 'data' member, John Snow, 2020/10/26
- [PATCH v2 01/16] qapi/expr.py: Remove 'info' argument from nested check_if_str, John Snow, 2020/10/26
- [PATCH v2 07/16] qapi/expr.py: Add casts in a few select cases, John Snow, 2020/10/26
- [PATCH v2 08/16] qapi/expr.py: add type hint annotations, John Snow, 2020/10/26
- [PATCH v2 09/16] qapi/expr.py: rewrite check_if, John Snow, 2020/10/26
- [PATCH v2 15/16] qapi/expr.py: move related checks inside check_xxx functions, John Snow, 2020/10/26
- [PATCH v2 10/16] qapi/expr.py: Remove single-letter variable, John Snow, 2020/10/26
- [PATCH v2 11/16] qapi/expr.py: enable pylint checks, John Snow, 2020/10/26