GNU Info

(python2.1-lib.info)tabnanny

---

Next: pyclbr Prev: tokenize Up: Python Language Services

---

Enter node , (file) or (file)node

Detection of ambiguous indentation
==================================

Tool for detecting white space related problems in Python source files
in a directory tree.  This module was written by Tim Peters
<tim_one@email.msn.com>.
This manual section was written by Peter Funk <pf@artcom-gmbh.de>.
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
`check()' described below.

*Warning:*  The API provided by this module is likely to change in
future releases; such changes may not be backward compatible.

`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 `.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 print statement.

`verbose'
     Flag indicating whether to print verbose messages.  This is set to
     true by the `-v' option if called as a script.

`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.

`NannyNag'
     Raised by `tokeneater()' if detecting an ambiguous indent.
     Captured and handled in `check()'.

`tokeneater(type, token, start, end, line)'
     This function is used by `check()' as a callback parameter to the
     function `tokenize.tokenize()'.

See also:
     Note: tokenize Lexical scanner for Python source code.