Source code for pyrogram.methods.decorators.on_error

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Pyrogram is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations


import pyrogram
from pyrogram.filters import Filter
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from collections.abc import Callable, Sequence


class OnError:
    def on_error(
        self: OnError | Filter | None = None,
        exceptions: Exception | Sequence[Exception] | None = None,
        filters: Filter | None = None,
        group: int = 0,
    ) -> Callable:
        """Decorator for handling unexpected errors.

        This does the same thing as :meth:`~pyrogram.Client.add_handler` using the
        :obj:`~pyrogram.handlers.ErrorHandler`.

        .. include:: /_includes/usable-by/users-bots.rst

        Parameters:
            exceptions (``Exception`` | List of ``Exception``, *optional*):
                An exception type or a sequence of exception types that this handler should handle.
                If None, the handler will catch any exception that is a subclass of ``Exception``.

            filters (:obj:`~pyrogram.filters`, *optional*):
                Pass one or more filters to allow only a subset of messages to be passed
                in your function.

            group (``int``, *optional*):
                The group identifier, defaults to 0.
        """

        def decorator(func: Callable) -> Callable:
            if isinstance(self, pyrogram.Client):
                self.add_handler(pyrogram.handlers.ErrorHandler(func, exceptions, filters), group)
            else:
                if not hasattr(func, "handlers"):
                    func.handlers = []

                if self is not None:
                    handler_exceptions = self
                elif isinstance(exceptions, Filter):
                    handler_exceptions = None
                else:
                    handler_exceptions = exceptions

                if isinstance(exceptions, Filter):
                    handler_filters = exceptions
                elif isinstance(filters, Filter):
                    handler_filters = filters
                else:
                    handler_filters = None

                handler_group = filters if isinstance(filters, int) else group

                func.handlers.append(
                    (
                        pyrogram.handlers.ErrorHandler(func, handler_exceptions, handler_filters),
                        handler_group,
                    )
                )

            return func

        return decorator