1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
"""
Module for GVM errors
"""
from typing import Optional
class GvmError(Exception):
"""An exception for gvm errors
Base class for all exceptions originating in python-gvm.
"""
def __init__(self, message: Optional[str], *args):
super().__init__(message, *args)
self.message = message
def __repr__(self):
return f'<{self.__class__.__name__} message="{self.message}">'
def __str__(self):
return self.message
class GvmClientError(GvmError):
"""An exception for gvm client errors
Base class for all exceptions originating in python-gvm.
"""
class GvmServerError(GvmError):
"""An exception for gvm server errors
Derives from :py:class:`GvmError`
Arguments:
status: The HTTP response status
message: Error message to be displayed. Takes precedence over argument
and function
"""
def __init__(
self, status: Optional[str] = None, message: Optional[str] = None
):
super().__init__(message, status)
self.status = status
def __str__(self):
return f"Server Error {self.status}. {self.message}"
def __repr__(self):
return (
f'<{self.__class__.__name__} status="{self.status}"'
f' message="{self.message}">'
)
class GvmResponseError(GvmClientError):
"""An exception for gvm server errors
Derives from :py:class:`GvmClientError`
Arguments:
status: The HTTP response status
message: Error message to be displayed. Takes precedence over argument
and function
"""
def __init__(
self, status: Optional[str] = None, message: Optional[str] = None
):
super().__init__(message, status)
self.status = status
def __str__(self):
return f"Response Error {self.status}. {self.message}"
def __repr__(self):
return (
f'<{self.__class__.__name__} status="{self.status}"'
f' message="{self.message}">'
)
class InvalidArgument(GvmError):
"""Raised if an invalid argument/parameter is passed
Derives from :py:class:`GvmError`
Arguments:
message: Error message to be displayed. Takes precedence over argument
and function
argument: Optional name of the invalid argument
function: Optional name of the called function
"""
def __init__(
self,
message: Optional[str] = None,
*,
argument: Optional[str] = None,
function: Optional[str] = None,
):
super().__init__(message, argument, function)
self.argument = argument
self.function = function
def __str__(self):
if self.message:
return self.message
if not self.function:
return f"Invalid argument {self.argument}"
if not self.argument:
return f"Invalid argument for {self.function}"
return f"Invalid argument {self.argument} for {self.function}"
class InvalidArgumentType(GvmError):
"""Raised if a passed argument has an invalid type
Derives from :py:class:`GvmError`
Arguments:
argument: Name of the invalid argument
arg_type: The correct argument type
function: Optional name of the called function
"""
def __init__(
self,
argument: str,
*,
arg_type: Optional[str] = None,
function: Optional[str] = None,
):
super().__init__(None)
self.argument = argument
self.function = function
self.arg_type = arg_type
def __str__(self):
if self.function:
if self.arg_type:
return (
f"In {self.function} the argument {self.argument} "
f"must be of type {self.arg_type}."
)
return (
f"Invalid argument type for argument {self.argument} in "
f"{self.function}."
)
if self.arg_type:
return (
f"The argument {self.argument} must be of type {self.arg_type}."
)
return f"Invalid argument type for argument {self.argument}."
class RequiredArgument(GvmError):
"""Raised if a required argument/parameter is missing
Derives from :py:class:`GvmError`
Arguments:
message: Error message to be displayed. Takes precedence over argument
and function.
argument: Optional name of the required argument.
function: Optional name of the called function.
"""
def __init__(
self,
message: Optional[str] = None,
*,
argument: Optional[str] = None,
function: Optional[str] = None,
):
super().__init__(message, argument, function)
self.argument = argument
self.function = function
def __str__(self):
if self.message:
return self.message
if not self.function:
return f"Required argument {self.argument}"
if not self.argument:
return f"Required argument missing for {self.function}"
return f"{self.function} requires a {self.argument} argument"
|
