matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Change behaviour of on_error

Browse Source 
Change how the old style on_error event is called to match the new style
on_error event.  Both are now called in case an exception is raised in
an user defined event handler, and will by default print the arguments
of the event tha raised the exception and the traceback for the
exception.  In addition, overridding the on_error handler supresses this
behaviour.
This commit is contained in:
Hornwitser 2015-09-29 09:19:33 +02:00
parent d044d7b781
commit 74a06e0b79
2 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
discord/client.py
View File

@ -360,7 +360,7 @@ class Client(object):
self.events = {
'on_ready': _null_event,
'on_disconnect': _null_event,
'on_error': _null_event,
'on_error': self.on_error,
'on_response': _null_event,
'on_message': _null_event,
'on_message_delete': _null_event,
@ -457,8 +457,7 @@ class Client(object):
log.info('attempting to invoke event {}'.format(event_name))
self.events[event_name](*args, **kwargs)
except Exception as e:
log.error('an error ({}) occurred in event {} so on_error is invoked instead'.format(type(e).__name__, event_name))
self.events['on_error'](event_name, *sys.exc_info())
self.events['on_error'](event_name, *args, **kwargs)
def handle_socket_update(self, event, data):
method = '_'.join(('handle', event.lower()))

28
docs/api.rst
View File

@ -30,18 +30,28 @@ All events are 'sandboxed', in that if an exception is thrown while the event is
Called when the client disconnects for whatever reason. Be it error or manually.
.. function:: on_error(event, type, value, traceback)
.. function:: on_error(event, \*args, \*\*kwargs)
Usually when an event throws an uncaught exception, it is swallowed. If you want to handle
the uncaught exceptions for whatever reason, this event is called. If an exception is thrown
on this event then it propagates (i.e. it is not swallowed silently).
Usually when an event throws an uncaught exception, a traceback is
printed to stderr and the exception is ignored. If you want to
change this behaviour and handle the uncaught exception for whatever
reason, this event can be overridden. The default behaviour for
on_error is printing a traceback and then ignoring the exception,
but defining an on_error handler will supress this behaviour.
The parameters for this event are retrieved through the use of ``sys.exc_info()``.
If you want exception to propogate out of the :class:`Client` class
you can define an ``on_error`` handler consisting of a single empty
``raise`` statement. Exceptions raised by ``on_error`` will not be
handled in any way by :class:`Client`.
:param event: The event name that had the uncaught exception.
:param type: The type of exception that was swallowed.
:param value: The actual exception that was swallowed.
:param traceback: The traceback object representing the traceback of the exception swallowed.
The information of the exception rasied can be retreived with a
standard call to ``sys.exc_info()``.
:param event: The name of the event that raised the exception.
:param args: The positional arguments for the event that raised the
exception.
:param kwargs: The keyword arguments for the event that raised the
execption.
.. function:: on_message(message)