From nobody Thu Dec 18 17:53:29 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1734056409; cv=none; d=zohomail.com; s=zohoarc; b=j+sfxCQWafKiO0B+ylji8mraC3vPUj5uNt0DOFoHprreAORYJa04A9+oqhUtYf8932Ab4MsD/8XOl3xJAaTg+ACPe/2ZNjNSGq6XAtfNNzsN+MyR8b4F5mIyik7xPbC07GVyYHkxNXV81l8xXVHXW0CoqSEPb96owNi9JXFu/wQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734056409; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=C41CsMtOn5P8YQLX+kt2O+MZfQtgr9+myYsRY04vCDw=; b=c52SpwED2a0y2GgFD/h5nlcz6Xib17mp2rY1vGUZwq5xRePH7zqO5/dJOBoWe8m/m7k63MFcp6T4hE8PQYS7qroGseK1RSmLs1+RCEEEroSFUvFhCWsrjbY3B3sR6lInTSy5U9WPLDKgvZ88b+cWJOsNlCjIggJhNWO3zhlLj6g= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1734056409208830.9240424173161; Thu, 12 Dec 2024 18:20:09 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLvHT-0007Hu-Kz; Thu, 12 Dec 2024 21:19:52 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLvHN-0007By-EH for qemu-devel@nongnu.org; Thu, 12 Dec 2024 21:19:46 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLvHK-0007ws-LK for qemu-devel@nongnu.org; Thu, 12 Dec 2024 21:19:45 -0500 Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-441-LJU9WWPGMo-ac78EC_YHZA-1; Thu, 12 Dec 2024 21:19:37 -0500 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 7CD541955F43; Fri, 13 Dec 2024 02:19:36 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id EA307195605A; Fri, 13 Dec 2024 02:19:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734056380; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=C41CsMtOn5P8YQLX+kt2O+MZfQtgr9+myYsRY04vCDw=; b=YAG5yKhttpHFByL92URN2dRymlL2cSFntxBGoWfud3zW4bW9pKfgqoPl+HPCzCvlUhRcVX qG1Qu1AZJI7HYJVTIjB1bQECgY/hOjl1nruhZlsTUEXtzh4yLsa6x1orcGN2BBy7ygzwLe 7rKCqbhZsRYP1iwpMY6gXYXd54646To= X-MC-Unique: LJU9WWPGMo-ac78EC_YHZA-1 X-Mimecast-MFC-AGG-ID: LJU9WWPGMo-ac78EC_YHZA From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , Michael Roth , Markus Armbruster , John Snow Subject: [PATCH 14/23] docs/qapidoc: add format_type() method Date: Thu, 12 Dec 2024 21:18:17 -0500 Message-ID: <20241213021827.2956769-15-jsnow@redhat.com> In-Reply-To: <20241213021827.2956769-1-jsnow@redhat.com> References: <20241213021827.2956769-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1734056410234116600 Content-Type: text/plain; charset="utf-8" This method is responsible for generating a type name for a given member with the correct annotations for the QAPI domain. Features and enums do not *have* types, so they return None. Everything else returns the type name with a "?" suffix if that type is optional, and ensconced in [brackets] if it's an array type. Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 7ffca5e13f4..1c83d1b7aac 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -30,7 +30,7 @@ import re import sys import textwrap -from typing import List +from typing import List, Optional =20 from docutils import nodes from docutils.parsers.rst import Directive, directives @@ -38,7 +38,14 @@ from qapi.error import QAPIError, QAPISemError from qapi.gen import QAPISchemaVisitor from qapi.parser import QAPIDoc -from qapi.schema import QAPISchema, QAPISchemaEntity +from qapi.schema import ( + QAPISchema, + QAPISchemaArrayType, + QAPISchemaEntity, + QAPISchemaEnumMember, + QAPISchemaFeature, + QAPISchemaObjectTypeMember, +) from qapi.source import QAPISourceInfo =20 from sphinx import addnodes @@ -125,6 +132,25 @@ def ensure_blank_line(self) -> None: # +2: correct for zero/one index, then increment by one. self.add_line_raw("", fname, line + 2) =20 + def format_type(self, ent) -> Optional[str]: + if isinstance(ent, (QAPISchemaEnumMember, QAPISchemaFeature)): + return None + + qapi_type =3D ent + optional =3D False + if isinstance(ent, QAPISchemaObjectTypeMember): + qapi_type =3D ent.type + optional =3D ent.optional + + if isinstance(qapi_type, QAPISchemaArrayType): + ret =3D f"[{qapi_type.element_type.doc_type()}]" + else: + ret =3D qapi_type.doc_type() + if optional: + ret +=3D "?" + + return ret + # Transmogrification helpers =20 def visit_paragraph(self, section: QAPIDoc.Section) -> None: --=20 2.47.0