Module cloudofficeprint.exceptions

Custom exceptions for cloudofficeprint.

"""Custom exceptions for cloudofficeprint."""

from typing import List


class COPError(Exception):
    """The error that is thrown when the Cloud Office Print server itself returns an error instead of a result.

    It contains a user message and an encoded message to be handed to Cloud Office Print support if they are contacted.
    """

    def __init__(self, full_message: str):
        """
        Args:
            full_message (str): the full error message received from the Cloud Office Print server
        """
        (self._user_message,
         self._contact_support_message,
         self._encoded_message) = self._split_message(full_message)
        super().__init__(self._user_message)

    @staticmethod
    def _split_message(message: str) -> List[str]:
        """Split the Cloud Office Print server error message into different parts: user message, contact support message and encoded message.

        Args:
            message (str): Cloud Office Print server error message

        Returns:
            List[str]: a list with the split messages
        """
        separated = message.split("\n")
        # everything before the last 2 lines are considered user message
        user_message = "\n".join(separated[:-2])
        # second to last line contains the support message
        contact_support_message = separated[-2]
        # last line contains the encoded message
        encoded_message = separated[-1]
        return [user_message, contact_support_message, encoded_message]

    @property
    def encoded_message(self) -> str:
        """The encrypted and encoded part of the message, for Cloud Office Print support.

        Returns:
            str: the encrypted and encoded part of the message, for Cloud Office Print support
        """
        return self._encoded_message

    @property
    def user_message(self) -> str:
        """The user-friendly part of the message.

        Returns:
            str: the user-friendly part of the message
        """
        return self._user_message

    @property
    def contact_support_message(self) -> str:
        """The contact support message.

        Returns:
            str: the contact support message
        """
        return self._contact_support_message

    @property
    def full_message(self) -> str:
        """The full error message as sent by the server.

        Returns:
            str: the full error message as sent by the server
        """
        return self.user_message + "\n" + self.contact_support_message + "\n" + self.encoded_message

Classes

class COPError (full_message: str)

The error that is thrown when the Cloud Office Print server itself returns an error instead of a result.

It contains a user message and an encoded message to be handed to Cloud Office Print support if they are contacted.

Args

full_message : str

the full error message received from the Cloud Office Print server

Expand source code

class COPError(Exception):
    """The error that is thrown when the Cloud Office Print server itself returns an error instead of a result.

    It contains a user message and an encoded message to be handed to Cloud Office Print support if they are contacted.
    """

    def __init__(self, full_message: str):
        """
        Args:
            full_message (str): the full error message received from the Cloud Office Print server
        """
        (self._user_message,
         self._contact_support_message,
         self._encoded_message) = self._split_message(full_message)
        super().__init__(self._user_message)

    @staticmethod
    def _split_message(message: str) -> List[str]:
        """Split the Cloud Office Print server error message into different parts: user message, contact support message and encoded message.

        Args:
            message (str): Cloud Office Print server error message

        Returns:
            List[str]: a list with the split messages
        """
        separated = message.split("\n")
        # everything before the last 2 lines are considered user message
        user_message = "\n".join(separated[:-2])
        # second to last line contains the support message
        contact_support_message = separated[-2]
        # last line contains the encoded message
        encoded_message = separated[-1]
        return [user_message, contact_support_message, encoded_message]

    @property
    def encoded_message(self) -> str:
        """The encrypted and encoded part of the message, for Cloud Office Print support.

        Returns:
            str: the encrypted and encoded part of the message, for Cloud Office Print support
        """
        return self._encoded_message

    @property
    def user_message(self) -> str:
        """The user-friendly part of the message.

        Returns:
            str: the user-friendly part of the message
        """
        return self._user_message

    @property
    def contact_support_message(self) -> str:
        """The contact support message.

        Returns:
            str: the contact support message
        """
        return self._contact_support_message

    @property
    def full_message(self) -> str:
        """The full error message as sent by the server.

        Returns:
            str: the full error message as sent by the server
        """
        return self.user_message + "\n" + self.contact_support_message + "\n" + self.encoded_message

Ancestors

• builtins.Exception
• builtins.BaseException

Instance variables

var contact_support_message : str

The contact support message.

Returns

str

the contact support message

Expand source code

@property
def contact_support_message(self) -> str:
    """The contact support message.

    Returns:
        str: the contact support message
    """
    return self._contact_support_message

var encoded_message : str

The encrypted and encoded part of the message, for Cloud Office Print support.

Returns

str

the encrypted and encoded part of the message, for Cloud Office Print support

Expand source code

@property
def encoded_message(self) -> str:
    """The encrypted and encoded part of the message, for Cloud Office Print support.

    Returns:
        str: the encrypted and encoded part of the message, for Cloud Office Print support
    """
    return self._encoded_message

var full_message : str

The full error message as sent by the server.

Returns

str

the full error message as sent by the server

Expand source code

@property
def full_message(self) -> str:
    """The full error message as sent by the server.

    Returns:
        str: the full error message as sent by the server
    """
    return self.user_message + "\n" + self.contact_support_message + "\n" + self.encoded_message

var user_message : str

The user-friendly part of the message.

Returns

str

the user-friendly part of the message

Expand source code

@property
def user_message(self) -> str:
    """The user-friendly part of the message.

    Returns:
        str: the user-friendly part of the message
    """
    return self._user_message