mirrors/qemu
0
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2024-11-28 06:13:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

qapi/error: Repurpose QAPIError as an abstract base exception class

Browse Source 
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>
This commit is contained in:
John Snow 2021-04-21 15:22:26 -04:00 committed by Markus Armbruster
parent e81718c698
commit 46f49468c6
3 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/sphinx/qapidoc.py
View File

@ -34,7 +34,8 @@ from sphinx.errors import ExtensionError
from sphinx.util.nodes import nested_parse_with_titles from sphinx.util.nodes import nested_parse_with_titles
import sphinx import sphinx
from qapi.gen import QAPISchemaVisitor 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 # Sphinx up to 1.6 uses AutodocReporter; 1.7 and later

11
scripts/qapi/error.py
View File

@ -13,6 +13,11 @@
class QAPIError(Exception): 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): def __init__(self, info, col, msg):
Exception.__init__(self) Exception.__init__(self)
self.info = info self.info = info
@ -27,7 +32,8 @@ class QAPIError(Exception):
return loc + ': ' + self.msg return loc + ': ' + self.msg
class QAPIParseError(QAPIError): class QAPIParseError(QAPISourceError):
"""Error class for all QAPI schema parsing errors."""
def __init__(self, parser, msg): def __init__(self, parser, msg):
col = 1 col = 1
for ch in parser.src[parser.line_pos:parser.pos]: for ch in parser.src[parser.line_pos:parser.pos]:
@ -38,6 +44,7 @@ class QAPIParseError(QAPIError):
super().__init__(parser.info, col, msg) super().__init__(parser.info, col, msg)
class QAPISemError(QAPIError): class QAPISemError(QAPISourceError):
"""Error class for semantic QAPI errors."""
def __init__(self, info, msg): def __init__(self, info, msg):
super().__init__(info, None, msg) super().__init__(info, None, msg)

5
scripts/qapi/schema.py
View File

@ -20,7 +20,7 @@ import re
from typing import Optional from typing import Optional
from .common import POINTER_SUFFIX, c_name from .common import POINTER_SUFFIX, c_name
from .error import QAPIError, QAPISemError from .error import QAPISemError, QAPISourceError
from .expr import check_exprs from .expr import check_exprs
from .parser import QAPISchemaParser from .parser import QAPISchemaParser
@ -875,7 +875,8 @@ class QAPISchema:
other_ent = self._entity_dict.get(ent.name) other_ent = self._entity_dict.get(ent.name)
if other_ent: if other_ent:
if other_ent.info: if other_ent.info:
where = QAPIError(other_ent.info, None, "previous definition") where = QAPISourceError(other_ent.info, None,
"previous definition")
raise QAPISemError( raise QAPISemError(
ent.info, ent.info,
"'%s' is already defined\n%s" % (ent.name, where)) "'%s' is already defined\n%s" % (ent.name, where))