mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Minor revisions to clarify the status of xreadlines(), change the way

Browse source 
iteration support was documented; the docs for __iter__() were just
confusing.
This commit is contained in:
Fred Drake 2002-11-15 16:38:06 +00:00
parent e0373f8179
commit 3a2cda876b
1 changed files with 14 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

29
Doc/lib/libbz2.tex
View file

@ -17,7 +17,7 @@ Here is a resume of the features offered by the bz2 module:
\begin{itemize} \begin{itemize}
\item \class{BZ2File} class implements a complete file interface, including \item \class{BZ2File} class implements a complete file interface, including
\method{readline()}, \method{readlines()}, \method{xreadlines()}, \method{readline()}, \method{readlines()},
\method{writelines()}, \method{seek()}, etc; \method{writelines()}, \method{seek()}, etc;
\item \class{BZ2File} class implements emulated \method{seek()} support; \item \class{BZ2File} class implements emulated \method{seek()} support;
\item \class{BZ2File} class implements universal newline support; \item \class{BZ2File} class implements universal newline support;
@ -47,14 +47,15 @@ it doesn't exist, and truncated otherwise. If \var{buffering} is given,
the default is \code{0}. If the default is \code{0}. If
\var{compresslevel} is given, must be a number between \code{1} and \var{compresslevel} is given, must be a number between \code{1} and
\code{9}; the default is \code{9}. \code{9}; the default is \code{9}.
Add a \code{'U'} to mode to open the file for input with universal newline Add a \character{U} to mode to open the file for input with universal newline
support. Any line ending in the input file will be seen as a support. Any line ending in the input file will be seen as a
\character{\textbackslash n} \character{\e n} in Python. Also, a file so opened gains the
in Python. Also, a file so opened gains the attribute \member{newlines}; attribute \member{newlines}; the value for this attribute is one of
the value for this attribute is one of \code{None} (no newline read yet), \code{None} (no newline read yet), \code{'\e r'}, \code{'\e n'},
\code{'\textbackslash r'}, \code{'\textbackslash n'}, \code{'\e r\e n'} or a tuple containing all the newline types
\code{'\textbackslash r\textbackslash n'} or a tuple containing all the seen. Universal newlines are available only when reading.
newline types seen. Universal newlines are available only when reading. Instances support iteration in the same way as normal \class{file}
instances.
\end{classdesc} \end{classdesc}
\begin{methoddesc}[BZ2File]{close}{} \begin{methoddesc}[BZ2File]{close}{}
@ -82,13 +83,11 @@ is an approximate bound on the total number of bytes in the lines returned.
\begin{methoddesc}[BZ2File]{xreadlines}{} \begin{methoddesc}[BZ2File]{xreadlines}{}
For backward compatibility. \class{BZ2File} objects now include the For backward compatibility. \class{BZ2File} objects now include the
performance optimizations previously implemented in the \module{xreadlines} performance optimizations previously implemented in the
module. \refmodule{xreadlines} module.
\end{methoddesc} \deprecated{2.3}{This exists only for compatibility with the method by
this name on \class{file} objects, which is
\begin{methoddesc}[BZ2File]{\_\_iter\_\_}{} deprecated. Use \code{for line in file} instead.}
Iterate through the file lines. Iteration optimization is implemented
using the same readahead algorithm available in \class{file} objects.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[BZ2File]{seek}{offset\optional{, whence}} \begin{methoddesc}[BZ2File]{seek}{offset\optional{, whence}}