[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 04/25] qapi/expr.py: constrain incoming expression types
From: |
Markus Armbruster |
Subject: |
[PULL 04/25] qapi/expr.py: constrain incoming expression types |
Date: |
Fri, 30 Apr 2021 13:48:17 +0200 |
From: John Snow <jsnow@redhat.com>
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>
Message-Id: <20210421182032.3521476-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/expr.py | 28 +++++++++++++++++++++++++---
1 file changed, 25 insertions(+), 3 deletions(-)
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index b4bbcd54c0..06a0081001 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -15,9 +15,20 @@
# See the COPYING file in the top-level directory.
import re
+from typing import Dict, Optional
from .common import c_name
from .error import QAPISemError
+from .parser import QAPIDoc
+from .source import QAPISourceInfo
+
+
+# Deserialized JSON objects as returned by the parser.
+# The values of this mapping are not necessary to exhaustively type
+# here (and also not practical as long as mypy lacks recursive
+# types), because the purpose of this module is to interrogate that
+# type.
+_JSONObject = Dict[str, object]
# Names consist of letters, digits, -, and _, starting with a letter.
@@ -315,9 +326,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)
+ for key in expr_elem['expr'].keys():
+ assert isinstance(key, str)
+ expr: _JSONObject = expr_elem['expr']
+
+ # 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.3
- [PULL 00/25] QAPI patches patches for 2021-04-30, Markus Armbruster, 2021/04/30
- [PULL 04/25] qapi/expr.py: constrain incoming expression types,
Markus Armbruster <=
- [PULL 03/25] qapi/expr.py: Check for dict instead of OrderedDict, Markus Armbruster, 2021/04/30
- [PULL 08/25] qapi/expr.py: Add casts in a few select cases, Markus Armbruster, 2021/04/30
- [PULL 13/25] qapi/expr.py: enable pylint checks, Markus Armbruster, 2021/04/30
- [PULL 11/25] qapi/expr.py: Consolidate check_if_str calls in check_if, Markus Armbruster, 2021/04/30
- [PULL 06/25] qapi/expr.py: move string check upwards in check_type, Markus Armbruster, 2021/04/30
- [PULL 12/25] qapi/expr.py: Remove single-letter variable, Markus Armbruster, 2021/04/30
- [PULL 14/25] qapi/expr: Only explicitly prohibit 'Kind' nor 'List' for type names, Markus Armbruster, 2021/04/30
- [PULL 10/25] qapi/expr.py: add type hint annotations, Markus Armbruster, 2021/04/30
- [PULL 09/25] qapi/expr.py: Modify check_keys to accept any Collection, Markus Armbruster, 2021/04/30
- [PULL 01/25] qapi/expr: Comment cleanup, Markus Armbruster, 2021/04/30