Staging
v0.8.1
v0.8.1
https://github.com/python/cpython
Tip revision: 1da43e5e916949c8e849e656d9d05fa4b9d6836c authored by Benjamin Peterson on 26 June 2009, 13:21:52 UTC
rearrange the sections of the README, so they'll hopefully be more in the order people will interested in
rearrange the sections of the README, so they'll hopefully be more in the order people will interested in
Tip revision: 1da43e5
tabnanny.rst
:mod:`tabnanny` --- Detection of ambiguous indentation
======================================================
.. module:: tabnanny
:synopsis: Tool for detecting white space related problems in Python source files in a
directory tree.
.. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. sectionauthor:: Peter Funk <pf@artcom-gmbh.de>
.. rudimentary documentation based on module comments
For the time being this module is intended to be called as a script. However it
is possible to import it into an IDE and use the function :func:`check`
described below.
.. note::
The API provided by this module is likely to change in future releases; such
changes may not be backward compatible.
.. function:: check(file_or_dir)
If *file_or_dir* is a directory and not a symbolic link, then recursively
descend the directory tree named by *file_or_dir*, checking all :file:`.py`
files along the way. If *file_or_dir* is an ordinary Python source file, it
is checked for whitespace related problems. The diagnostic messages are
written to standard output using the :func:`print` function.
.. data:: verbose
Flag indicating whether to print verbose messages. This is incremented by the
``-v`` option if called as a script.
.. data:: filename_only
Flag indicating whether to print only the filenames of files containing
whitespace related problems. This is set to true by the ``-q`` option if called
as a script.
.. exception:: NannyNag
Raised by :func:`tokeneater` if detecting an ambiguous indent. Captured and
handled in :func:`check`.
.. function:: tokeneater(type, token, start, end, line)
This function is used by :func:`check` as a callback parameter to the function
:func:`tokenize.tokenize`.
.. XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
reset_globals
.. seealso::
Module :mod:`tokenize`
Lexical scanner for Python source code.