Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | |
| 2 | :mod:`tabnanny` --- Detection of ambiguous indentation |
| 3 | ====================================================== |
| 4 | |
| 5 | .. module:: tabnanny |
| 6 | :synopsis: Tool for detecting white space related problems in Python source files in a |
| 7 | directory tree. |
| 8 | .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> |
| 9 | .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> |
| 10 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 11 | .. rudimentary documentation based on module comments |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 12 | |
| 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` |
| 15 | described below. |
| 16 | |
| 17 | .. warning:: |
| 18 | |
| 19 | The API provided by this module is likely to change in future releases; such |
| 20 | changes may not be backward compatible. |
| 21 | |
| 22 | |
| 23 | .. function:: check(file_or_dir) |
| 24 | |
| 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` |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 27 | files along the way. If *file_or_dir* is an ordinary Python source file, it |
| 28 | is checked for whitespace related problems. The diagnostic messages are |
| 29 | written to standard output using the :func:`print` function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 30 | |
| 31 | |
| 32 | .. data:: verbose |
| 33 | |
| 34 | Flag indicating whether to print verbose messages. This is incremented by the |
| 35 | ``-v`` option if called as a script. |
| 36 | |
| 37 | |
| 38 | .. data:: filename_only |
| 39 | |
| 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 |
| 42 | as a script. |
| 43 | |
| 44 | |
| 45 | .. exception:: NannyNag |
| 46 | |
| 47 | Raised by :func:`tokeneater` if detecting an ambiguous indent. Captured and |
| 48 | handled in :func:`check`. |
| 49 | |
| 50 | |
| 51 | .. function:: tokeneater(type, token, start, end, line) |
| 52 | |
| 53 | This function is used by :func:`check` as a callback parameter to the function |
| 54 | :func:`tokenize.tokenize`. |
| 55 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 56 | .. XXX document errprint, format_witnesses, Whitespace, check_equal, indents, |
| 57 | reset_globals |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 58 | |
| 59 | |
| 60 | .. seealso:: |
| 61 | |
| 62 | Module :mod:`tokenize` |
| 63 | Lexical scanner for Python source code. |