Merge pull request #199 from bjoernricks/unify-error-classes

Unify error classes

Author: bjoernricks

CHANGELOG.md

@@ -17,6 +17,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   default and also python-gvm in editable mode. This means after running
   `poetry install` gvm will directly be importable in the virtual python
   environment. [#197](https://github.com/greenbone/python-gvm/pull/197)
+* Update error classes to always have meaningful `__str__` and `__repr__`
+  method. This allows for easier error printing
+  [#199](https://github.com/greenbone/python-gvm/pull/199)
 
 [unreleased]: https://github.com/greenbone/python-gvm/compare/v1.3.0...master
 

gvm/errors.py

@@ -28,6 +28,16 @@ class GvmError(Exception):
     Base class for all exceptions originating in python-gvm.
     """
 
+    def __init__(self, message: str, *args):
+        super().__init__(message, *args)
+        self.message = message
+
+    def __repr__(self):
+        return '<{} message="{}">'.format(self.__class__.__name__, self.message)
+
+    def __str__(self):
+        return self.message
+
 
 class GvmClientError(GvmError):
     """An exception for gvm client errors
@@ -48,13 +58,15 @@ class GvmServerError(GvmError):
     """
 
     def __init__(self, status: str = None, message: str = None):
-        # pylint: disable=super-init-not-called
+        super().__init__(message, status)
         self.status = status
-        self.message = message
 
     def __str__(self):
-        return (
-            self.__class__.__name__ + ': ' + self.status + ' - ' + self.message
+        return 'Server Error {}. {}'.format(self.status, self.message)
+
+    def __repr__(self):
+        return '<{} status="{}" message="{}">'.format(
+            self.__class__.__name__, self.status, self.message
         )
 
 
@@ -70,13 +82,15 @@ class GvmResponseError(GvmClientError):
     """
 
     def __init__(self, status: str = None, message: str = None):
-        # pylint: disable=super-init-not-called
+        super().__init__(message, status)
         self.status = status
-        self.message = message
 
     def __str__(self):
-        return (
-            self.__class__.__name__ + ': ' + self.status + ' - ' + self.message
+        return 'Response Error {}. {}'.format(self.status, self.message)
+
+    def __repr__(self):
+        return '<{} status="{}" message="{}">'.format(
+            self.__class__.__name__, self.status, self.message
         )
 
 
@@ -99,8 +113,7 @@ def __init__(
         argument: Optional[str] = None,
         function: Optional[str] = None
     ):
-        # pylint: disable=super-init-not-called
-        self.message = message
+        super().__init__(message, argument, function)
         self.argument = argument
         self.function = function
 
@@ -169,8 +182,7 @@ def __init__(
         argument: Optional[str] = None,
         function: Optional[str] = None
     ):
-        # pylint: disable=super-init-not-called
-        self.message = message
+        super().__init__(message, argument, function)
         self.argument = argument
         self.function = function
 

tests/test_errors.py

@@ -168,9 +168,7 @@ def test_is_gvm_error(self):
 
 class GvmServerErrorTestCase(unittest.TestCase):
     def test_raise_with_message_and_status(self):
-        with self.assertRaisesRegex(
-            GvmServerError, '^GvmServerError: foo - bar$'
-        ):
+        with self.assertRaisesRegex(GvmServerError, '^Server Error foo. bar$'):
             raise GvmServerError('foo', 'bar')
 
     def test_is_gvm_error(self):
@@ -181,7 +179,7 @@ def test_is_gvm_error(self):
 class GvmResponseErrorTestCase(unittest.TestCase):
     def test_raise_with_message_and_status(self):
         with self.assertRaisesRegex(
-            GvmResponseError, '^GvmResponseError: foo - bar$'
+            GvmResponseError, '^Response Error foo. bar$'
         ):
             raise GvmResponseError('foo', 'bar')