From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: jsnow@redhat.com, peter.maydell@linaro.org, michael.roth@amd.com
Subject: [PATCH v5 06/25] qapi/schema: declare type for QAPISchemaObjectTypeMember.type
Date: Fri, 15 Mar 2024 16:22:42 +0100 [thread overview]
Message-ID: <20240315152301.3621858-7-armbru@redhat.com> (raw)
In-Reply-To: <20240315152301.3621858-1-armbru@redhat.com>
From: John Snow <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>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@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 b298c8b4f9..307f8af01a 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-15 15:25 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-15 15:22 [PATCH v5 00/25] qapi: statically type schema.py Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 01/25] qapi/parser: fix typo - self.returns.info => self.errors.info Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 02/25] qapi/parser: shush up pylint Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 03/25] qapi: sort pylint suppressions Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 04/25] qapi/schema: add " Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 05/25] qapi: create QAPISchemaDefinition Markus Armbruster
2024-03-15 15:22 ` Markus Armbruster [this message]
2024-03-15 15:22 ` [PATCH v5 07/25] qapi/schema: declare type for QAPISchemaArrayType.element_type Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 08/25] qapi/schema: make c_type() and json_type() abstract methods Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 09/25] qapi/schema: adjust type narrowing for mypy's benefit Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 10/25] qapi/schema: add type narrowing to lookup_type() Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 11/25] qapi/schema: assert resolve_type has 'info' and 'what' args on error Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 12/25] qapi: Assert built-in types exist Markus Armbruster
2024-03-19 15:24 ` John Snow
2024-03-15 15:22 ` [PATCH v5 13/25] qapi/schema: fix QAPISchemaArrayType.check's call to resolve_type Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 14/25] qapi/schema: assert info is present when necessary Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 15/25] qapi/schema: add _check_complete flag Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 16/25] qapi/schema: Don't initialize "members" with `None` Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 17/25] qapi/schema: fix typing for QAPISchemaVariants.tag_member Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 18/25] qapi/schema: assert inner type of QAPISchemaVariants in check_clash() Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 19/25] qapi/parser: demote QAPIExpression to Dict[str, Any] Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 20/25] qapi/parser.py: assert member.info is present in connect_member Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 21/25] qapi/schema: add type hints Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 22/25] qapi/schema: turn on mypy strictness Markus Armbruster
2024-03-15 15:22 ` [PATCH v5 23/25] qapi/schema: remove unnecessary asserts Markus Armbruster
2024-03-15 15:23 ` [PATCH v5 24/25] qapi: Tighten check whether implicit object type already exists Markus Armbruster
2024-03-15 16:39 ` Philippe Mathieu-Daudé
2024-03-19 15:30 ` John Snow
2024-03-19 16:02 ` Markus Armbruster
2024-03-19 16:06 ` John Snow
2024-03-15 15:23 ` [PATCH v5 25/25] qapi: Dumb down QAPISchema.lookup_entity() Markus Armbruster
2024-03-18 9:11 ` Markus Armbruster
2024-03-19 15:32 ` John Snow
2024-03-19 18:23 ` [PATCH v5 00/25] qapi: statically type schema.py 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=20240315152301.3621858-7-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=jsnow@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).