README for python-tracing
=========================

This package provides the Python library 'tracing' to help with logging 
debug messages.

This package provides 'tracing' module, with a couple of functions for 
logging debug messages. It is sometimes practical to add a lot of 
debugging log messages to a program, but having them enabled all the 
time results in very large log files. Also, logging that much takes 
quite a bit of time.

This module provides a way to turn such debugging or tracing messages
on and off, based on the filename they occur in.

A similar effect can be had by adding a `logging.Filter` that enables
or disables log messages at the `DEBUG` level. The filter gets called
by the `logging` library at the suitable time. However, this is about
an order of magnitude slower for the case of running software in
production mode, with all tracing turned off. That is the reason
for the `tracing` library to exist.


Legalese
--------

Copyright 2011  Lars Wirzenius

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

=*= License: GPL-3+ =*=
