mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

reflect csv's change back to a module. Document the new sniffer api.

Browse source
This commit is contained in:
Skip Montanaro 2003-04-25 15:14:49 +00:00
parent 9f48045ec0
commit 5d0136e297
1 changed files with 14 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

34
Doc/lib/libcsv.tex
View file

@ -19,18 +19,18 @@ vary, the overall format is similar enough that it is possible to write a
single module which can efficiently manipulate such data, hiding the details
of reading and writing the data from the programmer.
The \module{csv} package implements classes to read and write tabular data in
The \module{csv} module implements classes to read and write tabular data in
CSV format. It allows programmers to say, ``write this data in the format
preferred by Excel,'' or ``read data from this file which was generated by
Excel,'' without knowing the precise details of the CSV format used by
Excel. Programmers can also describe the CSV formats understood by other
applications or define their own special-purpose CSV formats.
The \module{csv} package's \class{reader} and \class{writer} objects read and
The \module{csv} module's \class{reader} and \class{writer} objects read and
write sequences. Programmers can also read and write data in dictionary
form using the \class{DictReader} and \class{DictWriter} classes.
\note{The first version of the \module{csv} package doesn't support Unicode
\note{The first version of the \module{csv} module doesn't support Unicode
input. Also, there are currently some issues regarding \ASCII{} NUL
characters. Accordingly, all input should generally be printable \ASCII{}
to be safe. These restrictions will be removed in the future.}
@ -43,10 +43,10 @@ to be safe. These restrictions will be removed in the future.}
\end{seealso}
\subsection{Package Contents}
\subsection{Module Contents}
The \module{csv} package defines the following functions:
The \module{csv} module defines the following functions:
\begin{funcdesc}{reader}{csvfile\optional{,
dialect=\code{'excel'}\optional{, fmtparam}}}
@ -109,7 +109,7 @@ Return the names of all registered dialects.
\end{funcdesc}
The \module{csv} package defines the following classes:
The \module{csv} module defines the following classes:
\begin{classdesc}{DictReader}{csvfile, fieldnames\optional{,
restkey=\code{None}\optional{,
@ -263,24 +263,18 @@ according to the current dialect.
\end{methoddesc}
\subsection{Submodule \code{utils}}
\begin{classdesc}{Sniffer}{}
The \module{csv} package contains a \module{utils} submodule which defines
the following class.
The \class{Sniffer} class is used to deduce the format of a CSV file.
\begin{classdesc}{Sniffer}{\optional{sample=16384}}
The \class{Sniffer} class is used to deduce the format of a CSV file. The
optional \var{sample} argument to the constructor specifies the number of
bytes to use when determining Dialect parameters.
\begin{methoddesc}{sniff}{fileobj}
Analyze the next chunk of \var{fileobj} and return a \class{Dialect} class
reflecting the parameters found.
\begin{methoddesc}{sniff}{sample}
Analyze the sample text (presumed to be in CSV format) and return a
{}\class{Dialect} class reflecting the parameters found.
\end{methoddesc}
\begin{methoddesc}
\begin{methoddesc}{has_header}{sample}
Analyze the sample text (presumed to be in CSV format) and return
{}\code{True} if the first row appears to be a series of column headers.
\end{methoddesc}
\end{classdesc}