[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 24/36] qapi/source.py: add type hint annotations
From: |
John Snow |
Subject: |
[PATCH v6 24/36] qapi/source.py: add type hint annotations |
Date: |
Fri, 9 Oct 2020 12:15:46 -0400 |
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
- [PATCH v6 12/36] qapi/common.py: delint with pylint, (continued)
- [PATCH v6 12/36] qapi/common.py: delint with pylint, John Snow, 2020/10/09
- [PATCH v6 13/36] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/10/09
- [PATCH v6 15/36] qapi/common.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 20/36] qapi/events.py: Move comments into docstrings, John Snow, 2020/10/09
- [PATCH v6 16/36] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/10/09
- [PATCH v6 14/36] qapi/common.py: check with pylint, John Snow, 2020/10/09
- [PATCH v6 17/36] qapi/common.py: move build_params into gen.py, John Snow, 2020/10/09
- [PATCH v6 19/36] qapi/events.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 18/36] qapi: establish mypy type-checking baseline, John Snow, 2020/10/09
- [PATCH v6 23/36] qapi/commands.py: enable checking with mypy, John Snow, 2020/10/09
- [PATCH v6 24/36] qapi/source.py: add type hint annotations,
John Snow <=
- [PATCH v6 26/36] qapi/gen.py: Fix edge-case of _is_user_module, John Snow, 2020/10/09
- [PATCH v6 22/36] qapi/commands.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 25/36] qapi/source.py: delint with pylint, John Snow, 2020/10/09
- [PATCH v6 21/36] qapi/commands.py: Don't re-bind to variable of different type, John Snow, 2020/10/09
- [PATCH v6 28/36] qapi/gen.py: Enable checking with mypy, John Snow, 2020/10/09
- [PATCH v6 27/36] qapi/gen.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 30/36] qapi/gen.py: update write() to be more idiomatic, John Snow, 2020/10/09