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 v4 19/19] qapi/expr.py: Use an expression checker dispatch table
Date: Thu, 25 Mar 2021 02:03:56 -0400 [thread overview]
Message-ID: <20210325060356.4040114-20-jsnow@redhat.com> (raw)
In-Reply-To: <20210325060356.4040114-1-jsnow@redhat.com>
This enforces a type signature against all of the top-level expression
check routines without necessarily needing to create some
overcomplicated class hierarchy for them.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/expr.py | 63 +++++++++++++++++++++++---------------------
1 file changed, 33 insertions(+), 30 deletions(-)
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index aabbc255d2..c42d061e68 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -31,8 +31,10 @@
structures and contextual semantic validation.
"""
+from enum import Enum
import re
from typing import (
+ Callable,
Collection,
Dict,
Iterable,
@@ -572,6 +574,29 @@ def check_event(expr: _JSONObject, info: QAPISourceInfo) -> None:
check_type(args, info, "'data'", allow_dict=not boxed)
+class ExpressionType(str, Enum):
+ INCLUDE = 'include'
+ ENUM = 'enum'
+ UNION = 'union'
+ ALTERNATE = 'alternate'
+ STRUCT = 'struct'
+ COMMAND = 'command'
+ EVENT = 'event'
+
+ def __str__(self) -> str:
+ return str(self.value)
+
+
+_CHECK_FN: Dict[str, Callable[[_JSONObject, QAPISourceInfo], None]] = {
+ 'enum': check_enum,
+ 'union': check_union,
+ 'alternate': check_alternate,
+ 'struct': check_struct,
+ 'command': check_command,
+ 'event': check_event,
+}
+
+
def check_exprs(exprs: List[_JSONObject]) -> List[_JSONObject]:
"""
Validate and normalize a list of parsed QAPI schema expressions.
@@ -598,24 +623,16 @@ def check_exprs(exprs: List[_JSONObject]) -> List[_JSONObject]:
assert tmp is None or isinstance(tmp, QAPIDoc)
doc: Optional[QAPIDoc] = tmp
- if 'include' in expr:
- continue
-
- if 'enum' in expr:
- meta = 'enum'
- elif 'union' in expr:
- meta = 'union'
- elif 'alternate' in expr:
- meta = 'alternate'
- elif 'struct' in expr:
- meta = 'struct'
- elif 'command' in expr:
- meta = 'command'
- elif 'event' in expr:
- meta = 'event'
+ for kind in ExpressionType:
+ if kind in expr:
+ meta = kind
+ break
else:
raise QAPISemError(info, "expression is missing metatype")
+ if meta == ExpressionType.INCLUDE:
+ continue
+
check_name_is_str(expr[meta], info, "'%s'" % meta)
name = cast(str, expr[meta])
info.set_defn(meta, name)
@@ -630,21 +647,7 @@ def check_exprs(exprs: List[_JSONObject]) -> List[_JSONObject]:
raise QAPISemError(info,
"documentation comment required")
- if meta == 'enum':
- check_enum(expr, info)
- elif meta == 'union':
- check_union(expr, info)
- elif meta == 'alternate':
- check_alternate(expr, info)
- elif meta == 'struct':
- check_struct(expr, info)
- elif meta == 'command':
- check_command(expr, info)
- elif meta == 'event':
- check_event(expr, info)
- else:
- assert False, 'unexpected meta type'
-
+ _CHECK_FN[meta](expr, info)
check_if(expr, info, meta)
check_features(expr.get('features'), info)
check_flags(expr, info)
--
2.30.2
next prev parent reply other threads:[~2021-03-25 6:29 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-25 6:03 [PATCH v4 00/19] qapi: static typing conversion, pt3 John Snow
2021-03-25 6:03 ` [PATCH v4 01/19] qapi/expr: Comment cleanup John Snow
2021-03-25 15:41 ` Markus Armbruster
2021-03-25 20:06 ` John Snow
2021-03-25 6:03 ` [PATCH v4 02/19] flake8: Enforce shorter line length for comments and docstrings John Snow
2021-03-25 15:21 ` Markus Armbruster
2021-03-25 20:20 ` John Snow
2021-03-26 6:26 ` Markus Armbruster
2021-03-26 16:30 ` John Snow
2021-03-26 16:44 ` Peter Maydell
2021-04-08 8:32 ` Markus Armbruster
2021-04-08 8:58 ` Daniel P. Berrangé
2021-04-09 9:33 ` Markus Armbruster
2021-04-09 17:08 ` John Snow
2021-04-08 8:35 ` Markus Armbruster
2021-04-16 12:44 ` Markus Armbruster
2021-04-16 20:25 ` John Snow
2021-04-17 10:52 ` Markus Armbruster
2021-04-20 18:06 ` John Snow
2021-03-25 6:03 ` [PATCH v4 03/19] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow
2021-03-25 6:03 ` [PATCH v4 04/19] qapi/expr.py: Check for dict instead of OrderedDict John Snow
2021-03-25 6:03 ` [PATCH v4 05/19] qapi/expr.py: constrain incoming expression types John Snow
2021-03-25 14:04 ` Markus Armbruster
2021-03-25 20:48 ` John Snow
2021-03-26 5:40 ` Markus Armbruster
2021-03-26 17:12 ` John Snow
2021-03-25 6:03 ` [PATCH v4 06/19] qapi/expr.py: Add assertion for union type 'check_dict' John Snow
2021-03-25 6:03 ` [PATCH v4 07/19] qapi/expr.py: move string check upwards in check_type John Snow
2021-03-25 6:03 ` [PATCH v4 08/19] qapi: add tests for invalid 'data' field type John Snow
2021-03-25 14:24 ` Markus Armbruster
2021-03-25 6:03 ` [PATCH v4 09/19] qapi/expr.py: Check type of 'data' member John Snow
2021-03-25 14:26 ` Markus Armbruster
2021-03-25 21:04 ` John Snow
2021-03-25 6:03 ` [PATCH v4 10/19] qapi/expr.py: Add casts in a few select cases John Snow
2021-03-25 14:33 ` Markus Armbruster
2021-03-25 23:32 ` John Snow
2021-03-25 6:03 ` [PATCH v4 11/19] qapi/expr.py: Modify check_keys to accept any Collection John Snow
2021-03-25 14:45 ` Markus Armbruster
2021-03-25 23:37 ` John Snow
2021-03-25 6:03 ` [PATCH v4 12/19] qapi/expr.py: add type hint annotations John Snow
2021-03-25 6:03 ` [PATCH v4 13/19] qapi/expr.py: Consolidate check_if_str calls in check_if John Snow
2021-03-25 15:15 ` Markus Armbruster
2021-03-26 0:07 ` John Snow
2021-03-25 6:03 ` [PATCH v4 14/19] qapi/expr.py: Remove single-letter variable John Snow
2021-03-25 6:03 ` [PATCH v4 15/19] qapi/expr.py: enable pylint checks John Snow
2021-03-25 6:03 ` [PATCH v4 16/19] qapi/expr.py: Add docstrings John Snow
2021-04-14 15:04 ` Markus Armbruster
2021-04-17 1:00 ` John Snow
2021-04-17 13:18 ` Markus Armbruster
2021-04-21 1:27 ` John Snow
2021-04-21 13:58 ` Markus Armbruster
2021-04-21 18:20 ` John Snow
2021-03-25 6:03 ` [PATCH v4 17/19] qapi/expr.py: Use tuples instead of lists for static data John Snow
2021-03-25 15:19 ` Markus Armbruster
2021-03-25 6:03 ` [PATCH v4 18/19] qapi/expr.py: move related checks inside check_xxx functions John Snow
2021-03-25 6:03 ` John Snow [this message]
2021-03-25 15:46 ` [PATCH v4 00/19] qapi: static typing conversion, pt3 Markus Armbruster
2021-03-26 0:40 ` John Snow
2021-03-26 18:01 ` 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=20210325060356.4040114-20-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).