Files @ 0996e43e89c7
Branch filter:

Location: kallithea/docs/usage/debugging.rst - annotation

0996e43e89c7 1.2 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Thomas De Schampheleire
tests: fix assert rewriting in non-test modules like api_base.py

pytest rewrites assert statements in tests so it can print details about the
values involved when the assert fails.

Since pytest 3.0.0, this was no longer the case for files/modules that are
not discovered as test modules, i.e. starting with 'test_'. Examples are:
api/api_base.py
models/common.py
base.py
fixture.py

Commit 790aeeddcab598d2aacbbecf86830b608ca8b32b attempted to fix that
problem, but seems incorrect. A trailing dot should not be there.
.. _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.