From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Michael Roth <mdroth@linux.vnet.ibm.com>,
John Snow <jsnow@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v6 24/36] qapi/source.py: add type hint annotations
Date: Fri, 9 Oct 2020 12:15:46 -0400 [thread overview]
Message-ID: <20201009161558.107041-25-jsnow@redhat.com> (raw)
In-Reply-To: <20201009161558.107041-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 | 32 +++++++++++++++++++-------------
2 files changed, 19 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..27af5295a85 100644
--- a/scripts/qapi/source.py
+++ b/scripts/qapi/source.py
@@ -11,37 +11,43 @@
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, fname: str, line: int,
+ parent: Optional['QAPISourceInfo']):
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 +55,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 +69,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-09 16:31 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-09 16:15 [PATCH v6 00/36] qapi: static typing conversion, pt1 John Snow
2020-10-09 16:15 ` [PATCH v6 01/36] docs: repair broken references John Snow
2020-10-09 16:15 ` [PATCH v6 02/36] qapi: modify docstrings to be sphinx-compatible John Snow
2020-10-09 16:15 ` [PATCH v6 03/36] qapi-gen: Separate arg-parsing from generation John Snow
2020-10-09 17:26 ` Markus Armbruster
2020-10-12 14:57 ` John Snow
2020-10-19 7:33 ` Markus Armbruster
2020-10-09 16:15 ` [PATCH v6 04/36] qapi: move generator entrypoint into package John Snow
2020-10-09 16:15 ` [PATCH v6 05/36] qapi: Prefer explicit relative imports John Snow
2020-10-09 16:15 ` [PATCH v6 06/36] qapi: Remove wildcard includes John Snow
2020-10-09 16:15 ` [PATCH v6 07/36] qapi: enforce import order/styling with isort John Snow
2020-10-09 16:15 ` [PATCH v6 08/36] qapi: delint using flake8 John Snow
2020-10-09 16:15 ` [PATCH v6 09/36] qapi: add pylintrc John Snow
2020-10-09 16:15 ` [PATCH v6 10/36] qapi/common.py: Remove python compatibility workaround John Snow
2020-10-09 16:15 ` [PATCH v6 11/36] qapi/common.py: Add indent manager John Snow
2020-10-09 16:15 ` [PATCH v6 12/36] qapi/common.py: delint with pylint John Snow
2020-10-09 16:15 ` [PATCH v6 13/36] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-10-09 16:15 ` [PATCH v6 14/36] qapi/common.py: check with pylint John Snow
2020-10-09 16:15 ` [PATCH v6 15/36] qapi/common.py: add type hint annotations John Snow
2020-10-09 16:15 ` [PATCH v6 16/36] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-10-09 16:15 ` [PATCH v6 17/36] qapi/common.py: move build_params into gen.py John Snow
2020-10-09 16:15 ` [PATCH v6 18/36] qapi: establish mypy type-checking baseline John Snow
2020-10-09 16:15 ` [PATCH v6 19/36] qapi/events.py: add type hint annotations John Snow
2020-10-09 16:15 ` [PATCH v6 20/36] qapi/events.py: Move comments into docstrings John Snow
2020-10-09 16:15 ` [PATCH v6 21/36] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-10-09 16:15 ` [PATCH v6 22/36] qapi/commands.py: add type hint annotations John Snow
2020-10-09 16:15 ` [PATCH v6 23/36] qapi/commands.py: enable checking with mypy John Snow
2020-10-09 16:15 ` John Snow [this message]
2020-10-09 16:15 ` [PATCH v6 25/36] qapi/source.py: delint with pylint John Snow
2020-10-09 16:15 ` [PATCH v6 26/36] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-10-09 17:26 ` Markus Armbruster
2020-10-09 17:39 ` Eduardo Habkost
2020-10-10 6:57 ` Markus Armbruster
2020-10-09 16:15 ` [PATCH v6 27/36] qapi/gen.py: add type hint annotations John Snow
2020-10-09 16:15 ` [PATCH v6 28/36] qapi/gen.py: Enable checking with mypy John Snow
2020-10-09 16:15 ` [PATCH v6 29/36] qapi/gen.py: Remove unused parameter John Snow
2020-10-09 16:15 ` [PATCH v6 30/36] qapi/gen.py: update write() to be more idiomatic John Snow
2020-10-09 16:15 ` [PATCH v6 31/36] qapi/gen.py: delint with pylint John Snow
2020-10-09 16:15 ` [PATCH v6 32/36] qapi/types.py: add type hint annotations John Snow
2020-10-09 16:15 ` [PATCH v6 33/36] qapi/types.py: remove one-letter variables John Snow
2020-10-09 16:15 ` [PATCH v6 34/36] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-10-09 16:15 ` [PATCH v6 35/36] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-10-09 16:15 ` [PATCH v6 36/36] qapi/visit.py: add type hint annotations John Snow
2020-10-10 9:43 ` [PATCH v6 00/36] qapi: static typing conversion, pt1 Markus Armbruster
2020-10-12 14:19 ` 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=20201009161558.107041-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).