Re: [PATCH 00/37] qapi: static typing conversion, pt1

[John Snow]

On 9/18/20 9:07 AM, Philippe Mathieu-Daudé wrote:
> Cc'ing Ben who offered to help with having the QEMU python
> scripts packaged (and this series is a step toward that).

FWIW, I want to move ./python/qemu/ into ./python/qemu/core, and then 
move ./scripts/qapi to ./python/qemu/qapi.

I will leave the qapi-gen.py stub script behind for compatibility.

Once I've done that, I can add package setup scripts.

I have a long series adding mypy type hints and so forth to 
./python/qemu and adding packaging glue there too, but I shelved it as 
5.1 released and right now I am focusing on QAPI.

> On 9/16/20 12:39 AM, John Snow wrote:
> > Hi, this series starts adding static type hints to the QAPI module. As
> > you can see, the series started getting quite a bit long, so this is
> > only a partial conversion that focuses on a handful of the easier files.
> >
> > The tougher files -- schema.py, expr.py, parser.py -- will each receive
> > their own series as a follow-up to this one.
> >
> > Notes:
> >
> > - This requires Python 3.6+. Python 3.5 is EOL, so let's do that.
> >
> > - Any patch named "add notational type hints" changes ONLY signatures,
> >    which have no runtime impact whatsoever. These are big patches,
> >    but fairly straightforward.
> >
> > - Most other patches are as bite-sized as possible, generally fixing one
> >    single warning.
> >
> > - After patch 6, `flake8 qapi/` should pass 100% on this and every
> >    future commit.
> >
> > - After patch 7, `pylint --rcfile=qapi/pylintrc qapi/` should pass 100%
> >    on this and every future commit.
> >
> > - After patch 16, `mypy --config-file=qapi/mypy.ini qapi/` should pass
> >    100% on this and every future commit.
> >
> > Preliminary refactoring and prerequisites:
> >
> > 001/37: 'python: Require 3.6+'
> > 002/37: '[DO-NOT-MERGE] qapi: add debugging tools'
> > 003/37: 'qapi-gen: Separate arg-parsing from generation'
> > 004/37: 'qapi: move generator entrypoint into module'
> > 005/37: 'qapi: Remove wildcard includes'
> > 006/37: 'qapi: delint using flake8'
> > 007/37: 'qapi: add pylintrc'
> >
> > common.py (and params.py):
> >
> > 008/37: 'qapi/common.py: Remove python compatibility workaround'
> > 009/37: 'qapi/common.py: Add indent manager'
> > 010/37: 'qapi/common.py: delint with pylint'
> > 011/37: 'qapi/common.py: Replace one-letter 'c' variable'
> > 012/37: 'qapi/common.py: check with pylint'
> > 013/37: 'qapi/common.py: add notational type hints'
> > 014/37: 'qapi/common.py: Move comments into docstrings'
> > 015/37: 'qapi/common.py: split build_params into new file'
> > 016/37: 'qapi: establish mypy type-checking baseline'
> >
> > events.py:
> >
> > 017/37: 'qapi/events.py: add notational type hints'
> > 018/37: 'qapi/events.py: Move comments into docstrings'
> >
> > commands.py:
> >
> > 019/37: 'qapi/commands.py: Don't re-bind to variable of different type'
> > 020/37: 'qapi/commands.py: add notational type hints'
> > 021/37: 'qapi/commands.py: enable checking with mypy'
> >
> > source.py:
> >
> > 022/37: 'qapi/source.py: add notational type hints'
> > 023/37: 'qapi/source.py: delint with pylint'
> >
> > gen.py:
> >
> > 024/37: 'qapi/gen.py: Fix edge-case of _is_user_module'
> > 025/37: 'qapi/gen.py: add notational type hints'
> > 026/37: 'qapi/gen.py: Enable checking with mypy'
> > 027/37: 'qapi/gen.py: Remove unused parameter'
> > 028/37: 'qapi/gen.py: update write() to be more idiomatic'
> > 029/37: 'qapi/gen.py: delint with pylint'
> >
> > introspect.py:
> >
> > 030/37: 'qapi/introspect.py: Add a typed 'extra' structure'
> > 031/37: 'qapi/introspect.py: add _gen_features helper'
> > 032/37: 'qapi/introspect.py: create a typed 'Node' data structure'
> > 033/37: 'qapi/introspect.py: add notational type hints'
> >
> > types.py:
> >
> > 034/37: 'qapi/types.py: add notational type hints'
> > 035/37: 'qapi/types.py: remove one-letter variables'
> >
> > visit.py:
> >
> > 036/37: 'qapi/visit.py: remove unused parameters from gen_visit_object'
> > 037/37: 'qapi/visit.py: add notational type hints'