[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 18/25] qapi/error: Repurpose QAPIError as an abstract base excepti
From: |
Markus Armbruster |
Subject: |
[PULL 18/25] qapi/error: Repurpose QAPIError as an abstract base exception class |
Date: |
Fri, 30 Apr 2021 13:48:31 +0200 |
From: John Snow <jsnow@redhat.com>
Rename QAPIError to QAPISourceError, and then create a new QAPIError
class that serves as the basis for all of our other custom exceptions,
without specifying any class properties.
This leaves QAPIError as a package-wide error class that's suitable for
any current or future errors.
(Right now, we don't have any errors that DON'T also want to specify a
Source location, but this MAY change. In these cases, a common abstract
ancestor would be desired.)
Add docstrings to explain the intended function of each error class.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210421192233.3542904-2-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/sphinx/qapidoc.py | 3 ++-
scripts/qapi/error.py | 11 +++++++++--
scripts/qapi/schema.py | 5 +++--
3 files changed, 14 insertions(+), 5 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index b7a2d39c10..87c67ab23f 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -34,7 +34,8 @@
from sphinx.util.nodes import nested_parse_with_titles
import sphinx
from qapi.gen import QAPISchemaVisitor
-from qapi.schema import QAPIError, QAPISemError, QAPISchema
+from qapi.error import QAPIError, QAPISemError
+from qapi.schema import QAPISchema
# Sphinx up to 1.6 uses AutodocReporter; 1.7 and later
diff --git a/scripts/qapi/error.py b/scripts/qapi/error.py
index ae60d9e2fe..126dda7c9b 100644
--- a/scripts/qapi/error.py
+++ b/scripts/qapi/error.py
@@ -13,6 +13,11 @@
class QAPIError(Exception):
+ """Base class for all exceptions from the QAPI package."""
+
+
+class QAPISourceError(QAPIError):
+ """Error class for all exceptions identifying a source location."""
def __init__(self, info, col, msg):
Exception.__init__(self)
self.info = info
@@ -27,7 +32,8 @@ def __str__(self):
return loc + ': ' + self.msg
-class QAPIParseError(QAPIError):
+class QAPIParseError(QAPISourceError):
+ """Error class for all QAPI schema parsing errors."""
def __init__(self, parser, msg):
col = 1
for ch in parser.src[parser.line_pos:parser.pos]:
@@ -38,6 +44,7 @@ def __init__(self, parser, msg):
super().__init__(parser.info, col, msg)
-class QAPISemError(QAPIError):
+class QAPISemError(QAPISourceError):
+ """Error class for semantic QAPI errors."""
def __init__(self, info, msg):
super().__init__(info, None, msg)
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index 703b446fd2..c277fcacc5 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -20,7 +20,7 @@
from typing import Optional
from .common import POINTER_SUFFIX, c_name
-from .error import QAPIError, QAPISemError
+from .error import QAPISemError, QAPISourceError
from .expr import check_exprs
from .parser import QAPISchemaParser
@@ -875,7 +875,8 @@ def _def_entity(self, ent):
other_ent = self._entity_dict.get(ent.name)
if other_ent:
if other_ent.info:
- where = QAPIError(other_ent.info, None, "previous definition")
+ where = QAPISourceError(other_ent.info, None,
+ "previous definition")
raise QAPISemError(
ent.info,
"'%s' is already defined\n%s" % (ent.name, where))
--
2.26.3
- [PULL 19/25] qapi/error: Use Python3-style super(), (continued)
- [PULL 19/25] qapi/error: Use Python3-style super(), Markus Armbruster, 2021/04/30
- [PULL 23/25] qapi/error.py: enable pylint checks, Markus Armbruster, 2021/04/30
- [PULL 20/25] qapi/error: Make QAPISourceError 'col' parameter optional, Markus Armbruster, 2021/04/30
- [PULL 22/25] qapi/error.py: move QAPIParseError to parser.py, Markus Armbruster, 2021/04/30
- [PULL 24/25] qapi/error: Add type hints, Markus Armbruster, 2021/04/30
- [PULL 02/25] qapi/expr.py: Remove 'info' argument from nested check_if_str, Markus Armbruster, 2021/04/30
- [PULL 07/25] qapi/expr.py: Check type of union and alternate 'data' member, Markus Armbruster, 2021/04/30
- [PULL 15/25] qapi/expr.py: Add docstrings, Markus Armbruster, 2021/04/30
- [PULL 17/25] qapi/expr: Update authorship and copyright information, Markus Armbruster, 2021/04/30
- [PULL 21/25] qapi/error: assert QAPISourceInfo is not None, Markus Armbruster, 2021/04/30
- [PULL 18/25] qapi/error: Repurpose QAPIError as an abstract base exception class,
Markus Armbruster <=
- Re: [PULL 00/25] QAPI patches patches for 2021-04-30, Peter Maydell, 2021/04/30