diff options
| -rw-r--r-- | discord/client.py | 3 | ||||
| -rw-r--r-- | docs/api.rst | 21 |
2 files changed, 15 insertions, 9 deletions
diff --git a/discord/client.py b/discord/client.py index 7817c0c1..644a96ab 100644 --- a/discord/client.py +++ b/discord/client.py @@ -478,8 +478,7 @@ class Client(object): raise InvalidDestination('Destination must be Channel, PrivateChannel, User, or str') def on_error(self, event_method, *args, **kwargs): - msg = 'Caught exception in {} with args (*{}, **{})' - log.exception(msg.format(event_method, args, kwargs)) + logging.exception('Ignoring exception in {}'.format(event_method)) # Compatibility shim def __getattr__(self, name): diff --git a/docs/api.rst b/docs/api.rst index f60f2bea..0a4fcec8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -5,6 +5,14 @@ API Reference The following section outlines the API of discord.py. +.. note:: + + This module uses the Python logging module to log diagnostic and errors + in an output independent way. If the logging module is not configured, + these logs will not be output anywhere. See :ref:`logging_setup` for + more information on how to set up and use the logging module with + discord.py. + Client ------- @@ -36,13 +44,6 @@ to handle it, which defaults to log a traceback and ignore the exception. .. versionadded:: 0.7.0 Subclassing to listen to events. -.. note:: - - If the Python logging module is not configured, the logs will not be - output anywhere. Meaning that exceptions in handlers will be - silently ignored. See :ref:`logging_setup` for more information on how to - set up and use the logging module with discord.py. - .. function:: on_ready() @@ -57,6 +58,12 @@ to handle it, which defaults to log a traceback and ignore the exception. this event can be overridden. Which, when done, will supress the default logging done. + .. note:: + + The default ``on_error`` handler logs exception to the root logger + instead of a logger under the discord namespace. This is to ensure + that exceptions are output somewhere if logging is not configured. + The information of the exception rasied and the exception itself can be retreived with a standard call to ``sys.exc_info()``. |