From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: Michael Roth <michael.roth@amd.com>,
Cleber Rosa <crosa@redhat.com>,
qemu-devel@nongnu.org, Eduardo Habkost <ehabkost@redhat.com>
Subject: Re: [PATCH v3 08/16] qapi/expr.py: add type hint annotations
Date: Thu, 25 Feb 2021 14:56:51 +0100 [thread overview]
Message-ID: <87wnuwb68s.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: 20210223003408.964543-9-jsnow@redhat.com
John Snow <jsnow@redhat.com> writes:
> Annotations do not change runtime behavior.
> This commit *only* adds annotations.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
> Reviewed-by: Cleber Rosa <crosa@redhat.com>
> ---
> scripts/qapi/expr.py | 71 ++++++++++++++++++++++++++++---------------
> scripts/qapi/mypy.ini | 5 ---
> 2 files changed, 46 insertions(+), 30 deletions(-)
>
> diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
> index f45d6be1f4c..df6c64950fa 100644
> --- a/scripts/qapi/expr.py
> +++ b/scripts/qapi/expr.py
> @@ -15,7 +15,14 @@
> # See the COPYING file in the top-level directory.
>
> import re
> -from typing import MutableMapping, Optional, cast
> +from typing import (
> + Iterable,
> + List,
> + MutableMapping,
> + Optional,
> + Union,
> + cast,
> +)
>
> from .common import c_name
> from .error import QAPISemError
> @@ -23,9 +30,10 @@
> from .source import QAPISourceInfo
>
>
> -# Expressions in their raw form are JSON-like structures with arbitrary forms.
> -# Minimally, their top-level form must be a mapping of strings to values.
> -Expression = MutableMapping[str, object]
> +# Arbitrary form for a JSON-like object.
> +_JSObject = MutableMapping[str, object]
> +# Expressions in their raw form are (just) JSON-like objects.
> +Expression = _JSObject
We solved a similar, slightly more involved typing problem in
introspect.py.
Whereas expr.py uses Python dict, list, and scalars to represent the
output of a JSON parser, introspect.py uses them to represent the input
of a quasi-JSON formatter ("quasi-JSON" because it spits out a C
initializer for a C representation of JSON, but that's detail).
introspect.py additionally supports comments and #if conditionals.
This is the solution we're using in introspect.py. The Annotated[] part
is for comments and conditionals; ignore that.
# This module constructs a tree data structure that is used to
# generate the introspection information for QEMU. It is shaped
# like a JSON value.
#
# A complexity over JSON is that our values may or may not be annotated.
#
# Un-annotated values may be:
# Scalar: str, bool, None.
# Non-scalar: List, Dict
# _value = Union[str, bool, None, Dict[str, JSONValue], List[JSONValue]]
#
# With optional annotations, the type of all values is:
# JSONValue = Union[_Value, Annotated[_Value]]
#
# Sadly, mypy does not support recursive types; so the _Stub alias is used to
# mark the imprecision in the type model where we'd otherwise use JSONValue.
_Stub = Any
_Scalar = Union[str, bool, None]
_NonScalar = Union[Dict[str, _Stub], List[_Stub]]
_Value = Union[_Scalar, _NonScalar]
JSONValue = Union[_Value, 'Annotated[_Value]']
introspect.py then adds some more type aliases to convey meaning:
# These types are based on structures defined in QEMU's schema, so we
# lack precise types for them here. Python 3.6 does not offer
# TypedDict constructs, so they are broadly typed here as simple
# Python Dicts.
SchemaInfo = Dict[str, object]
SchemaInfoObject = Dict[str, object]
SchemaInfoObjectVariant = Dict[str, object]
SchemaInfoObjectMember = Dict[str, object]
SchemaInfoCommand = Dict[str, object]
I'm not asking you to factor out common typing.
I'm not even asking you to rework expr.py to maximize similarity.
I am asking you to consider stealing applicable parts from
introspect.py's comments.
_JSObject seems to serve the same purpose as JSONValue. Correct?
Expression seems to serve a comparable purpose as SchemaInfo. Correct?
[...]
next prev parent reply other threads:[~2021-02-25 13:57 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-23 0:33 [PATCH v3 00/16] qapi: static typing conversion, pt3 John Snow
2021-02-23 0:33 ` [PATCH v3 01/16] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow
2021-02-23 0:33 ` [PATCH v3 02/16] qapi/expr.py: Check for dict instead of OrderedDict John Snow
2021-02-24 9:30 ` Markus Armbruster
2021-02-24 21:23 ` John Snow
2021-02-25 10:40 ` Markus Armbruster
2021-02-25 20:04 ` John Snow
2021-03-01 16:48 ` Markus Armbruster
2021-02-23 0:33 ` [PATCH v3 03/16] qapi/expr.py: constrain incoming expression types John Snow
2021-02-24 10:01 ` Markus Armbruster
2021-02-24 21:46 ` John Snow
2021-02-25 11:56 ` Markus Armbruster
2021-02-25 20:43 ` John Snow
2021-03-02 5:23 ` Markus Armbruster
2021-02-23 0:33 ` [PATCH v3 04/16] qapi/expr.py: Add assertion for union type 'check_dict' John Snow
2021-02-24 10:35 ` Markus Armbruster
2021-02-24 21:54 ` John Snow
2021-03-24 21:09 ` John Snow
2021-03-25 5:46 ` Markus Armbruster
2021-03-25 19:42 ` John Snow
2021-02-23 0:33 ` [PATCH v3 05/16] qapi/expr.py: move string check upwards in check_type John Snow
2021-02-23 0:33 ` [PATCH v3 06/16] qapi/expr.py: Check type of 'data' member John Snow
2021-02-24 10:39 ` Markus Armbruster
2021-02-24 22:06 ` John Snow
2021-02-25 12:02 ` Markus Armbruster
2021-02-23 0:33 ` [PATCH v3 07/16] qapi/expr.py: Add casts in a few select cases John Snow
2021-02-24 12:32 ` Markus Armbruster
2021-02-24 22:24 ` John Snow
2021-02-25 12:07 ` Markus Armbruster
2021-02-25 22:10 ` John Snow
2021-02-23 0:34 ` [PATCH v3 08/16] qapi/expr.py: add type hint annotations John Snow
2021-02-24 15:27 ` Markus Armbruster
2021-02-24 22:30 ` John Snow
2021-02-25 12:08 ` Markus Armbruster
2021-02-25 13:56 ` Markus Armbruster [this message]
2021-02-25 20:54 ` John Snow
2021-03-02 5:29 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 09/16] qapi/expr.py: Consolidate check_if_str calls in check_if John Snow
2021-02-25 14:23 ` Markus Armbruster
2021-02-25 21:34 ` John Snow
2021-03-02 5:57 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 10/16] qapi/expr.py: Remove single-letter variable John Snow
2021-02-25 14:03 ` Markus Armbruster
2021-02-25 21:56 ` John Snow
2021-02-23 0:34 ` [PATCH v3 11/16] qapi/expr.py: enable pylint checks John Snow
2021-02-23 0:34 ` [PATCH v3 12/16] qapi/expr.py: Add docstrings John Snow
2021-02-23 0:34 ` [PATCH v3 13/16] qapi/expr.py: Modify check_keys to accept any Collection John Snow
2021-02-25 15:41 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 14/16] qapi/expr.py: Use tuples instead of lists for static data John Snow
2021-02-23 0:34 ` [PATCH v3 15/16] qapi/expr.py: move related checks inside check_xxx functions John Snow
2021-02-25 15:28 ` Markus Armbruster
2021-03-25 5:17 ` John Snow
2021-03-25 13:28 ` Markus Armbruster
2021-02-23 0:34 ` [PATCH v3 16/16] qapi/expr.py: Use an expression checker dispatch table 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=87wnuwb68s.fsf@dusky.pond.sub.org \
--to=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.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).