From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
Michael Roth <michael.roth@amd.com>,
Markus Armbruster <armbru@redhat.com>,
John Snow <jsnow@redhat.com>
Subject: [PATCH v4 06/23] qapi/schema: declare type for QAPISchemaObjectTypeMember.type
Date: Wed, 13 Mar 2024 00:41:10 -0400 [thread overview]
Message-ID: <20240313044127.49089-7-jsnow@redhat.com> (raw)
In-Reply-To: <20240313044127.49089-1-jsnow@redhat.com>
A QAPISchemaObjectTypeMember's type gets resolved only during .check().
We have QAPISchemaObjectTypeMember.__init__() initialize self.type =
None, and .check() assign the actual type. Using .type before .check()
is wrong, and hopefully crashes due to the value being None. Works.
However, it makes for awkward typing. With .type:
Optional[QAPISchemaType], mypy is of course unable to see that it's None
before .check(), and a QAPISchemaType after. To help it over the hump,
we'd have to assert self.type is not None before all the (valid) uses.
The assertion catches invalid uses, but only at run time; mypy can't
flag them.
Instead, declare .type in .__init__() as QAPISchemaType *without*
initializing it. Using .type before .check() now certainly crashes,
which is an improvement. Mypy still can't flag invalid uses, but that's
okay.
Addresses typing errors such as these:
qapi/schema.py:657: error: "None" has no attribute "alternate_qtype" [attr-defined]
qapi/schema.py:662: error: "None" has no attribute "describe" [attr-defined]
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/schema.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index da273c1649d..8440a7243d8 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -786,7 +786,7 @@ def __init__(self, name, info, typ, optional, ifcond=None, features=None):
assert isinstance(f, QAPISchemaFeature)
f.set_defined_in(name)
self._type_name = typ
- self.type = None
+ self.type: QAPISchemaType # set during check()
self.optional = optional
self.features = features or []
--
2.44.0
next prev parent reply other threads:[~2024-03-13 4:43 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-13 4:41 [PATCH v4 00/23] qapi: statically type schema.py John Snow
2024-03-13 4:41 ` [PATCH v4 01/23] qapi/parser: fix typo - self.returns.info => self.errors.info John Snow
2024-03-13 10:17 ` Philippe Mathieu-Daudé
2024-03-13 11:06 ` Markus Armbruster
2024-03-13 4:41 ` [PATCH v4 02/23] qapi/parser: shush up pylint John Snow
2024-03-13 4:41 ` [PATCH v4 03/23] qapi: sort pylint suppressions John Snow
2024-03-13 4:41 ` [PATCH v4 04/23] qapi/schema: add " John Snow
2024-03-13 4:41 ` [PATCH v4 05/23] qapi: create QAPISchemaDefinition John Snow
2024-03-14 9:12 ` Markus Armbruster
2024-03-14 13:32 ` John Snow
2024-03-14 14:04 ` Markus Armbruster
2024-03-14 14:20 ` John Snow
2024-03-13 4:41 ` John Snow [this message]
2024-03-13 4:41 ` [PATCH v4 07/23] qapi/schema: declare type for QAPISchemaArrayType.element_type John Snow
2024-03-13 4:41 ` [PATCH v4 08/23] qapi/schema: make c_type() and json_type() abstract methods John Snow
2024-03-13 4:41 ` [PATCH v4 09/23] qapi/schema: adjust type narrowing for mypy's benefit John Snow
2024-03-13 4:41 ` [PATCH v4 10/23] qapi/schema: add type narrowing to lookup_type() John Snow
2024-03-13 4:41 ` [PATCH v4 11/23] qapi/schema: assert resolve_type has 'info' and 'what' args on error John Snow
2024-03-13 4:41 ` [PATCH v4 12/23] qapi: use schema.resolve_type instead of schema.lookup_type John Snow
2024-03-13 4:41 ` [PATCH v4 13/23] qapi/schema: fix QAPISchemaArrayType.check's call to resolve_type John Snow
2024-03-13 4:41 ` [PATCH v4 14/23] qapi/schema: assert info is present when necessary John Snow
2024-03-13 4:41 ` [PATCH v4 15/23] qapi/schema: add _check_complete flag John Snow
2024-03-13 4:41 ` [PATCH v4 16/23] qapi/schema: Don't initialize "members" with `None` John Snow
2024-03-14 13:01 ` Markus Armbruster
2024-03-14 13:35 ` John Snow
2024-03-14 13:58 ` Markus Armbruster
2024-03-14 13:59 ` John Snow
2024-03-13 4:41 ` [PATCH v4 17/23] qapi/schema: fix typing for QAPISchemaVariants.tag_member John Snow
2024-03-13 4:41 ` [PATCH v4 18/23] qapi/schema: assert inner type of QAPISchemaVariants in check_clash() John Snow
2024-03-13 4:41 ` [PATCH v4 19/23] qapi/parser: demote QAPIExpression to Dict[str, Any] John Snow
2024-03-13 4:41 ` [PATCH v4 20/23] qapi/parser.py: assert member.info is present in connect_member John Snow
2024-03-13 4:41 ` [PATCH v4 21/23] qapi/schema: add type hints John Snow
2024-03-15 14:03 ` Markus Armbruster
2024-03-15 17:37 ` John Snow
2024-03-13 4:41 ` [PATCH v4 22/23] qapi/schema: turn on mypy strictness John Snow
2024-03-13 4:41 ` [PATCH v4 23/23] qapi/schema: remove unnecessary asserts John Snow
2024-03-14 14:43 ` [PATCH v4 00/23] qapi: statically type schema.py Markus Armbruster
2024-03-14 14:44 ` 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=20240313044127.49089-7-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--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).