2 :mod:`tabnanny` --- Detection of ambiguous indentation
3 ======================================================
6 :synopsis: Tool for detecting white space related problems in Python source files in a
8 .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
9 .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de>
11 .. rudimentary documentation based on module comments
13 For the time being this module is intended to be called as a script. However it
14 is possible to import it into an IDE and use the function :func:`check`
19 The API provided by this module is likely to change in future releases; such
20 changes may not be backward compatible.
23 .. function:: check(file_or_dir)
25 If *file_or_dir* is a directory and not a symbolic link, then recursively
26 descend the directory tree named by *file_or_dir*, checking all :file:`.py`
27 files along the way. If *file_or_dir* is an ordinary Python source file, it is
28 checked for whitespace related problems. The diagnostic messages are written to
29 standard output using the print statement.
34 Flag indicating whether to print verbose messages. This is incremented by the
35 ``-v`` option if called as a script.
38 .. data:: filename_only
40 Flag indicating whether to print only the filenames of files containing
41 whitespace related problems. This is set to true by the ``-q`` option if called
45 .. exception:: NannyNag
47 Raised by :func:`tokeneater` if detecting an ambiguous indent. Captured and
48 handled in :func:`check`.
51 .. function:: tokeneater(type, token, start, end, line)
53 This function is used by :func:`check` as a callback parameter to the function
54 :func:`tokenize.tokenize`.
56 .. XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
62 Module :mod:`tokenize`
63 Lexical scanner for Python source code.