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 24/36] qapi/source.py: add type hint annotations
Date: Mon, 5 Oct 2020 15:51:46 -0400 [thread overview]
Message-ID: <20201005195158.2348217-25-jsnow@redhat.com> (raw)
In-Reply-To: <20201005195158.2348217-1-jsnow@redhat.com>
Annotations do not change runtime behavior.
This commit *only* adds annotations.
A note on typing of __init__: mypy requires init functions with no
parameters to document a return type of None to be considered fully
typed. In the case when there are input parameters, None may be omitted.
Since __init__ may never return any value, it is preferred to omit the
return annotation whenever possible.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Tested-by: Cleber Rosa <crosa@redhat.com>
---
scripts/qapi/mypy.ini | 5 -----
scripts/qapi/source.py | 31 ++++++++++++++++++-------------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini
index 8ab9ac52cc4..1b8555dfa39 100644
--- a/scripts/qapi/mypy.ini
+++ b/scripts/qapi/mypy.ini
@@ -34,11 +34,6 @@ disallow_untyped_defs = False
disallow_incomplete_defs = False
check_untyped_defs = False
-[mypy-qapi.source]
-disallow_untyped_defs = False
-disallow_incomplete_defs = False
-check_untyped_defs = False
-
[mypy-qapi.types]
disallow_untyped_defs = False
disallow_incomplete_defs = False
diff --git a/scripts/qapi/source.py b/scripts/qapi/source.py
index e97b9a8e15e..1cc6a5b82dc 100644
--- a/scripts/qapi/source.py
+++ b/scripts/qapi/source.py
@@ -11,37 +11,42 @@
import copy
import sys
+from typing import List, Optional, TypeVar
class QAPISchemaPragma:
- def __init__(self):
+ def __init__(self) -> None:
# Are documentation comments required?
self.doc_required = False
# Whitelist of commands allowed to return a non-dictionary
- self.returns_whitelist = []
+ self.returns_whitelist: List[str] = []
# Whitelist of entities allowed to violate case conventions
- self.name_case_whitelist = []
+ self.name_case_whitelist: List[str] = []
class QAPISourceInfo:
- def __init__(self, fname, line, parent):
+ T = TypeVar('T', bound='QAPISourceInfo')
+
+ def __init__(self: T, fname: str, line: int, parent: Optional[T]):
self.fname = fname
self.line = line
self.parent = parent
- self.pragma = parent.pragma if parent else QAPISchemaPragma()
- self.defn_meta = None
- self.defn_name = None
+ self.pragma: QAPISchemaPragma = (
+ parent.pragma if parent else QAPISchemaPragma()
+ )
+ self.defn_meta: Optional[str] = None
+ self.defn_name: Optional[str] = None
- def set_defn(self, meta, name):
+ def set_defn(self, meta: str, name: str) -> None:
self.defn_meta = meta
self.defn_name = name
- def next_line(self):
+ def next_line(self: T) -> T:
info = copy.copy(self)
info.line += 1
return info
- def loc(self):
+ def loc(self) -> str:
if self.fname is None:
return sys.argv[0]
ret = self.fname
@@ -49,13 +54,13 @@ def loc(self):
ret += ':%d' % self.line
return ret
- def in_defn(self):
+ def in_defn(self) -> str:
if self.defn_name:
return "%s: In %s '%s':\n" % (self.fname,
self.defn_meta, self.defn_name)
return ''
- def include_path(self):
+ def include_path(self) -> str:
ret = ''
parent = self.parent
while parent:
@@ -63,5 +68,5 @@ def include_path(self):
parent = parent.parent
return ret
- def __str__(self):
+ def __str__(self) -> str:
return self.include_path() + self.in_defn() + self.loc()
--
2.26.2
next prev parent reply other threads:[~2020-10-05 20:10 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 19:51 [PATCH v5 00/36] qapi: static typing conversion, pt1 John Snow
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 ` John Snow [this message]
2020-10-07 11:55 ` [PATCH v5 24/36] qapi/source.py: add type hint annotations 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-25-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).