diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:28:01 +0000 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:28:01 +0000 |
commit | 8ec7f656134b1230ab23003a94ba3266d7064122 (patch) | |
tree | bc730d5fb3302dc375edd26b26f750d609b61d72 /Doc/library/tabnanny.rst | |
parent | f56181ff53ba00b7bed3997a4dccd9a1b6217b57 (diff) | |
download | cpython-git-8ec7f656134b1230ab23003a94ba3266d7064122.tar.gz |
Move the 2.6 reST doc tree in place.
Diffstat (limited to 'Doc/library/tabnanny.rst')
-rw-r--r-- | Doc/library/tabnanny.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/Doc/library/tabnanny.rst b/Doc/library/tabnanny.rst new file mode 100644 index 0000000000..80326557b4 --- /dev/null +++ b/Doc/library/tabnanny.rst @@ -0,0 +1,70 @@ + +: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, 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 :func:`check` +described below. + +.. warning:: + + 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 print statement. + + +.. 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 FIXME: Document \function{errprint}, +.. % \function{format_witnesses} \class{Whitespace} +.. % check_equal, indents +.. % \function{reset_globals} + + +.. seealso:: + + Module :mod:`tokenize` + Lexical scanner for Python source code. + + .. % XXX may be add a reference to IDLE? + |