[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 1/8] qapi/error: Repurpose QAPIError as an abstract base excep
From: |
John Snow |
Subject: |
[PATCH v3 1/8] qapi/error: Repurpose QAPIError as an abstract base exception class |
Date: |
Wed, 21 Apr 2021 15:22:26 -0400 |
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>
---
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 b7a2d39c105..87c67ab23f8 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 ae60d9e2fe8..126dda7c9b2 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 703b446fd21..c277fcacc53 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.30.2
- [PATCH v3 0/8] qapi: static typing conversion, pt4, John Snow, 2021/04/21
- [PATCH v3 1/8] qapi/error: Repurpose QAPIError as an abstract base exception class,
John Snow <=
- [PATCH v3 2/8] qapi/error: Use Python3-style super(), John Snow, 2021/04/21
- [PATCH v3 6/8] qapi/error.py: enable pylint checks, John Snow, 2021/04/21
- [PATCH v3 3/8] qapi/error: Make QAPISourceError 'col' parameter optional, John Snow, 2021/04/21
- [PATCH v3 8/8] qapi/error.py: enable mypy checks, John Snow, 2021/04/21
- [PATCH v3 5/8] qapi/error.py: move QAPIParseError to parser.py, John Snow, 2021/04/21
- [PATCH v3 4/8] qapi/error: assert QAPISourceInfo is not None, John Snow, 2021/04/21
- [PATCH v3 7/8] qapi/error: Add type hints, John Snow, 2021/04/21
- Re: [PATCH v3 0/8] qapi: static typing conversion, pt4, Markus Armbruster, 2021/04/22