From: John Snow <jsnow@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>,
qemu-devel@nongnu.org, Eduardo Habkost <ehabkost@redhat.com>,
Michael Roth <mdroth@linux.vnet.ibm.com>
Subject: [PATCH 03/16] qapi/expr.py: constrain incoming expression types
Date: Tue, 22 Sep 2020 17:13:00 -0400 [thread overview]
Message-ID: <20200922211313.4082880-4-jsnow@redhat.com> (raw)
In-Reply-To: <20200922211313.4082880-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>
---
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 1872a8a3cc..f6b55a87c1 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,
@@ -280,9 +288,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
next prev parent reply other threads:[~2020-09-22 21:51 UTC|newest]
Thread overview: 70+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-22 21:12 [PATCH 00/16] qapi: static typing conversion, pt2 John Snow
2020-09-22 21:12 ` [PATCH 01/16] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow
2020-09-23 19:26 ` Eduardo Habkost
2020-09-24 23:06 ` Cleber Rosa
2020-09-22 21:12 ` [PATCH 02/16] qapi/expr.py: Check for dict instead of OrderedDict John Snow
2020-09-23 19:26 ` Eduardo Habkost
2020-09-24 23:07 ` Cleber Rosa
2020-09-22 21:13 ` John Snow [this message]
2020-09-23 19:42 ` [PATCH 03/16] qapi/expr.py: constrain incoming expression types Eduardo Habkost
2020-09-25 0:05 ` Cleber Rosa
2020-09-25 0:43 ` John Snow
2020-09-25 0:40 ` John Snow
2020-09-25 0:06 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 04/16] qapi/expr.py: Add assertion for union type 'check_dict' John Snow
2020-09-23 19:53 ` Eduardo Habkost
2020-09-25 0:47 ` John Snow
2020-09-25 1:08 ` Eduardo Habkost
2020-09-25 1:30 ` John Snow
2020-09-25 0:19 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 05/16] qapi/expr.py: move string check upwards in check_type John Snow
2020-09-23 19:56 ` Eduardo Habkost
2020-09-25 0:22 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 06/16] qapi/expr.py: Check type of 'data' member John Snow
2020-09-23 19:58 ` Eduardo Habkost
2020-09-25 0:31 ` Cleber Rosa
2020-09-25 0:50 ` John Snow
2020-09-25 16:48 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 07/16] qapi/expr.py: Add casts in a few select cases John Snow
2020-09-23 20:01 ` Eduardo Habkost
2020-09-25 0:36 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 08/16] qapi/expr.py: add type hint annotations John Snow
2020-09-23 20:06 ` Eduardo Habkost
2020-09-25 0:44 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 09/16] qapi/expr.py: rewrite check_if John Snow
2020-09-23 20:09 ` Eduardo Habkost
2020-09-25 0:50 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 10/16] qapi/expr.py: Remove single-letter variable John Snow
2020-09-23 20:11 ` Eduardo Habkost
2020-09-25 0:52 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 11/16] qapi/expr.py: enable pylint checks John Snow
2020-09-23 20:12 ` Eduardo Habkost
2020-09-25 0:53 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 12/16] qapi/expr.py: Add docstrings John Snow
2020-09-23 20:16 ` Eduardo Habkost
2020-09-25 0:52 ` John Snow
2020-09-25 0:59 ` Cleber Rosa
2020-09-25 1:10 ` John Snow
2020-09-22 21:13 ` [PATCH 13/16] qapi/expr.py: Modify check_keys to accept any Iterable John Snow
2020-09-23 20:17 ` Eduardo Habkost
2020-09-25 1:02 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 14/16] qapi/expr.py: Use tuples instead of lists for static data John Snow
2020-09-23 20:18 ` Eduardo Habkost
2020-09-25 1:03 ` Cleber Rosa
2020-09-25 1:12 ` John Snow
2020-09-22 21:13 ` [PATCH 15/16] qapi/expr.py: move related checks inside check_xxx functions John Snow
2020-09-23 20:25 ` Eduardo Habkost
2020-09-25 0:58 ` John Snow
2020-09-25 1:09 ` Cleber Rosa
2020-09-22 21:13 ` [PATCH 16/16] qapi/expr.py: Use an expression checker dispatch table John Snow
2020-09-23 20:36 ` Eduardo Habkost
2020-09-25 0:59 ` John Snow
2020-09-25 1:18 ` Cleber Rosa
2020-09-25 1:32 ` John Snow
2020-09-25 6:03 ` Helio Loureiro
2020-09-25 14:16 ` John Snow
2020-09-26 11:31 ` Helio Loureiro
2020-09-30 4:46 ` John Snow
2020-09-25 16:38 ` Cleber Rosa
2020-09-25 17:04 ` John Snow
2020-09-25 22:54 ` [PATCH 00/16] qapi: static typing conversion, pt2 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=20200922211313.4082880-4-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=mdroth@linux.vnet.ibm.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).