7.2.2.4. Module axivion.dashboard.exceptions¶

Declares all Dashboard-specific exceptions.

Exceptions¶

`DashboardException`	Exception base class for this module.
`DashboardHttpException`(msg, status_code, ...)	Exceptional situations during HTTP communication with the Dashboard Server.
`DashboardServerException`(msg, status_code, ...)	An Exception that originates from the Dashboard Server's JSON API.
`FileFormatException`	Indicates a file format error in a file supplied to or created by this API

DashboardException¶

exception axivion.dashboard.exceptions.DashboardException¶

Bases: Exception

Exception base class for this module.

Potentially thrown by every function or constructor of this module.

DashboardHttpException¶

exception axivion.dashboard.exceptions.DashboardHttpException(msg, status_code, url, headers)¶

Bases: DashboardException

Exceptional situations during HTTP communication with the Dashboard Server.

Parameters:

status_code (int)
url (str)
headers (typing.Mapping[str, str])

DashboardServerException¶

exception axivion.dashboard.exceptions.DashboardServerException(msg, status_code, url, headers, dashboard_version_number, errno, message, details, localized_message, localized_details, support_address, display_server_bug_hint, data)¶

Bases: DashboardHttpException

An Exception that originates from the Dashboard Server’s JSON API.

It contains properties with more information on the error as made available by the underlying JSON API. They are

dashboard_version_number (same as ‘dashboardVersionNumber’ in the JSON API) for Dashboards >= 6.6.0
errno (same as ‘type’ in the JSON API)
message (same as ‘message’ in the JSON API)
details (same as ‘details’ in the JSON API) for Dashboards >= 7.5.0
localized_message (same as ‘localizedMessage’ in the JSON API)
localized_details (same as ‘localizedDetails’ in the JSON API) for Dashboards >= 7.5.0
support_address (same as ‘supportAddress’ in the JSON API) for Dashboards >= 7.5.0
display_server_bug_hint (same as ‘displayServerBugHint’ in the JSON API) for Dashboards >= 7.5.0
data (same as ‘data’ in the JSON API) for Dashboards >= 6.5.0

Parameters:

status_code (int)
url (str)
headers (typing.Mapping[str, str])
support_address (typing.Optional[str])
display_server_bug_hint (typing.Optional[bool])

FileFormatException¶

exception axivion.dashboard.exceptions.FileFormatException¶