tracing-0.6/0000775000175000017500000000000011635173727011174 5ustar liwliwtracing-0.6/Makefile0000664000175000017500000000012011635173727012625 0ustar liwliwall: $(MAKE) -C doc html clean: $(MAKE) -C doc clean rm -rf build *.py[co] tracing-0.6/speed-test0000775000175000017500000000071411635173727013201 0ustar liwliw#!/bin/sh set -e measure() { python -m timeit \ -s 'import logging, tracing' \ -s 'logging.basicConfig(filename="/dev/null")' \ -s "$1" \ -s ' class Foo(object): def foo(self): tracing.trace("%s", "bar") f = Foo() ' \ 'f.foo()' } echo Without patterns measure "pass" echo With unmatching pattern measure 'tracing.trace_add_pattern("yikes")' echo With matching pattern measure 'tracing.trace_add_pattern("timeit-src")' tracing-0.6/project.meta0000664000175000017500000000016211635173727013511 0ustar liwliw[config] basetgz = /home/pbuilder-tgz/sid-amd64-pristine.tgz, squeeze:/home/pbuilder-tgz/squeeze-amd64-custom.tgz tracing-0.6/tracing.py0000664000175000017500000000613711635173727013204 0ustar liwliw# Copyright (C) 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, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ''':mod:`tracing` -- fast debug trace messages ================================== This module provides fast debugging log messages that can be turned on and off during runtime. 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. Yet, keeping the logging statements can be a good idea so that they can be enabled if there is a problem that needs debugging, as long as there is a way to disable them in normal production mode. This module provides a way to achieve that. For example:: # in the main program import tracing tracing.trace_add_pattern('foobar') tracing.trace_add_pattern('yeehaa') ... # in some other module tracing.trace('start procedure') tracing.trace('arg1=%s', arg1) tracing.trace('arg2=%s', arg2) Only calls that happen in files whose names contain ``foobar`` or ``yeehaa`` will actually be logged. Pattern matching is based on substring checking only, for speed, so there is no globbing or regular expression matching. ''' __version__ = '0.6' import logging import os import traceback trace_patterns = [] trace_cache = set() def trace_add_pattern(pattern): '''Add a module name pattern.''' trace_patterns.append(pattern) def trace_clear_patterns(): '''Remove all module name patterns. After this, nothing will be traced. This is also the initial state. ''' del trace_patterns[:] trace_cache.clear() def trace(msg, *args): '''Log a trace message if the calling module's name matches a pattern. If any arguments are given, the message is formatted as if with ``msg % args``, otherwise the message is written out as is. ''' if trace_patterns: frames = traceback.extract_stack(limit=2) filename, lineno, funcname, text = frames[0] log_it = filename in trace_cache if not log_it: for pattern in trace_patterns: if pattern in filename: log_it = True trace_cache.add(filename) break if log_it: filename = os.path.basename(filename) if args: msg = msg % args logging.debug('%s:%s:%s: %s' % (filename, lineno, funcname, msg)) tracing-0.6/example.py0000664000175000017500000000203611635173727013202 0ustar liwliw# Copyright (C) 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, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. import logging import tracing class Foo(object): def foo(self): self.bar() def bar(self): tracing.trace('this is output') f = Foo() logging.basicConfig(level=logging.DEBUG) tracing.trace_add_pattern('example') f.foo() tracing.trace_clear_patterns() f.foo() tracing-0.6/setup.py0000664000175000017500000000374211635173727012714 0ustar liwliw#!/usr/bin/python # Copyright (C) 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, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. from distutils.core import setup, Extension import tracing setup(name='tracing', version=tracing.__version__, author='Lars Wirzenius', author_email='liw@liw.fi', url='http://liw.fi/tracing/', description='debug log/trace messages', long_description='''\ This library provides a function for logging debug messages. It is sometimes practical during software development 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. It is much faster than using `logging.Filter` to accomplish the same thing, which matters when code is run in production mode. The actual logging still happens using the `logging` library. ''', classifiers=[ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU General Public License (GPL)', 'Programming Language :: Python', 'Topic :: Software Development', 'Topic :: System :: Logging', ], py_modules=['tracing'], ) tracing-0.6/NEWS0000664000175000017500000000114311635173727011672 0ustar liwliwNEWS for python-tracing ======================= Version 0.6, released 2011-09-17 -------------------------------- * Debian packaging fixes. Version 0.5, released 2011-05-28 -------------------------------- * Build documentation with sphinx. Version 0.4, released 2011-05-18 -------------------------------- * No functional changes. * This is the first version to be uploaded to Debian, so there are some changes to the packaging. Version 0.3, released 2011-04-23 -------------------------------- * This is the first version that really gets released outside of my own little corner of the universe. tracing-0.6/README0000664000175000017500000000310511635173727012053 0ustar liwliwREADME 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 . tracing-0.6/doc/0000775000175000017500000000000011635173727011741 5ustar liwliwtracing-0.6/doc/Makefile0000664000175000017500000000607111635173727013405 0ustar liwliw# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/tracing.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/tracing.qhc" latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." tracing-0.6/doc/_static/0000775000175000017500000000000011635173727013367 5ustar liwliwtracing-0.6/doc/_templates/0000775000175000017500000000000011635173727014076 5ustar liwliwtracing-0.6/doc/conf.py0000664000175000017500000001436611635173727013252 0ustar liwliw# -*- coding: utf-8 -*- # # tracing documentation build configuration file, created by # sphinx-quickstart on Sat May 28 16:44:32 2011. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..')) # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. project = u'tracing' copyright = u'2011, Lars Wirzenius' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. import tracing version = tracing.__version__ # The full version, including alpha/beta/rc tags. release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. #unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_use_modindex = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'tracingdoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'tracing.tex', u'tracing Documentation', u'Lars Wirzenius', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True tracing-0.6/doc/index.rst0000664000175000017500000000053411635173727013604 0ustar liwliw.. tracing documentation master file, created by sphinx-quickstart on Sat May 28 16:44:32 2011. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to tracing's documentation! =================================== .. automodule:: tracing :members: :undoc-members: tracing-0.6/doc/_build/0000775000175000017500000000000011635173727013177 5ustar liwliw