Mercurial > kallithea
view docs/usage/debugging.rst @ 8163:24e1099e4f29
py3: make get_current_authuser handle missing tg context consistently and explicitly
tg context handling ends up using
tg.support.registry.StackedObjectProxy._current_obj for attribute access ...
which if no context has been pushed will end up in:
raise TypeError(
'No object (name: %s) has been registered for this '
'thread' % self.____name__)
utils2.get_current_authuser used code like:
if hasattr(tg.tmpl_context, 'authuser'):
Python 2 hasattr will call __getattr__ and return False if it throws any
exception. (It would thus catch the TypeError and silently fall through to use
the default user None.) This hasattr behavior is confusing and hard to use
correctly. Here, it was used incorrectly. It has been common practice to work
around by using something like:
getattr(x, y, None) is not None
Python 3 hasattr fixed this flaw and only catches AttributeError. The TypeError
would thus (rightfully) be propagated. That is a change that must be handled
when introducing py3 support.
The get_current_authuser code could more clearly and simple and py3-compatible
be written as:
return getattr(tmpl_context, 'authuser', None)
- but then we also have to handle the TypeError explicitly ... which we are
happy to do.
author | Mads Kiilerich <mads@kiilerich.com> |
---|---|
date | Fri, 31 Jan 2020 18:48:15 +0100 |
parents | 87ac42db389c |
children |
line wrap: on
line source
.. _debugging: =================== Debugging Kallithea =================== If you encounter problems with Kallithea, here are some instructions on how to debug them. .. note:: First make sure you're using the latest version available. Enable detailed debug --------------------- Kallithea uses the standard Python ``logging`` module to log its output. By default only loggers with ``INFO`` level are displayed. To enable full output change ``level = DEBUG`` for all logging handlers in the currently used .ini file. This change will allow you to see much more detailed output in the log file or console. This generally helps a lot to track issues. Enable interactive debug mode ----------------------------- To enable interactive debug mode simply comment out ``set debug = false`` in the .ini file. This will trigger an interactive debugger each time there is an error in the browser, or send a http link if an error occurred in the backend. This is a great tool for fast debugging as you get a handy Python console right in the web view. .. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console can be a serious security threat to your system.