From nobody Wed Jan 29 00:18:19 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=1734052609; cv=none; d=zohomail.com; s=zohoarc; b=awGLaI1VVsnyEYEr1NmGmZ4OndHi9aupSfFspLTsIXpPhwo9W/tCeWJ2cF2d0wGu+H9o1eT0ZrIXT+/12ups2vQXsQnyWaa7bQwXdYuedAU5eRDTHE4l34CCUvHT/eIepChPGITMCNCtaO2+3xj1vPOaAWMTumPJMXmbrSMKj7w= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052609; 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=UI8k4bLF/f2KJ4I9nTVpY7xzkypAiwueEZlTj/biSjw=; b=AxZUlUCn5mUcggyt0HFMLXll3pwlQ3DPNSFUfjjcajOqlRnZ8MymtvE5l2X2tFShzhha42QGmoC+RnkVRBkjqXvx+xhppzGHtA6v/1y6OHldCYMk9MbuLxSYa/djauOahI5zOfAtNL8xl4MaPA/+d4jeQsUP05mos1yEG0TUgDQ= 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 1734052609174821.1326419053354; Thu, 12 Dec 2024 17:16:49 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuHz-0001s6-M2; Thu, 12 Dec 2024 20:16:19 -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 1tLuH7-00010X-Sb for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:28 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuH6-0000wT-5C for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:25 -0500 Received: from mx-prod-mc-02.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-652-pT8rdSG5M7CZRejPCBafhA-1; Thu, 12 Dec 2024 20:15:18 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A5B5E1956096; Fri, 13 Dec 2024 01:15:17 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 513311956086; Fri, 13 Dec 2024 01:15:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052522; 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=UI8k4bLF/f2KJ4I9nTVpY7xzkypAiwueEZlTj/biSjw=; b=Gs/WAa+X8YKGp8Q2XSCIoADx7nyCfiW7zavqZWzqGRbLWHoYVXI5jFaSrUoQckUpQw+Ty4 wlcau8MWvZTVvzliBG/0P584xW1m2KRje/AYwXs2QRDVLTCVpI3nC1iOz4S6yNL3m3hPMm MLSfEuZk//fPUi8b/pPrgccRZv4+3cs= X-MC-Unique: pT8rdSG5M7CZRejPCBafhA-1 X-Mimecast-MFC-AGG-ID: pT8rdSG5M7CZRejPCBafhA From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow Subject: [RFC PATCH v2 34/35] WIP: 3.x ObjectDesc compat Date: Thu, 12 Dec 2024 20:13:03 -0500 Message-ID: <20241213011307.2942030-35-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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.133.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: 1734052609653116600 Content-Type: text/plain; charset="utf-8" Signed-off-by: John Snow --- docs/sphinx/compat.py | 7 +++++++ docs/sphinx/qapi-domain.py | 9 +++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/compat.py b/docs/sphinx/compat.py index 5126b450a5f..b2d2d1be403 100644 --- a/docs/sphinx/compat.py +++ b/docs/sphinx/compat.py @@ -33,15 +33,22 @@ SOURCE_LOCATION_FIX =3D (5, 3, 0) <=3D sphinx.version_info[:3] < (6, 2, 0) =20 =20 +# Alias for the return of QAPIObject.handle_signature(), which is used +# in several places. (In the Python domain, this type is Tuple[str, +# str] instead.) +Signature =3D str + space_node: Callable[[str], Node] keyword_node: Callable[[str, str], Node] =20 if sphinx.version_info[:3] >=3D (4, 0, 0): space_node =3D addnodes.desc_sig_space keyword_node =3D addnodes.desc_sig_keyword + ObjectDesc =3D ObjectDescription[Signature] else: space_node =3D Text keyword_node =3D addnodes.desc_annotation + ObjectDesc =3D ObjectDescription =20 =20 def nested_parse(directive: SphinxDirective, content_node: Element) -> Non= e: diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index 00d32d44e1d..fcda281d45e 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -26,7 +26,9 @@ from compat import ( Field, GroupedField, + ObjectDesc, ParserFix, + Signature, TypedField, keyword_node, nested_parse, @@ -164,12 +166,7 @@ def since_validator(param: str) -> str: return param =20 =20 -# Alias for the return of handle_signature(), which is used in several pla= ces. -# (In the Python domain, this is Tuple[str, str] instead.) -Signature =3D str - - -class QAPIObject(ParserFix, ObjectDescription[Signature]): +class QAPIObject(ParserFix, ObjectDesc): """ Description of a generic QAPI object. =20 --=20 2.47.0