Class RedditAPIException

praw/exceptions.py:75–108

Container for error messages from Reddit's API.

class RedditAPIException(PRAWException):
    """Container for error messages from Reddit's API."""

    @staticmethod
    def parse_exception_list(
        exceptions: list[RedditErrorItem | list[str]],
    ) -> list[RedditErrorItem]:
        """Covert an exception list into a :class:`.RedditErrorItem` list."""
        return [
            (
                exception
                if isinstance(exception, RedditErrorItem)
                else RedditErrorItem(
                    error_type=exception[0],
                    field=exception[2] if bool(exception[2]) else "",
                    message=exception[1] if bool(exception[1]) else "",
                )
            )
            for exception in exceptions
        ]

    def __init__(self, items: list[RedditErrorItem | list[str] | str]) -> None:
        """Initialize a :class:`.RedditAPIException` instance.

        :param items: Either a list of instances of :class:`.RedditErrorItem` or a list
            containing lists of unformed errors.

        """
        if isinstance(items, list) and isinstance(items[0], str):
            parsed_items: list[RedditErrorItem | list[str]] = [cast("list[str]", items)]
        else:
            parsed_items = cast("list[RedditErrorItem | list[str]]", items)
        self.items = self.parse_exception_list(parsed_items)
        super().__init__(*self.items)


class RedditErrorItem: