From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Markus Armbruster <armbru@redhat.com>
Subject: [PATCH v5 00/36] qapi: static typing conversion, pt1
Date: Mon, 5 Oct 2020 15:51:22 -0400 [thread overview]
Message-ID: <20201005195158.2348217-1-jsnow@redhat.com> (raw)
Hi, this series adds static type hints to the QAPI module.
This is part one!
Part 1: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt1
Everything: https://gitlab.com/jsnow/qemu/-/tree/python-qapi-cleanup-pt6
- Requires Python 3.6+
- Requires mypy 0.770 or newer (for type analysis only)
- Requires pylint 2.6.0 or newer (for lint checking only)
In general, this series tackles the cleanup of one individual QAPI
module at a time. Once it passes pylint or mypy checks, those checks are
enabled for that file.
Type hints are added in patches that add *only* type hints and change no
other behavior. Any necessary changes to behavior to accommodate typing
are split out into their own tiny patches.
Notes:
- After patch 07, `isort -c` should pass 100% on this and every
future commit.
- After patch 08, `flake8 qapi/` should pass 100% on this and every
future commit.
- After patch 09, `pylint --rcfile=qapi/pylintrc qapi/` should pass 100%
on this and every future commit.
- After patch 18, `mypy --config-file=qapi/mypy.ini qapi/` should pass
100% on this and every future commit.
Review Status:
[01] docs-repair-broken-references #
[02] qapi-modify-docstrings-to-be #
[03] qapi-gen-separate-arg-parsing # [RB] CR,EH [TB] CR [SOB] JS
[04] qapi-move-generator-entrypoint # [RB] CR,EH [TB] CR [SOB] JS
[05] qapi-prefer-explicit-relative # [RB] CR,EH [SOB] JS
[06] qapi-remove-wildcard-includes # [RB] CR,EH [SOB] JS
[07] qapi-enforce-import-order # [RB] CR [TB] CR [SOB] JS
[08] qapi-delint-using-flake8 # [RB] CR,EH [SOB] JS
[09] qapi-add-pylintrc # [RB] CR [TB] CR,EH [SOB] JS
[10] qapi-common-py-remove-python # [RB] CR,EH [SOB] JS
[11] qapi-common-add-indent-manager # [RB] CR,EH [SOB] JS
[12] qapi-common-py-delint-with # [RB] CR,EH [SOB] JS
[13] replace-c-by-char # [RB] CR,EH [SOB] JS
[14] qapi-common-py-check-with # [RB] CR [TB] CR,EH [SOB] JS
[15] qapi-common-py-add-notational # [RB] CR,EH [SOB] JS
[16] qapi-common-move-comments-into # [RB] CR,EH [SOB] JS
[17] qapi-split-build_params-into # [RB] CR,EH [SOB] JS
[18] qapi-establish-mypy-type # [RB] CR [TB] CR,EH [SOB] JS
[19] qapi-events-py-add-notational # [RB] CR,EH [SOB] JS
[20] qapi-events-move-comments-into # [RB] CR,EH [SOB] JS
[21] qapi-commands-py-don-t-re-bind # [RB] CR,EH [SOB] JS
[22] qapi-commands-py-add # [RB] CR,EH [SOB] JS
[23] qapi-commands-py-enable # [RB] CR,EH [SOB] JS
[24] qapi-source-py-add-notational # [RB] CR,EH [TB] CR [SOB] JS
[25] qapi-source-py-delint-with # [RB] CR,EH [TB] CR [SOB] JS
[26] qapi-gen-py-fix-edge-case-of # [RB] CR,EH [SOB] JS
[27] qapi-gen-py-add-notational # [RB] CR,EH [SOB] JS
[28] qapi-gen-py-enable-checking # [RB] CR,EH [TB] CR [SOB] JS
[29] qapi-gen-py-remove-unused # [RB] CR,EH [SOB] JS
[30] qapi-gen-py-update-write-to-be # [RB] CR,EH [SOB] JS
[31] qapi-gen-py-delint-with-pylint # [RB] CR,EH [SOB] JS
[32] qapi-types-py-add-type-hint # [RB] CR,EH [SOB] JS
[33] qapi-types-py-remove-one # [RB] CR,EH [SOB] JS
[34] qapi-visit-py-assert # [RB] CR,EH [SOB] JS
[35] qapi-visit-py-remove-unused # [RB] CR,EH [TB] CR [SOB] JS
[36] qapi-visit-py-add-notational # [RB] CR,EH [TB] CR [SOB] JS
Changelog:
002/36:[0012] [FC] 'qapi: modify docstrings to be sphinx-compatible'
027/36:[----] [-C] 'qapi/gen.py: add type hint annotations'
V5:
- Remove DO-NOT-MERGE patches (Now in Part2)
- Remove introspect.py patches (Now in Part2)
- 02: Docstring formatting, more commit message (Markus)
V4:
- Rebase on Peter Maydell's work;
- 05: Context differences from Peter Maydell's work
- 06: Remove qapi.doc
- 07: Remove qapi.doc, remove superfluous "if match"
- 09: Remove qapi.doc
- 13: remove qapi.doc
- 18: remove qapi.doc
- 22: remove qapi.doc
- 31: remove QAPIGenDoc changes
- Minor adjustments from list feedback;
- 01: More backticks for QAPI json files, now that they are in Sphinx-exe
- 02: Use :ref: role for the `docker-ref` cross-reference
- 04: Remove doc.py work changes; add references for start_if/end_if
- 10: Changes to accommodate isort
- 11: Added lines_after_imports=2
- 16: isort whitespace changes
- 24: Take Markus's docstring phrasing
- 34: add comment explaining os.open()
- 37: isort differences
V3:
- Use isort to enforce import consistency
- Use sphinx apidoc to check docstring format
V2:
- Removed Python3.6 patch in favor of Thomas Huth's
- Addressed (most) feedback from Markus
- Renamed type hint annotation commits
John Snow (36):
docs: repair broken references
qapi: modify docstrings to be sphinx-compatible
qapi-gen: Separate arg-parsing from generation
qapi: move generator entrypoint into module
qapi: Prefer explicit relative imports
qapi: Remove wildcard includes
qapi: enforce import order/styling with isort
qapi: delint using flake8
qapi: add pylintrc
qapi/common.py: Remove python compatibility workaround
qapi/common.py: Add indent manager
qapi/common.py: delint with pylint
qapi/common.py: Replace one-letter 'c' variable
qapi/common.py: check with pylint
qapi/common.py: add type hint annotations
qapi/common.py: Convert comments into docstrings, and elaborate
qapi/common.py: move build_params into gen.py
qapi: establish mypy type-checking baseline
qapi/events.py: add type hint annotations
qapi/events.py: Move comments into docstrings
qapi/commands.py: Don't re-bind to variable of different type
qapi/commands.py: add type hint annotations
qapi/commands.py: enable checking with mypy
qapi/source.py: add type hint annotations
qapi/source.py: delint with pylint
qapi/gen.py: Fix edge-case of _is_user_module
qapi/gen.py: add type hint annotations
qapi/gen.py: Enable checking with mypy
qapi/gen.py: Remove unused parameter
qapi/gen.py: update write() to be more idiomatic
qapi/gen.py: delint with pylint
qapi/types.py: add type hint annotations
qapi/types.py: remove one-letter variables
qapi/visit.py: assert tag_member contains a QAPISchemaEnumType
qapi/visit.py: remove unused parameters from gen_visit_object
qapi/visit.py: add type hint annotations
docs/devel/multi-thread-tcg.rst | 2 +-
docs/devel/testing.rst | 2 +-
scripts/qapi-gen.py | 57 ++--------
scripts/qapi/.flake8 | 2 +
scripts/qapi/.isort.cfg | 7 ++
scripts/qapi/commands.py | 87 +++++++++++----
scripts/qapi/common.py | 163 +++++++++++++++-------------
scripts/qapi/events.py | 58 +++++++---
scripts/qapi/expr.py | 7 +-
scripts/qapi/gen.py | 182 ++++++++++++++++++++------------
scripts/qapi/introspect.py | 16 ++-
scripts/qapi/main.py | 89 ++++++++++++++++
scripts/qapi/mypy.ini | 30 ++++++
scripts/qapi/parser.py | 7 +-
scripts/qapi/pylintrc | 70 ++++++++++++
scripts/qapi/schema.py | 33 +++---
scripts/qapi/source.py | 34 +++---
scripts/qapi/types.py | 125 +++++++++++++++-------
scripts/qapi/visit.py | 116 ++++++++++++++------
19 files changed, 752 insertions(+), 335 deletions(-)
create mode 100644 scripts/qapi/.flake8
create mode 100644 scripts/qapi/.isort.cfg
create mode 100644 scripts/qapi/main.py
create mode 100644 scripts/qapi/mypy.ini
create mode 100644 scripts/qapi/pylintrc
--
2.26.2
next reply other threads:[~2020-10-05 19:56 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 19:51 John Snow [this message]
2020-10-05 19:51 ` [PATCH v5 01/36] docs: repair broken references John Snow
2020-10-05 19:51 ` [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible John Snow
2020-10-06 11:21 ` Markus Armbruster
2020-10-06 15:23 ` John Snow
2020-10-07 7:24 ` Markus Armbruster
2020-10-07 17:00 ` John Snow
2020-10-05 19:51 ` [PATCH v5 03/36] qapi-gen: Separate arg-parsing from generation John Snow
2020-10-06 11:51 ` Markus Armbruster
2020-10-06 15:59 ` John Snow
2020-10-07 7:54 ` Markus Armbruster
2020-10-07 14:52 ` John Snow
2020-10-08 5:56 ` Markus Armbruster
2020-10-08 17:33 ` John Snow
2020-10-06 16:46 ` John Snow
2020-10-07 8:07 ` Markus Armbruster
2020-10-07 14:36 ` John Snow
2020-10-08 6:51 ` Markus Armbruster
2020-10-08 16:37 ` John Snow
2020-10-08 16:50 ` John Snow
2020-10-09 7:12 ` Markus Armbruster
2020-10-07 8:12 ` Markus Armbruster
2020-10-07 14:41 ` John Snow
2020-10-08 7:15 ` Markus Armbruster
2020-10-08 17:14 ` John Snow
2020-10-09 7:19 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 04/36] qapi: move generator entrypoint into module John Snow
2020-10-05 19:51 ` [PATCH v5 05/36] qapi: Prefer explicit relative imports John Snow
2020-10-06 11:33 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 06/36] qapi: Remove wildcard includes John Snow
2020-10-06 11:34 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 07/36] qapi: enforce import order/styling with isort John Snow
2020-10-07 8:15 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 08/36] qapi: delint using flake8 John Snow
2020-10-07 8:19 ` Markus Armbruster
2020-10-07 14:54 ` John Snow
2020-10-05 19:51 ` [PATCH v5 09/36] qapi: add pylintrc John Snow
2020-10-05 19:51 ` [PATCH v5 10/36] qapi/common.py: Remove python compatibility workaround John Snow
2020-10-05 19:51 ` [PATCH v5 11/36] qapi/common.py: Add indent manager John Snow
2020-10-07 8:50 ` Markus Armbruster
2020-10-07 18:08 ` John Snow
2020-10-07 18:18 ` Eduardo Habkost
2020-10-08 7:23 ` Markus Armbruster
2020-10-08 17:45 ` John Snow
2020-10-05 19:51 ` [PATCH v5 12/36] qapi/common.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 13/36] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-10-06 11:35 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 14/36] qapi/common.py: check with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 15/36] qapi/common.py: add type hint annotations John Snow
2020-10-07 9:03 ` Markus Armbruster
2020-10-07 15:01 ` John Snow
2020-10-05 19:51 ` [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-10-07 9:14 ` Markus Armbruster
2020-10-07 15:23 ` John Snow
2020-10-08 7:20 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 17/36] qapi/common.py: move build_params into gen.py John Snow
2020-10-07 9:21 ` Markus Armbruster
2020-10-07 15:26 ` John Snow
2020-10-07 18:10 ` Eduardo Habkost
2020-10-05 19:51 ` [PATCH v5 18/36] qapi: establish mypy type-checking baseline John Snow
2020-10-07 9:25 ` Markus Armbruster
2020-10-07 15:33 ` John Snow
2020-10-08 7:29 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 19/36] qapi/events.py: add type hint annotations John Snow
2020-10-07 11:32 ` Markus Armbruster
2020-10-07 11:49 ` Markus Armbruster
2020-10-07 15:46 ` John Snow
2020-10-08 9:16 ` Markus Armbruster
2020-10-08 16:19 ` John Snow
2020-10-09 7:21 ` Markus Armbruster
2020-10-07 15:39 ` John Snow
2020-10-08 7:41 ` Markus Armbruster
2020-10-08 15:35 ` John Snow
2020-10-05 19:51 ` [PATCH v5 20/36] qapi/events.py: Move comments into docstrings John Snow
2020-10-05 19:51 ` [PATCH v5 21/36] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-10-07 11:34 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 22/36] qapi/commands.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 23/36] qapi/commands.py: enable checking with mypy John Snow
2020-10-07 11:37 ` Markus Armbruster
2020-10-07 15:49 ` John Snow
2020-10-08 7:52 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 24/36] qapi/source.py: add type hint annotations John Snow
2020-10-07 11:55 ` Markus Armbruster
2020-10-07 16:04 ` John Snow
2020-10-08 8:42 ` Markus Armbruster
2020-10-09 14:30 ` John Snow
2020-10-09 14:37 ` John Snow
2020-10-05 19:51 ` [PATCH v5 25/36] qapi/source.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 26/36] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-10-06 11:44 ` Philippe Mathieu-Daudé
2020-10-07 12:02 ` Markus Armbruster
2020-10-07 16:09 ` John Snow
2020-10-05 19:51 ` [PATCH v5 27/36] qapi/gen.py: add type hint annotations John Snow
2020-10-07 12:21 ` Markus Armbruster
2020-10-07 16:21 ` John Snow
2020-10-07 13:20 ` Markus Armbruster
2020-10-07 16:50 ` John Snow
2020-10-08 8:44 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 28/36] qapi/gen.py: Enable checking with mypy John Snow
2020-10-05 19:51 ` [PATCH v5 29/36] qapi/gen.py: Remove unused parameter John Snow
2020-10-07 12:22 ` Markus Armbruster
2020-10-07 16:23 ` John Snow
2020-10-05 19:51 ` [PATCH v5 30/36] qapi/gen.py: update write() to be more idiomatic John Snow
2020-10-07 12:32 ` Markus Armbruster
2020-10-07 16:25 ` John Snow
2020-10-05 19:51 ` [PATCH v5 31/36] qapi/gen.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 32/36] qapi/types.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 33/36] qapi/types.py: remove one-letter variables John Snow
2020-10-07 12:42 ` Markus Armbruster
2020-10-07 16:31 ` John Snow
2020-10-05 19:51 ` [PATCH v5 34/36] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-10-07 12:43 ` Markus Armbruster
2020-10-07 16:40 ` John Snow
2020-10-08 9:06 ` Markus Armbruster
2020-10-08 15:49 ` John Snow
2020-10-09 7:24 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 35/36] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-10-06 11:43 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 36/36] qapi/visit.py: add type hint annotations John Snow
2020-10-07 13:00 ` Markus Armbruster
2020-10-07 16:43 ` John Snow
2020-10-05 23:05 ` [PATCH v5 00/36] qapi: static typing conversion, pt1 Cleber Rosa
2020-10-05 23:57 ` John Snow
2020-10-06 17:51 ` Cleber Rosa
2020-10-07 13:05 ` Markus Armbruster
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=20201005195158.2348217-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.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).