Class APIError

gspread/exceptions.py:38–70

Errors coming from the API itself, such as when we attempt to retrieve things that don't exist.

class APIError(GSpreadException):
    """Errors coming from the API itself,
    such as when we attempt to retrieve things that don't exist."""

    def __init__(self, response: Response):
        try:
            error = response.json()["error"]
        except Exception as e:
            # in case we failed to parse the error from the API
            # build an empty error object to notify the caller
            # and keep the exception raise flow running

            error = {
                "code": -1,
                "message": response.text,
                "status": "invalid JSON: '{}'".format(e),
            }

        super().__init__(error)
        self.response: Response = response
        self.error: Mapping[str, Any] = error
        self.code: int = self.error["code"]

    def __str__(self) -> str:
        return "{}: [{}]: {}".format(
            self.__class__.__name__, self.code, self.error["message"]
        )

    def __repr__(self) -> str:
        return self.__str__()

    def __reduce__(self) -> tuple:
        return self.__class__, (self.response,)


class SpreadsheetNotFound(GSpreadException):