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
|
# ==================================================================================================================== #
# #
# _____ _ _ _____ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ | ____|_ _____ ___ _ __ | |_(_) ___ _ __ ___ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | | _| \ \/ / __/ _ \ '_ \| __| |/ _ \| '_ \/ __| #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_| |___ > < (_| __/ |_) | |_| | (_) | | | \__ \ #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)_____/_/\_\___\___| .__/ \__|_|\___/|_| |_|___/ #
# |_| |___/ |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2024 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
A common set of missing exceptions in Python.
.. hint:: See :ref:`high-level help <EXECPTION>` for explanations and usage examples.
"""
from sys import version_info
from typing import List
try:
from pyTooling.Decorators import export
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Exceptions] Could not import from 'pyTooling.*'!")
try:
from Decorators import export
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Exceptions] Could not import from 'Decorators' directly!")
raise ex
@export
class OverloadResolutionError(Exception):
"""
The exception is raised, when no matching overloaded method was found.
.. seealso::
:func:`@overloadable <pyTooling.MetaClasses.overloadable>`
|rarr| Mark a method as *overloadable*.
"""
# WORKAROUND: for Python <3.11
# Implementing a dummy method for Python versions before
__notes__: List[str]
if version_info < (3, 11): # pragma: no cover
def add_note(self, message: str):
try:
self.__notes__.append(message)
except AttributeError:
self.__notes__ = [message]
@export
class ExceptionBase(Exception):
"""Base exception derived from :exc:`Exception <python:Exception>` for all custom exceptions."""
def __init__(self, message: str = "") -> None:
"""
ExceptionBase initializer.
:param message: The exception message.
"""
super().__init__()
self.message = message
# WORKAROUND: for Python <3.11
# Implementing a dummy method for Python versions before
__notes__: List[str]
if version_info < (3, 11): # pragma: no cover
def add_note(self, message: str):
try:
self.__notes__.append(message)
except AttributeError:
self.__notes__ = [message]
def __str__(self) -> str:
"""Returns the exception's message text."""
return self.message
def with_traceback(self, tb) -> None:
super().with_traceback(tb)
# @DocumentMemberAttribute(False)
# @MethodAlias(pyExceptions.with_traceback)
# def with_traceback(self): pass
@export
class EnvironmentException(ExceptionBase):
"""The exception is raised when an expected environment variable is missing."""
@export
class PlatformNotSupportedException(ExceptionBase):
"""The exception is raise if the platform is not supported."""
@export
class NotConfiguredException(ExceptionBase):
"""The exception is raise if the requested setting is not configured."""
@export
class ToolingException(Exception):
"""The exception is raised by pyTooling internal features."""
# WORKAROUND: for Python <3.11
# Implementing a dummy method for Python versions before
__notes__: List[str]
if version_info < (3, 11): # pragma: no cover
def add_note(self, message: str):
try:
self.__notes__.append(message)
except AttributeError:
self.__notes__ = [message]
|