qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: Markus Armbruster <armbru@redhat.com>, qemu-devel@nongnu.org
Cc: Michael Roth <michael.roth@amd.com>, John Snow <jsnow@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v5 04/17] qapi/expr.py: constrain incoming expression types
Date: Wed, 21 Apr 2021 14:20:19 -0400	[thread overview]
Message-ID: <20210421182032.3521476-5-jsnow@redhat.com> (raw)
In-Reply-To: <20210421182032.3521476-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 | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index b4bbcd54c08..06a00810015 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.30.2



  parent reply	other threads:[~2021-04-21 18:26 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-21 18:20 [PATCH v5 00/17] qapi: static typing conversion, pt3 John Snow
2021-04-21 18:20 ` [PATCH v5 01/17] qapi/expr: Comment cleanup John Snow
2021-04-21 18:20 ` [PATCH v5 02/17] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow
2021-04-21 18:20 ` [PATCH v5 03/17] qapi/expr.py: Check for dict instead of OrderedDict John Snow
2021-04-21 18:20 ` John Snow [this message]
2021-04-21 18:20 ` [PATCH v5 05/17] qapi/expr.py: Add assertion for union type 'check_dict' John Snow
2021-04-21 18:20 ` [PATCH v5 06/17] qapi/expr.py: move string check upwards in check_type John Snow
2021-04-21 18:20 ` [PATCH v5 07/17] qapi/expr.py: Check type of union and alternate 'data' member John Snow
2021-04-21 18:20 ` [PATCH v5 08/17] qapi/expr.py: Add casts in a few select cases John Snow
2021-04-21 18:20 ` [PATCH v5 09/17] qapi/expr.py: Modify check_keys to accept any Collection John Snow
2021-04-21 18:20 ` [PATCH v5 10/17] qapi/expr.py: add type hint annotations John Snow
2021-04-21 18:20 ` [PATCH v5 11/17] qapi/expr.py: Consolidate check_if_str calls in check_if John Snow
2021-04-21 18:20 ` [PATCH v5 12/17] qapi/expr.py: Remove single-letter variable John Snow
2021-04-21 18:20 ` [PATCH v5 13/17] qapi/expr.py: enable pylint checks John Snow
2021-04-21 18:20 ` [PATCH v5 14/17] qapi/expr: Only explicitly prohibit 'Kind' nor 'List' for type names John Snow
2021-04-21 18:20 ` [PATCH v5 15/17] qapi/expr.py: Add docstrings John Snow
2021-04-21 18:20 ` [PATCH v5 16/17] qapi/expr.py: Use tuples instead of lists for static data John Snow
2021-04-21 18:20 ` [PATCH v5 17/17] qapi/expr: Update authorship and copyright information John Snow
2021-04-22  7:07 ` [PATCH v5 00/17] qapi: static typing conversion, pt3 Markus Armbruster

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=20210421182032.3521476-5-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).