[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 06/25] qapi/schema: declare type for QAPISchemaObjectTypeMembe
From: |
Markus Armbruster |
Subject: |
[PATCH v5 06/25] qapi/schema: declare type for QAPISchemaObjectTypeMember.type |
Date: |
Fri, 15 Mar 2024 16:22:42 +0100 |
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
- [PATCH v5 00/25] qapi: statically type schema.py, Markus Armbruster, 2024/03/15
- [PATCH v5 04/25] qapi/schema: add pylint suppressions, Markus Armbruster, 2024/03/15
- [PATCH v5 06/25] qapi/schema: declare type for QAPISchemaObjectTypeMember.type,
Markus Armbruster <=
- [PATCH v5 03/25] qapi: sort pylint suppressions, Markus Armbruster, 2024/03/15
- [PATCH v5 13/25] qapi/schema: fix QAPISchemaArrayType.check's call to resolve_type, Markus Armbruster, 2024/03/15
- [PATCH v5 10/25] qapi/schema: add type narrowing to lookup_type(), Markus Armbruster, 2024/03/15
- [PATCH v5 09/25] qapi/schema: adjust type narrowing for mypy's benefit, Markus Armbruster, 2024/03/15
- [PATCH v5 16/25] qapi/schema: Don't initialize "members" with `None`, Markus Armbruster, 2024/03/15
- [PATCH v5 14/25] qapi/schema: assert info is present when necessary, Markus Armbruster, 2024/03/15
- [PATCH v5 12/25] qapi: Assert built-in types exist, Markus Armbruster, 2024/03/15
- [PATCH v5 20/25] qapi/parser.py: assert member.info is present in connect_member, Markus Armbruster, 2024/03/15
- [PATCH v5 22/25] qapi/schema: turn on mypy strictness, Markus Armbruster, 2024/03/15