mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-10-25 02:23:04 +00:00
Code Issues Projects Releases Wiki Activity

[tasks] Add support for passing an argument list of exceptions.

Browse Source
This commit is contained in:
mathsman5133
2019-09-03 17:37:11 +10:00
committed by Rapptz
parent 5022aa5a0b
commit 7f65d9a8b1
1 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
discord/ext/tasks/__init__.py
View File

@@ -210,8 +210,8 @@ class Loop:
self._task.add_done_callback(restart_when_over) self._task.add_done_callback(restart_when_over)
self._task.cancel() self._task.cancel()
def add_exception_type(self, exc): def add_exception_type(self, *exceptions):
r"""Adds an exception type to be handled during the reconnect logic. r"""Adds exception types to be handled during the reconnect logic.
By default the exception types handled are those handled by By default the exception types handled are those handled by
:meth:`discord.Client.connect`\, which includes a lot of internet disconnection :meth:`discord.Client.connect`\, which includes a lot of internet disconnection
@@ -222,21 +222,22 @@ class Loop:
Parameters Parameters
------------ ------------
exc: Type[:class:`BaseException`] \*exceptions: Type[:class:`BaseException`]
The exception class to handle. An argument list of exception classes to handle.
Raises Raises
-------- --------
TypeError TypeError
The exception passed is either not a class or not inherited from :class:`BaseException`. An exception passed is either not a class or not inherited from :class:`BaseException`.
""" """
for exc in exceptions:
if not inspect.isclass(exc): if not inspect.isclass(exc):
raise TypeError('{0!r} must be a class.'.format(exc)) raise TypeError('{0!r} must be a class.'.format(exc))
if not issubclass(exc, BaseException): if not issubclass(exc, BaseException):
raise TypeError('{0!r} must inherit from BaseException.'.format(exc)) raise TypeError('{0!r} must inherit from BaseException.'.format(exc))
self._valid_exception = (*self._valid_exception, exc) self._valid_exception = (*self._valid_exception, *exceptions)
def clear_exception_types(self): def clear_exception_types(self):
"""Removes all exception types that are handled. """Removes all exception types that are handled.
@@ -247,22 +248,22 @@ class Loop:
""" """
self._valid_exception = tuple() self._valid_exception = tuple()
def remove_exception_type(self, exc): def remove_exception_type(self, *exceptions):
"""Removes an exception type from being handled during the reconnect logic. r"""Removes exception types from being handled during the reconnect logic.
Parameters Parameters
------------ ------------
exc: Type[:class:`BaseException`] \*exceptions: Type[:class:`BaseException`]
The exception class to handle. An argument list of exception classes to handle.
Returns Returns
--------- ---------
:class:`bool` :class:`bool`
Whether it was successfully removed. Whether all exceptions were successfully removed.
""" """
old_length = len(self._valid_exception) old_length = len(self._valid_exception)
self._valid_exception = tuple(x for x in self._valid_exception if x is not exc) self._valid_exception = tuple(x for x in self._valid_exception if x not in exceptions)
return len(self._valid_exception) != old_length return len(self._valid_exception) == old_length - len(exceptions)
def get_task(self): def get_task(self):
"""Optional[:class:`asyncio.Task`]: Fetches the internal task or ``None`` if there isn't one running.""" """Optional[:class:`asyncio.Task`]: Fetches the internal task or ``None`` if there isn't one running."""