[Python-checkins] CVS: python/dist/src/Doc/lib libtokenize.tex,1.4,1.5

[Tim Peters]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv5587/python/dist/src/Doc/lib

Modified Files:
	libtokenize.tex 
Log Message:
Turns out Neil didn't intend for *all* of his gen-branch work to get
committed.

tokenize.py:  I like these changes, and have tested them extensively
without even realizing it, so I just updated the docstring and the docs.

tabnanny.py:  Also liked this, but did a little code fiddling.  I should
really rewrite this to *exploit* generators, but that's near the bottom
of my effort/benefit scale so doubt I'll get to it anytime soon (it
would be most useful as a non-trivial example of ideal use of generators;
but test_generators.py has already grown plenty of food-for-thought
examples).

inspect.py:  I'm sure Ping intended for this to continue running even
under 1.5.2, so I reverted this to the last pre-gen-branch version.  The
"bugfix" I checked in in-between was actually repairing a bug *introduced*
by the conversion to generators, so it's OK that the reverted version
doesn't reflect that checkin.


Index: libtokenize.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtokenize.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** libtokenize.tex	2001/03/23 05:22:12	1.4
--- libtokenize.tex	2001/06/29 23:51:07	1.5
***************
*** 13,22 ****
  ``pretty-printers,'' including colorizers for on-screen displays.
  
! The scanner is exposed by a single function:
  
  
  \begin{funcdesc}{tokenize}{readline\optional{, tokeneater}}
    The \function{tokenize()} function accepts two parameters: one
!   representing the input stream, and one providing an output mechanism 
    for \function{tokenize()}.
  
--- 13,43 ----
  ``pretty-printers,'' including colorizers for on-screen displays.
  
! The primary entry point is a generator:
  
+ \begin{funcdesc}{generate_tokens}{readline}
+   The \function{generate_tokens()} generator requires one argment,
+   \var{readline}, which must be a callable object which
+   provides the same interface as the \method{readline()} method of
+   built-in file objects (see section~\ref{bltin-file-objects}).  Each
+   call to the function should return one line of input as a string.
+ 
+   The generator produces 5-tuples with these members:
+   the token type;
+   the token string;
+   a 2-tuple \code{(\var{srow}, \var{scol})} of ints specifying the
+   row and column where the token begins in the source;
+   a 2-tuple \code{(\var{erow}, \var{ecol})} of ints specifying the
+   row and column where the token ends in the source;
+   and the line on which the token was found.
+   The line passed is the \emph{logical} line;
+   continuation lines are included.
+   \versionadded{2.2}
+ \end{funcdesc}
+ 
+ An older entry point is retained for backward compatibility:
  
  \begin{funcdesc}{tokenize}{readline\optional{, tokeneater}}
    The \function{tokenize()} function accepts two parameters: one
!   representing the input stream, and one providing an output mechanism
    for \function{tokenize()}.
  
***************
*** 27,41 ****
  
    The second parameter, \var{tokeneater}, must also be a callable
!   object.  It is called with five parameters: the token type, the
!   token string, a tuple \code{(\var{srow}, \var{scol})} specifying the 
!   row and column where the token begins in the source, a tuple
!   \code{(\var{erow}, \var{ecol})} giving the ending position of the
!   token, and the line on which the token was found.  The line passed
!   is the \emph{logical} line; continuation lines are included.
  \end{funcdesc}
  
  
! All constants from the \refmodule{token} module are also exported from 
! \module{tokenize}, as are two additional token type values that might be 
  passed to the \var{tokeneater} function by \function{tokenize()}:
  
--- 48,58 ----
  
    The second parameter, \var{tokeneater}, must also be a callable
!   object.  It is called once for each token, with five arguments,
!   corresponding to the tuples generated by \function{generate_tokens()}.
  \end{funcdesc}
  
  
! All constants from the \refmodule{token} module are also exported from
! \module{tokenize}, as are two additional token type values that might be
  passed to the \var{tokeneater} function by \function{tokenize()}: