From nobody Tue Jul 1 10:01:26 2025 Delivered-To: importer2@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1621452107; cv=none; d=zohomail.com; s=zohoarc; b=ig5ezi5a970wAgIcK79QoyqgQwomHEniddAMeX+1R212zO5/xg1wlHXZgDCw5iPEUTL/CGyCX8IydoeW9NXFOOWX3pSGVQy4gWy7K8GSUDjWJjIksFxzXmKVCgMmqVtgnC7xR70ednVjfCkppSgr66M9nrCcdXfIVk8a0kr6pfY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1621452107; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=sxJhdCOrXufnbDk8jQ94+7NPvX3C7enbjBd7xpEQY/Q=; b=c3s2VjQoiuxK9lAzb5xnSqGhFh+RGEp2PHc2iXnLF/tpSE2s1XUS/RnaVFqLyNBi8wKomiH3QDsYp2X8V81PZuGRFNdUtGr+Wqv//4KF2YCnXqhWulwdHl10n+KWj2Vi0z78Tamz1JKcD6gQeFNRFUq1TClPqQx9UW6YYG5/dcE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1621452107222694.8571866974983; Wed, 19 May 2021 12:21:47 -0700 (PDT) Received: from localhost ([::1]:44614 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ljRlJ-0006NP-7C for importer2@patchew.org; Wed, 19 May 2021 15:21:45 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55404) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljR7M-00069i-8Q for qemu-devel@nongnu.org; Wed, 19 May 2021 14:40:28 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:36758) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljR7A-00025q-74 for qemu-devel@nongnu.org; Wed, 19 May 2021 14:40:27 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-519-RNRtnR4hPGOlq76xCuk6tw-1; Wed, 19 May 2021 14:40:13 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 97699501F4; Wed, 19 May 2021 18:40:12 +0000 (UTC) Received: from scv.redhat.com (ovpn-117-64.rdu2.redhat.com [10.10.117.64]) by smtp.corp.redhat.com (Postfix) with ESMTP id 77BEC690EF; Wed, 19 May 2021 18:40:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1621449615; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sxJhdCOrXufnbDk8jQ94+7NPvX3C7enbjBd7xpEQY/Q=; b=McTcNxopi6EIKHOT1P3UZsfbfON/xBvVMw6JEicni3PculjfoTNZHevXPCuORuJ6QB1w/6 XJQIzlfMeAa4cfvyzxk9p0uGqWfKX2KOrAo9IpVTv/wsBi0La0mCJccCFOA+fWKKVNpyuZ dfI2chuBTXCSpOf/WL5Yx7ZnXGl8V5U= X-MC-Unique: RNRtnR4hPGOlq76xCuk6tw-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 15/15] qapi/parser: add docstrings Date: Wed, 19 May 2021 14:39:51 -0400 Message-Id: <20210519183951.3946870-16-jsnow@redhat.com> In-Reply-To: <20210519183951.3946870-1-jsnow@redhat.com> References: <20210519183951.3946870-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -31 X-Spam_score: -3.2 X-Spam_bar: --- X-Spam_report: (-3.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.39, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Michael Roth , Cleber Rosa , John Snow , Eduardo Habkost , Markus Armbruster Errors-To: qemu-devel-bounces+importer2=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Signed-off-by: John Snow --- scripts/qapi/parser.py | 69 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index b0f18c0d176..06167ed3e0a 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -47,7 +47,27 @@ def __init__(self, parser: 'QAPISchemaParser', msg: str): =20 =20 class QAPISchemaParser: + """ + Parse QAPI schema source. =20 + Parse a JSON-esque schema file and process directives. See + qapi-code-gen.txt section "Schema Syntax" for the exact syntax. + Grammatical validation is handled later by `expr.check_exprs()`. + + :param fname: Source file name. + :param previously_included: + The absolute names of previously included source files, + if being invoked from another parser. + :param incl_info: + `QAPISourceInfo` belonging to the parent module. + ``None`` implies this is the root module. + + :ivar exprs: Resulting parsed expressions. + :ivar docs: Resulting parsed documentation blocks. + + :raise OSError: For problems reading the root schema document. + :raise QAPIError: For errors in the schema source. + """ def __init__(self, fname: str, previously_included: Optional[Set[str]] =3D None, @@ -73,6 +93,11 @@ def __init__(self, self._parse() =20 def _parse(self) -> None: + """ + Parse the QAPI schema document. + + :return: None. Results are stored in ``.exprs`` and ``.docs``. + """ cur_doc =3D None =20 # May raise OSError; allow the caller to handle it. @@ -199,6 +224,50 @@ def check_list_str(name: str, value: object) -> List[s= tr]: raise QAPISemError(info, "unknown pragma '%s'" % name) =20 def accept(self, skip_comment: bool =3D True) -> None: + """ + Read and store the next token. + + :param skip_comment: + When false, return COMMENT tokens ("#"). + This is used when reading documentation blocks. + + :return: + None. Several instance attributes are updated instead: + + - ``.tok`` represents the token type. See below for values. + - ``.info`` describes the token's source location. + - ``.val`` is the token's value, if any. See below. + - ``.pos`` is the buffer index of the first character of + the token. + + * Single-character tokens: + + These are "{", "}", ":", ",", "[", and "]". ``.tok`` holds + the single character and ``.val`` is None. + + * Multi-character tokens: + + * COMMENT: + + This token is not normally returned by the lexer, but it can + be when ``skip_comment`` is False. ``.tok`` is "#", and + ``.val`` is a string including all chars until end-of-line, + including the "#" itself. + + * STRING: + + ``.tok`` is "'", the single quote. ``.val`` contains the + string, excluding the surrounding quotes. + + * TRUE and FALSE: + + ``.tok`` is either "t" or "f", ``.val`` will be the + corresponding bool value. + + * EOF: + + ``.tok`` and ``.val`` will both be None at EOF. + """ while True: self.tok =3D self.src[self.cursor] self.pos =3D self.cursor --=20 2.30.2