qapi/schema: add _check_complete flag

Instead of using the None value for the members field, use a dedicated
flag to detect recursive misconfigurations.

This is intended to assist with subsequent patches that seek to remove
the "None" value from the members field (which can never hold that value
after the final call to check()) in order to simplify the static typing
of that field; avoiding the need of assertions littered at many
callsites to eliminate the possibility of the None value.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240315152301.3621858-16-armbru@redhat.com>
This commit is contained in:
John Snow 2024-03-15 16:22:51 +01:00 committed by Markus Armbruster
parent 8b9e7fd3b3
commit 875f624232

View file

@ -450,12 +450,13 @@ def __init__(self, name, info, doc, ifcond, features,
self.local_members = local_members self.local_members = local_members
self.variants = variants self.variants = variants
self.members = None self.members = None
self._check_complete = False
def check(self, schema): def check(self, schema):
# This calls another type T's .check() exactly when the C # This calls another type T's .check() exactly when the C
# struct emitted by gen_object() contains that T's C struct # struct emitted by gen_object() contains that T's C struct
# (pointers don't count). # (pointers don't count).
if self.members is not None: if self._check_complete:
# A previous .check() completed: nothing to do # A previous .check() completed: nothing to do
return return
if self._checked: if self._checked:
@ -464,7 +465,7 @@ def check(self, schema):
"object %s contains itself" % self.name) "object %s contains itself" % self.name)
super().check(schema) super().check(schema)
assert self._checked and self.members is None assert self._checked and not self._check_complete
seen = OrderedDict() seen = OrderedDict()
if self._base_name: if self._base_name:
@ -487,7 +488,8 @@ def check(self, schema):
self.variants.check(schema, seen) self.variants.check(schema, seen)
self.variants.check_clash(self.info, seen) self.variants.check_clash(self.info, seen)
self.members = members # mark completed self.members = members
self._check_complete = True # mark completed
# Check that the members of this type do not cause duplicate JSON members, # Check that the members of this type do not cause duplicate JSON members,
# and update seen to track the members seen so far. Report any errors # and update seen to track the members seen so far. Report any errors