#
# Copyright 2021-2022 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""Error classes."""
__all__ = [
"CraftError",
]
from typing import Optional
[docs]
class CraftError(Exception):
"""Signal a program error with a lot of information to report."""
message: str
"""The main message to the user, to be shown as first line (and probably only that,
according to the different modes); note that in some cases the log location will be
attached to this message."""
details: Optional[str]
"""The full error details received from a third party which originated the error
situation."""
resolution: Optional[str]
"""An extra line indicating to the user how the error may be fixed or avoided (to be
shown together with ``message``)."""
docs_url: Optional[str]
"""An URL to point the user to documentation (to be shown together with ``message``)."""
logpath_report: bool
"""Whether the location of the log filepath should be presented in the screen as the
final message."""
reportable: bool
"""If an error report should be sent to some error-handling backend (like Sentry)."""
retcode: int
"""The code to return when the application finishes."""
def __init__( # noqa: PLR0913 (too many arguments)
self,
message: str,
*,
details: Optional[str] = None,
resolution: Optional[str] = None,
docs_url: Optional[str] = None,
logpath_report: bool = True,
reportable: bool = True,
retcode: int = 1,
) -> None:
super().__init__(message)
self.details = details
self.resolution = resolution
self.docs_url = docs_url
self.logpath_report = logpath_report
self.reportable = reportable
self.retcode = retcode
def __eq__(self, other: object) -> bool:
if isinstance(other, CraftError):
return all(
[
self.args == other.args,
self.details == other.details,
self.resolution == other.resolution,
self.docs_url == other.docs_url,
self.logpath_report == other.logpath_report,
self.reportable == other.reportable,
self.retcode == other.retcode,
]
)
return NotImplemented
[docs]
class ArgumentParsingError(Exception):
"""Exception used when an argument parsing error is found."""
[docs]
class ProvideHelpException(Exception): # noqa: N818 (Exception should have an Error suffix)
"""Exception used to provide help to the user."""
