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 (Optional[str], default: None) –

  • resolution (Optional[str], default: None) –

  • docs_url (Optional[str], default: None) –

  • doc_slug (Optional[str], default: None) –

  • logpath_report (bool, default: True) –

  • reportable (bool, default: True) –

  • retcode (int, default: 1) –

message

Type:    str

The main message to the user about this error.

details = None

Type:    Optional[str]

The full error details which originated the error situation.

resolution = None

Type:    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 = None

Type:    Optional[str]

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

doc_slug = None

Type:    Optional[str]

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 = True

Type:    bool

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

reportable = True

Type:    bool

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

retcode = 1

Type:    int

The code to return when the application finishes.