File: index.rst

package info (click to toggle)
python-tiered-debug 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 252 kB
  • sloc: python: 808; makefile: 13
file content (30 lines) | stat: -rw-r--r-- 763 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

tiered_debug documentation
==========================

**tiered-debug** is a Python module for tiered debug logging at levels 1-5, with
configurable stack levels for accurate caller reporting and extra metadata for
enhanced log context. It is designed for projects requiring detailed debugging,
such as Elasticsearch workflows.

The module provides a ``TieredDebug`` class for logging, and the ``debug.py``
module offers a global ``TieredDebug`` instance and a ``begin_end`` decorator to
log function entry and exit at customizable debug levels.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage
   debug
   api
   contributing
   CHANGELOG

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`