a5750901c6
This patch adds the KasUserError exception class to distinguish between internal kas exceptions and user or configuration errors. Exceptions previously raised on user errors are ported over by deriving KasUserError. In case of user errors, only the exception message is shown, but no stacktrace. This makes it easier for users to locate the issue as the reason is now stated in the last line of the output. Kas internal exceptions are not subject to this change to help the developers to find the root cause more easily. Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
46 lines
1.9 KiB
Python
46 lines
1.9 KiB
Python
# kas - setup tool for bitbake based projects
|
|
#
|
|
# Copyright (c) Siemens AG, 2017-2023
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
|
|
"""
|
|
This module provides a common base class for all exceptions
|
|
which are related to user or configuration errors. These exceptions
|
|
should be caught and reported to the user using a meaningful message
|
|
instead of a stacktrace.
|
|
|
|
When handling errors in KAS, never return directly using `sys.exit`,
|
|
but instead throw an exception derived from :class:`KasUserError` (for user
|
|
errors), or one derived from `Exception` for internal errors. These
|
|
are then handled centrally, mapped to correct return codes and pretty
|
|
printed.
|
|
"""
|
|
|
|
|
|
__license__ = 'MIT'
|
|
__copyright__ = 'Copyright (c) Siemens AG, 2023'
|
|
|
|
|
|
class KasUserError(Exception):
|
|
"""
|
|
User or input error. Derive all user error exceptions from this class.
|
|
"""
|
|
pass
|