From: John Snow <jsnow@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: Michael Roth <mdroth@linux.vnet.ibm.com>,
qemu-devel@nongnu.org, John Snow <jsnow@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [PATCH 24/25] qapi/schema.py: Add module docstring
Date: Tue, 22 Sep 2020 18:45:00 -0400 [thread overview]
Message-ID: <20200922224501.4087749-25-jsnow@redhat.com> (raw)
In-Reply-To: <20200922224501.4087749-1-jsnow@redhat.com>
Add some microdocumentation that gives a nice file-level overview of
this 1300+ line file.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/schema.py | 36 +++++++++++++++++++++++++++++++++---
1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index 6ecbc2aa6b..baafe3babf 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -1,7 +1,37 @@
# -*- coding: utf-8 -*-
-#
-# QAPI schema internal representation
-#
+"""
+QAPI Schema internal representation.
+
+The `QAPISchema` represents the fully realized QAPI schema. It builds a
+listing of `QAPISchemaEntity` objects that are each associated with a
+`QAPISchemaModule`.
+
+`QAPISchemaMember` represents a single member of a collection of
+members, see the subclasses thereof for users. `QAPISchemaVariants` is a
+simple collection of `QAPISchemaVariant`.
+
+The `QAPISchemaVisitor` can be extended and passed to QAPISchema.visit
+to iterate over a schema and perform code generation tasks.
+
+The Python class hierarchy at a glance:
+
+`QAPISchemaEntity`
+ `QAPISchemaInclude`
+ `QAPISchemaCommand`
+ `QAPISchemaEvent`
+ `QAPISchemaType`
+ `QAPISchemaBuiltinType`
+ `QAPISchemaEnumType`
+ `QAPISchemaArrayType`
+ `QAPISchemaObjectType`
+ `QAPISchemaAlternateType`
+
+`QAPISchemaMember`
+ `QAPISchemaEnumMember`
+ `QAPISchemaFeature`
+ `QAPISchemaObjectTypeMember`
+ `QAPISchemaVariant`
+"""
# Copyright (c) 2015-2019 Red Hat Inc.
#
# Authors:
--
2.26.2
next prev parent reply other threads:[~2020-09-22 23:10 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-22 22:44 [PATCH 00/25] qapi: static typing conversion, pt6 John Snow
2020-09-22 22:44 ` [PATCH 01/25] qapi/schema: add Visitable mixin John Snow
2020-09-22 22:44 ` [PATCH 02/25] qapi/schema.py: Move meta-type into class instances John Snow
2020-09-22 22:44 ` [PATCH 03/25] qapi/schema.py: add assert in stub methods John Snow
2020-09-22 22:44 ` [PATCH 04/25] qapi/schema.py: constrain QAPISchemaObjectType base type John Snow
2020-09-22 22:44 ` [PATCH 05/25] qapi/schema.py: constrain QAPISchemaObjectTypeMember arg_type type John Snow
2020-09-22 22:44 ` [PATCH 06/25] qapi/schema.py: constrain QAPISchemaEvent " John Snow
2020-09-22 22:44 ` [PATCH 07/25] qapi/schema.py: constrain tag_member type John Snow
2020-09-22 22:44 ` [PATCH 08/25] qapi/schema.py: Allow alternate_type to assert John Snow
2020-09-22 22:44 ` [PATCH 09/25] qapi/schema.py: remove superfluous assert John Snow
2020-09-22 22:44 ` [PATCH 10/25] qapi/schema.py: Add assertion to ifcond property John Snow
2020-09-22 22:44 ` [PATCH 11/25] qapi/schema.py: Constrain type of QAPISchemaObjectType members field John Snow
2020-09-22 22:44 ` [PATCH 12/25] qapi/schema.py: remove 'and' from non-bool rvalue expressions John Snow
2020-09-22 22:44 ` [PATCH 13/25] qapi/schema.py: Test type of self.ret_type instead of local temp John Snow
2020-09-22 22:44 ` [PATCH 14/25] qapi/schema.py: Assert variants of an object are also objects John Snow
2020-09-22 22:44 ` [PATCH 15/25] qapi/schema.py: add type hint annotations John Snow
2020-09-22 22:44 ` [PATCH 16/25] qapi/schema.py: enable checking John Snow
2020-09-22 22:44 ` [PATCH 17/25] qapi: Disable similarity checks in pylint entirely John Snow
2020-09-22 22:44 ` [PATCH 18/25] qapi/schema.py: Add pylint warning suppressions John Snow
2020-09-22 22:44 ` [PATCH 19/25] qapi/schema.py: Convert several methods to classmethods John Snow
2020-09-22 22:44 ` [PATCH 20/25] qapi/schema.py: Replace one-letter variable names John Snow
2020-09-22 22:44 ` [PATCH 21/25] qapi/schema.py: disable pylint line limit John Snow
2020-09-22 22:44 ` [PATCH 22/25] qapi/schema.py: Ignore unused argument for check() John Snow
2020-09-22 22:44 ` [PATCH 23/25] qapi/schema.py: enable pylint checks John Snow
2020-09-22 22:45 ` John Snow [this message]
2020-09-22 22:45 ` [PATCH 25/25] qapi/schema.py: Use python3 style super() John Snow
2020-10-22 14:51 ` [PATCH 00/25] qapi: static typing conversion, pt6 John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200922224501.4087749-25-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).