Error classes

exception craft_platforms.CraftPlatformsError(message, details=None, resolution=None, docs_url=None, doc_slug=None, logpath_report=True, reportable=True, retcode=1)[source]

Signal a program error with a lot of information to report.

Parameters:

  • message (str)

  • details (str | None, default: None)

  • resolution (str | None, default: None)

  • docs_url (str | None, default: None)

  • doc_slug (str | None, default: None)

  • logpath_report (bool, default: True)

  • reportable (bool, default: True)

  • retcode (int, default: 1)

message: str

The main message to the user about this error.

details: str | None = None

The full error details which originated the error situation.

resolution: str | None = None

An extra line indicating to the user how the error may be fixed or avoided (to be shown together with message).

docs_url: str | None = None

An URL to point the user to documentation (to be shown together with message).

doc_slug: str | None = None

The slug to the user documentation. Needs a base url to form a full address. Note that docs_url has preference if it is set.

logpath_report: bool = True

Whether the location of the log filepath should be presented in the screen as the final message.

reportable: bool = True

If an error report should be sent to some error-handling backend (like Sentry).

retcode: int = 1

The code to return when the application finishes.