qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org, Markus Armbruster <armbru@redhat.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
	John Snow <jsnow@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	Michael Roth <michael.roth@amd.com>,
	Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v3 7/8] qapi/error: Add type hints
Date: Wed, 21 Apr 2021 15:22:32 -0400	[thread overview]
Message-ID: <20210421192233.3542904-8-jsnow@redhat.com> (raw)
In-Reply-To: <20210421192233.3542904-1-jsnow@redhat.com>

No functional change.

Note: QAPISourceError's info parameter is Optional[] because schema.py
treats the info property of its various classes as Optional to
accommodate built-in types, which have no source. See prior commit
'qapi/error: assert QAPISourceInfo is not None'.

Signed-off-by: John Snow <jsnow@redhat.com>

---

Random aside: It may appear clunky to have to type __str__, but after I
mentioned it on the Python typing SIG list, it was noted that this is
actually one of very few magic methods that has a "known" type in
advance, so there wasn't much desire to special case the typing for it.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 scripts/qapi/error.py | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/scripts/qapi/error.py b/scripts/qapi/error.py
index 6723c5a9d9a..e35e4ddb26a 100644
--- a/scripts/qapi/error.py
+++ b/scripts/qapi/error.py
@@ -17,6 +17,10 @@
 parser.py.
 """
 
+from typing import Optional
+
+from .source import QAPISourceInfo
+
 
 class QAPIError(Exception):
     """Base class for all exceptions from the QAPI package."""
@@ -24,13 +28,16 @@ class QAPIError(Exception):
 
 class QAPISourceError(QAPIError):
     """Error class for all exceptions identifying a source location."""
-    def __init__(self, info, msg, col=None):
+    def __init__(self,
+                 info: Optional[QAPISourceInfo],
+                 msg: str,
+                 col: Optional[int] = None):
         super().__init__()
         self.info = info
         self.msg = msg
         self.col = col
 
-    def __str__(self):
+    def __str__(self) -> str:
         assert self.info is not None
         loc = str(self.info)
         if self.col is not None:
-- 
2.30.2



  parent reply	other threads:[~2021-04-21 19:33 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-21 19:22 [PATCH v3 0/8] qapi: static typing conversion, pt4 John Snow
2021-04-21 19:22 ` [PATCH v3 1/8] qapi/error: Repurpose QAPIError as an abstract base exception class John Snow
2021-04-21 19:22 ` [PATCH v3 2/8] qapi/error: Use Python3-style super() John Snow
2021-04-21 19:22 ` [PATCH v3 3/8] qapi/error: Make QAPISourceError 'col' parameter optional John Snow
2021-04-21 19:22 ` [PATCH v3 4/8] qapi/error: assert QAPISourceInfo is not None John Snow
2021-04-21 19:22 ` [PATCH v3 5/8] qapi/error.py: move QAPIParseError to parser.py John Snow
2021-04-21 19:22 ` [PATCH v3 6/8] qapi/error.py: enable pylint checks John Snow
2021-04-21 19:22 ` John Snow [this message]
2021-04-21 19:22 ` [PATCH v3 8/8] qapi/error.py: enable mypy checks John Snow
2021-04-22  8:09 ` [PATCH v3 0/8] qapi: static typing conversion, pt4 Markus Armbruster
2021-04-22 14:38   ` 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=20210421192233.3542904-8-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=armbru@redhat.com \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=michael.roth@amd.com \
    --cc=peter.maydell@linaro.org \
    --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).