# -*- coding: utf-8 -*-
# Copyright 2020 Paul Bailey
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from .errors import iserver_error_codes
[docs]
class MSTRException(Exception):
"""Base exception for all MicroStrategy REST API errors.
Attributes:
code: The MicroStrategy error code (e.g. ``ERR001``), or ``"N/A"``.
message: Human-readable error description.
iserver_code: Optional I-Server error code, when present in the
API response.
iserver_message: Looked-up description for *iserver_code*.
"""
def __init__(self, message: str | None = None, *args, **kwargs):
self.code = kwargs.get("code", "N/A")
msg = message if message is not None else kwargs.get("message", "Unknown error")
self.message = f"{self.code}: {msg}."
self.iserver_code = kwargs.get("iServerCode", None)
if self.iserver_code:
self.iserver_message = iserver_error_codes.get(self.iserver_code)
self.message += (
f" [I-Server error code {self.iserver_message} ({self.iserver_code})]"
)
super().__init__(self.message, *args)
[docs]
class MSTRUnknownException(MSTRException):
"""Raised when the error response lacks a recognised ``code`` field."""
[docs]
class LoginFailureException(MSTRException):
"""Raised when authentication fails (``ERR003``)."""
[docs]
class IServerException(MSTRException):
"""Raised on Intelligence Server errors (``ERR002``, ``ERR0013``)."""
[docs]
class ResourceNotFoundException(MSTRException):
"""Raised when a requested resource does not exist (``ERR004``)."""
[docs]
class InvalidRequestException(MSTRException):
"""Raised on invalid input or missing required fields (``ERR005``, ``ERR006``, ``ERR007``)."""
[docs]
class SessionException(MSTRException):
"""Raised when the session is invalid or has timed out (``ERR009``)."""
[docs]
class InsufficientPrivilegesException(MSTRException):
"""Raised when the user lacks required privileges or permissions (``ERR0014``, ``ERR0017``)."""
[docs]
class ObjectAlreadyExistsException(MSTRException):
"""Raised when attempting to create an object that already exists (``ERR0015``)."""
[docs]
class ExecutionCancelledException(MSTRException):
"""Raised when a report or cube execution is cancelled."""