From: John Snow Date: Tue, 11 Mar 2025 03:42:47 +0000 (-0400) Subject: docs/qapidoc: prepare to record entity being transmogrified X-Git-Tag: v10.0.0-rc0~11^2~15 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=38a349ff5b9ae583fe8a66e3e507ea9954b1aeb1;p=thirdparty%2Fqemu.git docs/qapidoc: prepare to record entity being transmogrified Prepare to keep a record of which entity we're working on documenting for the purposes of being able to change certain generative features conditionally and create stronger assertions. If you find yourself asking: "Wait, but where does the current entity actually get recorded?!", you're right! That part comes with the visit_entity() implementation, which gets added later. This patch is front-loaded for the sake of type checking in the forthcoming commits before visit_entity() is ready to be added. Signed-off-by: John Snow Message-ID: <20250311034303.75779-50-jsnow@redhat.com> Acked-by: Markus Armbruster Signed-off-by: Markus Armbruster --- diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 208d7ca144..47c2eeef87 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -78,9 +78,15 @@ __version__ = "1.0" class Transmogrifier: def __init__(self) -> None: + self._curr_ent: Optional[QAPISchemaDefinition] = None self._result = StringList() self.indent = 0 + @property + def entity(self) -> QAPISchemaDefinition: + assert self._curr_ent is not None + return self._curr_ent + # General-purpose rST generation functions def get_indent(self) -> str: