From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org, Markus Armbruster <armbru@redhat.com>
Cc: Michael Roth <michael.roth@amd.com>, John Snow <jsnow@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v3 03/16] qapi/expr.py: constrain incoming expression types
Date: Mon, 22 Feb 2021 19:33:55 -0500 [thread overview]
Message-ID: <20210223003408.964543-4-jsnow@redhat.com> (raw)
In-Reply-To: <20210223003408.964543-1-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>
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 5694c501fa3..783282b53ce 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)
+ for key in expr_elem['expr'].keys():
+ assert isinstance(key, str)
+ expr: Expression = 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.29.2
next prev parent reply other threads:[~2021-02-23 0:36 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-23 0:33 [PATCH v3 00/16] qapi: static typing conversion, pt3 John Snow
2021-02-23 0:33 ` [PATCH v3 01/16] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow
2021-02-23 0:33 ` [PATCH v3 02/16] qapi/expr.py: Check for dict instead of OrderedDict John Snow
2021-02-24 9:30 ` Markus Armbruster
2021-02-24 21:23 ` John Snow
2021-02-25 10:40 ` Markus Armbruster
2021-02-25 20:04 ` John Snow
2021-03-01 16:48 ` Markus Armbruster
2021-02-23 0:33 ` John Snow [this message]
2021-02-24 10:01 ` [PATCH v3 03/16] qapi/expr.py: constrain incoming expression types Markus Armbruster
2021-02-24 21:46 ` John Snow
2021-02-25 11:56 ` Markus Armbruster
2021-02-25 20:43 ` John Snow
2021-03-02 5:23 ` Markus Armbruster
2021-02-23 0:33 ` [PATCH v3 04/16] qapi/expr.py: Add assertion for union type 'check_dict' John Snow
2021-02-24 10:35 ` Markus Armbruster
2021-02-24 21:54 ` John Snow
2021-03-24 21:09 ` John Snow
2021-03-25 5:46 ` Markus Armbruster
2021-03-25 19:42 ` John Snow
2021-02-23 0:33 ` [PATCH v3 05/16] qapi/expr.py: move string check upwards in check_type John Snow
2021-02-23 0:33 ` [PATCH v3 06/16] qapi/expr.py: Check type of 'data' member John Snow
2021-02-24 10:39 ` Markus Armbruster
2021-02-24 22:06 ` John Snow
2021-02-25 12:02 ` Markus Armbruster
2021-02-23 0:33 ` [PATCH v3 07/16] qapi/expr.py: Add casts in a few select cases John Snow
2021-02-24 12:32 ` Markus Armbruster
2021-02-24 22:24 ` John Snow
2021-02-25 12:07 ` Markus Armbruster
2021-02-25 22:10 ` John Snow
2021-02-23 0:34 ` [PATCH v3 08/16] qapi/expr.py: add type hint annotations John Snow
2021-02-24 15:27 ` Markus Armbruster
2021-02-24 22:30 ` John Snow
2021-02-25 12:08 ` Markus Armbruster
2021-02-25 13:56 ` Markus Armbruster
2021-02-25 20:54 ` John Snow
2021-03-02 5:29 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 09/16] qapi/expr.py: Consolidate check_if_str calls in check_if John Snow
2021-02-25 14:23 ` Markus Armbruster
2021-02-25 21:34 ` John Snow
2021-03-02 5:57 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 10/16] qapi/expr.py: Remove single-letter variable John Snow
2021-02-25 14:03 ` Markus Armbruster
2021-02-25 21:56 ` John Snow
2021-02-23 0:34 ` [PATCH v3 11/16] qapi/expr.py: enable pylint checks John Snow
2021-02-23 0:34 ` [PATCH v3 12/16] qapi/expr.py: Add docstrings John Snow
2021-02-23 0:34 ` [PATCH v3 13/16] qapi/expr.py: Modify check_keys to accept any Collection John Snow
2021-02-25 15:41 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 14/16] qapi/expr.py: Use tuples instead of lists for static data John Snow
2021-02-23 0:34 ` [PATCH v3 15/16] qapi/expr.py: move related checks inside check_xxx functions John Snow
2021-02-25 15:28 ` Markus Armbruster
2021-03-25 5:17 ` John Snow
2021-03-25 13:28 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 16/16] qapi/expr.py: Use an expression checker dispatch table John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210223003408.964543-4-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=michael.roth@amd.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).