diff options
Diffstat (limited to 'resources/tools/presentation/pal_errors.py')
-rw-r--r-- | resources/tools/presentation/pal_errors.py | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/resources/tools/presentation/pal_errors.py b/resources/tools/presentation/pal_errors.py deleted file mode 100644 index 009a3ed2b8..0000000000 --- a/resources/tools/presentation/pal_errors.py +++ /dev/null @@ -1,83 +0,0 @@ -# Copyright (c) 2023 Cisco and/or its affiliates. -# 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. - -"""Implementation of exceptions used in the Presentation and analytics layer. -""" - -import sys -import logging - - -class PresentationError(Exception): - """Exception(s) raised by the presentation module. - - When raising this exception, put this information to the message in this - order: - - short description of the encountered problem (parameter msg), - - relevant messages if there are any collected, e.g., from caught - exception (optional parameter details), - - relevant data if there are any collected (optional parameter details). - """ - - log_level = { - u"DEBUG": logging.debug, - u"INFO": logging.info, - u"WARNING": logging.warning, - u"ERROR": logging.error, - u"CRITICAL": logging.critical - } - - def __init__(self, msg, details=u'', level=u"CRITICAL"): - """Sets the exception message and the level. - - :param msg: Short description of the encountered problem. - :param details: Relevant messages if there are any collected, e.g., - from caught exception (optional parameter details), or relevant data - if there are any collected (optional parameter details). - :param level: Level of the error, possible choices are: "DEBUG", "INFO", - "WARNING", "ERROR" and "CRITICAL". - :type msg: str - :type details: str - :type level: str - """ - - super(PresentationError, self).__init__() - self._msg = msg - self._details = details - self._level = level - - try: - self.log_level[self._level](self._msg) - if self._details: - self.log_level[self._level](self._details) - except KeyError: - print(u"Wrong log level.") - sys.exit(1) - - def __repr__(self): - return ( - f"PresentationError(msg={self._msg!r},details={self._details!r}," - f"level={self._level!r})" - ) - - def __str__(self): - return str(self._msg) - - @property - def level(self): - """Getter - logging level. - - :returns: Logging level. - :rtype: str - """ - return self._level |