All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, John Snow <jsnow@redhat.com>
Subject: [PULL 22/25] qapi/error.py: move QAPIParseError to parser.py
Date: Fri, 30 Apr 2021 13:48:35 +0200	[thread overview]
Message-ID: <20210430114838.2912740-23-armbru@redhat.com> (raw)
In-Reply-To: <20210430114838.2912740-1-armbru@redhat.com>

From: John Snow <jsnow@redhat.com>

Keeping it in error.py will create some cyclic import problems when we
add types to the QAPISchemaParser. Callers don't need to know the
details of QAPIParseError unless they are parsing or dealing directly
with the parser, so this won't create any harsh new requirements for
callers in the general case.

Update error.py with a little docstring that gives a nod to where the
error may now be found.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210421192233.3542904-6-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/error.py  | 22 ++++++++--------------
 scripts/qapi/parser.py | 14 +++++++++++++-
 2 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/scripts/qapi/error.py b/scripts/qapi/error.py
index d0bc7af6e7..6723c5a9d9 100644
--- a/scripts/qapi/error.py
+++ b/scripts/qapi/error.py
@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 #
-# QAPI error classes
-#
 # Copyright (c) 2017-2019 Red Hat Inc.
 #
 # Authors:
@@ -11,6 +9,14 @@
 # This work is licensed under the terms of the GNU GPL, version 2.
 # See the COPYING file in the top-level directory.
 
+"""
+QAPI error classes
+
+Common error classes used throughout the package.  Additional errors may
+be defined in other modules.  At present, `QAPIParseError` is defined in
+parser.py.
+"""
+
 
 class QAPIError(Exception):
     """Base class for all exceptions from the QAPI package."""
@@ -33,17 +39,5 @@ def __str__(self):
         return loc + ': ' + self.msg
 
 
-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]:
-            if ch == '\t':
-                col = (col + 7) % 8 + 1
-            else:
-                col += 1
-        super().__init__(parser.info, msg, col)
-
-
 class QAPISemError(QAPISourceError):
     """Error class for semantic QAPI errors."""
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 58267c3db9..ca5e8e18e0 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -18,10 +18,22 @@
 import os
 import re
 
-from .error import QAPIParseError, QAPISemError
+from .error import QAPISemError, QAPISourceError
 from .source import QAPISourceInfo
 
 
+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]:
+            if ch == '\t':
+                col = (col + 7) % 8 + 1
+            else:
+                col += 1
+        super().__init__(parser.info, msg, col)
+
+
 class QAPISchemaParser:
 
     def __init__(self, fname, previously_included=None, incl_info=None):
-- 
2.26.3



  parent reply	other threads:[~2021-04-30 12:48 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-30 11:48 [PULL 00/25] QAPI patches patches for 2021-04-30 Markus Armbruster
2021-04-30 11:48 ` [PULL 01/25] qapi/expr: Comment cleanup Markus Armbruster
2021-04-30 11:48 ` [PULL 02/25] qapi/expr.py: Remove 'info' argument from nested check_if_str Markus Armbruster
2021-04-30 11:48 ` [PULL 03/25] qapi/expr.py: Check for dict instead of OrderedDict Markus Armbruster
2021-04-30 11:48 ` [PULL 04/25] qapi/expr.py: constrain incoming expression types Markus Armbruster
2021-04-30 11:48 ` [PULL 05/25] qapi/expr.py: Add assertion for union type 'check_dict' Markus Armbruster
2021-04-30 11:48 ` [PULL 06/25] qapi/expr.py: move string check upwards in check_type Markus Armbruster
2021-04-30 11:48 ` [PULL 07/25] qapi/expr.py: Check type of union and alternate 'data' member Markus Armbruster
2021-04-30 11:48 ` [PULL 08/25] qapi/expr.py: Add casts in a few select cases Markus Armbruster
2021-04-30 11:48 ` [PULL 09/25] qapi/expr.py: Modify check_keys to accept any Collection Markus Armbruster
2021-04-30 11:48 ` [PULL 10/25] qapi/expr.py: add type hint annotations Markus Armbruster
2021-04-30 11:48 ` [PULL 11/25] qapi/expr.py: Consolidate check_if_str calls in check_if Markus Armbruster
2021-04-30 11:48 ` [PULL 12/25] qapi/expr.py: Remove single-letter variable Markus Armbruster
2021-04-30 11:48 ` [PULL 13/25] qapi/expr.py: enable pylint checks Markus Armbruster
2021-04-30 11:48 ` [PULL 14/25] qapi/expr: Only explicitly prohibit 'Kind' nor 'List' for type names Markus Armbruster
2021-04-30 11:48 ` [PULL 15/25] qapi/expr.py: Add docstrings Markus Armbruster
2021-04-30 11:48 ` [PULL 16/25] qapi/expr.py: Use tuples instead of lists for static data Markus Armbruster
2021-04-30 11:48 ` [PULL 17/25] qapi/expr: Update authorship and copyright information Markus Armbruster
2021-04-30 11:48 ` [PULL 18/25] qapi/error: Repurpose QAPIError as an abstract base exception class Markus Armbruster
2021-04-30 11:48 ` [PULL 19/25] qapi/error: Use Python3-style super() Markus Armbruster
2021-04-30 11:48 ` [PULL 20/25] qapi/error: Make QAPISourceError 'col' parameter optional Markus Armbruster
2021-04-30 11:48 ` [PULL 21/25] qapi/error: assert QAPISourceInfo is not None Markus Armbruster
2021-04-30 11:48 ` Markus Armbruster [this message]
2021-04-30 11:48 ` [PULL 23/25] qapi/error.py: enable pylint checks Markus Armbruster
2021-04-30 11:48 ` [PULL 24/25] qapi/error: Add type hints Markus Armbruster
2021-04-30 11:48 ` [PULL 25/25] qapi/error.py: enable mypy checks Markus Armbruster
2021-04-30 17:51 ` [PULL 00/25] QAPI patches patches for 2021-04-30 Peter Maydell

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=20210430114838.2912740-23-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=jsnow@redhat.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.