<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"module-pyclbr.html" />
<link rel=
"prev" href=
"module-tokenize.html" />
<link rel=
"parent" href=
"language.html" />
<link rel=
"next" href=
"module-pyclbr.html" />
<meta name='aesop' content='information'
/>
<title>18.6 tabnanny -- Detection of ambiguous indentation
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"18.5 tokenize "
href=
"module-tokenize.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"18. Python Language Services"
href=
"language.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"18.7 pyclbr "
href=
"module-pyclbr.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-tokenize.html">18.5 tokenize
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"language.html">18. Python Language Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-pyclbr.html">18.7 pyclbr
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION0020600000000000000000">
18.6 <tt class=
"module">tabnanny
</tt> --
Detection of ambiguous indentation
</A>
<A NAME=
"module-tabnanny"></A>
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
<tt class=
"function">check()
</tt> described below.
<span class=
"warning"><b class=
"label">Warning:
</b>
The API provided by this module is likely to change
in future releases; such changes may not be backward compatible.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4974' xml:id='l2h-
4974'
class=
"function">check
</tt></b>(
</nobr></td>
<td><var>file_or_dir
</var>)
</td></tr></table></dt>
If
<var>file_or_dir
</var> is a directory and not a symbolic link, then
recursively descend the directory tree named by
<var>file_or_dir
</var>,
checking all
<span class=
"file">.py
</span> files along the way. If
<var>file_or_dir
</var>
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.
<dl><dt><b><tt id='l2h-
4975' xml:id='l2h-
4975'
>verbose
</tt></b></dt>
Flag indicating whether to print verbose messages.
This is incremented by the
<code>-v
</code> option if called as a script.
<dl><dt><b><tt id='l2h-
4976' xml:id='l2h-
4976'
>filename_only
</tt></b></dt>
Flag indicating whether to print only the filenames of files
containing whitespace related problems. This is set to true by the
<code>-q
</code> option if called as a script.
<dl><dt><b><span class=
"typelabel">exception
</span> <tt id='l2h-
4977' xml:id='l2h-
4977'
class=
"exception">NannyNag
</tt></b></dt>
Raised by
<tt class=
"function">tokeneater()
</tt> if detecting an ambiguous indent.
Captured and handled in
<tt class=
"function">check()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4978' xml:id='l2h-
4978'
class=
"function">tokeneater
</tt></b>(
</nobr></td>
<td><var>type, token, start, end, line
</var>)
</td></tr></table></dt>
This function is used by
<tt class=
"function">check()
</tt> as a callback parameter to
the function
<tt class=
"function">tokenize.tokenize()
</tt>.
<p class=
"heading">See Also:
</p>
<dl compact=
"compact" class=
"seemodule">
<dt>Module
<b><tt class=
"module"><a href=
"module-tokenize.html">tokenize
</a></tt>:
</b>
<dd>Lexical scanner for Python source code.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"18.5 tokenize "
href=
"module-tokenize.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"18. Python Language Services"
href=
"language.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"18.7 pyclbr "
href=
"module-pyclbr.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-tokenize.html">18.5 tokenize
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"language.html">18. Python Language Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-pyclbr.html">18.7 pyclbr
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.