Source code for slack.exceptions

import http
from typing import MutableMapping


class HTTPException(Exception):
    """
    Raised on non 200 status code

    Attributes:
        headers: Response headers
        data: Response data
        status: Response status
    """

    def __init__(
        self, status: int, headers: MutableMapping, data: MutableMapping
    ) -> None:
        self.headers = headers
        self.data = data

        self.status = http.HTTPStatus(status)

    def __str__(self):
        return "{}, {}".format(self.status.value, self.status.phrase)


class SlackAPIError(Exception):
    """
    Raised for errors return by the Slack API

    Attributes:
        headers: Response headers
        data: Response data
        error: Slack API error
    """

    def __init__(
        self, error: str, headers: MutableMapping, data: MutableMapping
    ) -> None:
        self.headers = headers
        self.data = data
        self.error = error

    def __str__(self):
        return str(self.error)


class RateLimited(HTTPException, SlackAPIError):
    """
    Raised when rate limited.

    Attributes:
        retry_after: Timestamp when the rate limitation ends
    """

    def __init__(
        self,
        retry_after: int,
        error: str,
        status: int,
        headers: MutableMapping,
        data: MutableMapping,
    ) -> None:
        HTTPException.__init__(self, status=status, headers=headers, data=data)
        SlackAPIError.__init__(self, error=error, headers=headers, data=data)
        self.retry_after = retry_after

    def __str__(self):
        return HTTPException.__str__(self) + ", retry in {}s".format(self.retry_after)


class InvalidRequest(Exception):
    """
    Base class for all exception raised due to an invalid verification
    """


class FailedVerification(InvalidRequest):
    """
    Raised when incoming data from Slack webhooks fail verification

    Attributes:
        token: Token that failed verification
        team_id: Team id that failed verification
    """

    def __init__(self, token: str, team_id: str) -> None:
        self.token = token
        self.team_id = team_id


class InvalidSlackSignature(InvalidRequest):
    """
    Raised when the incoming request fails signature check

    Attributes:
        slack_signature: Signature sent by slack
        calculated_singature: Calculated signature
    """

    def __init__(self, slack_signature: str, calculated_signature: str) -> None:
        self.slack_signature = slack_signature
        self.calculated_signature = calculated_signature


class InvalidTimestamp(InvalidRequest):
    """
    Raised when the incoming request is too old

    Attributes:
        timestamp: Timestamp of the incoming request
    """

    def __init__(self, timestamp: float) -> None:
        self.timestamp = timestamp