From e16903f94ee7ef73017bd7cc37a67d5ca6456d81 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 17:32:47 +0100 Subject: Update tracing.py docstrings. --- tracing.py | 41 +++++++++++++++++++++++++++++++---------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/tracing.py b/tracing.py index 4c7eecb..34528da 100644 --- a/tracing.py +++ b/tracing.py @@ -15,16 +15,22 @@ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -'''Python debubbing log messages. +''':mod:`tracing` -- fast debug trace messages +================================== + +This module provides fast debugging log messages that can be +turned on and off during runtime. -This module provides 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. +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 turn such debugging or tracing messages -on and off, based on the filename they occur in. For example: +This module provides a way to achieve that. For example:: + # in the main program import tracing tracing.trace_add_pattern('foobar') @@ -32,13 +38,15 @@ on and off, based on the filename they occur in. For example: ... + # in some other module tracing.trace('start procedure') - tracing.trace('arg1=%s' % arg1) - tracing.trace('arg2=%s' % arg2) + 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, no globbing or regexps, sorry. +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. ''' @@ -53,15 +61,28 @@ 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] -- cgit v1.2.1 From feb6b2db9ec4f2ffc52b5a40ec45ed95ddadefba Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 17:35:39 +0100 Subject: Add version number into tracing.py. sphinx will dig it out from there, and avoids needs to update it many places. --- tracing.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tracing.py b/tracing.py index 34528da..d84b1fc 100644 --- a/tracing.py +++ b/tracing.py @@ -50,6 +50,8 @@ regular expression matching. ''' +__version__ = '0.4' + import logging import os -- cgit v1.2.1 From 9f133e2bf603483bea59916e84f41219c3227cc1 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 17:46:20 +0100 Subject: Add files to build docs with sphinx. --- doc/Makefile | 89 ++++++++++++++++++++++++++ doc/conf.py | 196 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 12 ++++ 3 files changed, 297 insertions(+) create mode 100644 doc/Makefile create mode 100644 doc/conf.py create mode 100644 doc/index.rst diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..937c572 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,89 @@ +# 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." diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..c2e8069 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,196 @@ +# -*- 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 diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..4c34244 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,12 @@ +.. 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: + -- cgit v1.2.1 From 4f587d5f4aae10622fb39e27c415f114060519d7 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 18:02:29 +0100 Subject: Add Makefile to build docs, clean up stuff. --- Makefile | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..6670249 --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +all: + $(MAKE) -C doc html + +clean: + $(MAKE) -C doc clean + rm -rf build *.py[co] + -- cgit v1.2.1 From f905a0cb86ae2619dfd7a6fa31b2eea5df163501 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 18:02:47 +0100 Subject: Fix setup.py to get version from tracing.py. --- setup.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a1789f3..7ede261 100644 --- a/setup.py +++ b/setup.py @@ -17,8 +17,10 @@ from distutils.core import setup, Extension +import tracing + setup(name='tracing', - version='0.4', + version=tracing.__version__, author='Lars Wirzenius', author_email='liw@liw.fi', url='http://liw.fi/tracing/', -- cgit v1.2.1 From 64b040bd6986121196c340c11f697c9baba8cdc7 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 28 May 2011 18:02:53 +0100 Subject: Install built docs. --- debian/python-tracing.docs | 1 + 1 file changed, 1 insertion(+) diff --git a/debian/python-tracing.docs b/debian/python-tracing.docs index ad4e32c..e4ba7fa 100644 --- a/debian/python-tracing.docs +++ b/debian/python-tracing.docs @@ -1,3 +1,4 @@ README NEWS example.py +doc/_build/html -- cgit v1.2.1