traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make sure the \declaremodule uses the right name for the module! 

Clean up several markup problems & inconsistencies.
This commit is contained in:
Fred Drake 2000-04-06 16:09:59 +00:00
parent 343301aaa4
commit 69ca950d1f
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Doc/lib/libcodecs.tex
View File

@ -1,7 +1,7 @@
\section{\module{codecs} --- \section{\module{codecs} ---
Python codec registry and base classes} Codec registry and base classes}
\declaremodule{standard}{codec} \declaremodule{standard}{codecs}
\modulesynopsis{Encode and decode data and streams.} \modulesynopsis{Encode and decode data and streams.}
\moduleauthor{Marc-Andre Lemburg}{mal@lemburg.com} \moduleauthor{Marc-Andre Lemburg}{mal@lemburg.com}
\sectionauthor{Marc-Andre Lemburg}{mal@lemburg.com} \sectionauthor{Marc-Andre Lemburg}{mal@lemburg.com}
@ -35,20 +35,21 @@ return a tuple of functions \code{(\var{encoder}, \var{decoder}, \var{stream_rea
\var{stream_reader} and \var{stream_writer}: These have to be \var{stream_reader} and \var{stream_writer}: These have to be
factory functions providing the following interface: factory functions providing the following interface:
\code{factory(\var{stream},\var{errors}='strict')} \code{factory(\var{stream}, \var{errors}='strict')}
The factory functions must return objects providing the interfaces The factory functions must return objects providing the interfaces
defined by the base classes defined by the base classes \class{StreamWriter} and
\class{StreamWriter}/\class{StreamReader} resp. Stream codecs can \class{StreamReader}, respectively. Stream codecs can maintain
maintain state. state.
Possible values for errors are 'strict' (raise an exception in case Possible values for errors are \code{'strict'} (raise an exception
of an encoding error), 'replace' (replace malformed data with a in case of an encoding error), \code{'replace'} (replace malformed
suitable replacement marker, e.g. '?') and 'ignore' (ignore data with a suitable replacement marker, such as \character{?}) and
malformed data and continue without further notice). \code{'ignore'} (ignore malformed data and continue without further
notice).
In case a search function cannot find a given encoding, it should In case a search function cannot find a given encoding, it should
return None. return \code{None}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{lookup}{encoding} \begin{funcdesc}{lookup}{encoding}
@ -57,20 +58,21 @@ function tuple as defined above.
Encodings are first looked up in the registry's cache. If not found, Encodings are first looked up in the registry's cache. If not found,
the list of registered search functions is scanned. If no codecs tuple the list of registered search functions is scanned. If no codecs tuple
is found, a LookupError is raised. Otherwise, the codecs tuple is is found, a \exception{LookupError} is raised. Otherwise, the codecs
stored in the cache and returned to the caller. tuple is stored in the cache and returned to the caller.
\end{funcdesc} \end{funcdesc}
To simplify working with encoded files or stream, the module To simplify working with encoded files or stream, the module
also defines these utility functions: also defines these utility functions:
\begin{funcdesc}{open}{filename, mode\optional{, encoding=None, errors='strict', buffering=1}} \begin{funcdesc}{open}{filename, mode\optional{, encoding=None\optional{, errors='strict'\optional{, buffering=1}}}}
Open an encoded file using the given \var{mode} and return Open an encoded file using the given \var{mode} and return
a wrapped version providing transparent encoding/decoding. a wrapped version providing transparent encoding/decoding.
Note: The wrapped version will only accept the object format defined \strong{Note:} The wrapped version will only accept the object format
by the codecs, i.e. Unicode objects for most builtin codecs. Output is defined by the codecs, i.e. Unicode objects for most builtin
also codec dependent and will usually by Unicode as well. codecs. Output is also codec dependent and will usually by Unicode as
well.
\var{encoding} specifies the encoding which is to be used for the \var{encoding} specifies the encoding which is to be used for the
the file. the file.
@ -79,11 +81,11 @@ the file.
to 'strict' which causes a \exception{ValueError} to be raised in case to 'strict' which causes a \exception{ValueError} to be raised in case
an encoding error occurs. an encoding error occurs.
\var{buffering} has the same meaning as for the builtin open() API. \var{buffering} has the same meaning as for the built-in
It defaults to line buffered. \function{open()} function. It defaults to line buffered.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{EncodedFile}{file, input\optional{, output=None, errors='strict'}} \begin{funcdesc}{EncodedFile}{file, input\optional{, output=None\optional{, errors='strict'}}}
Return a wrapped version of file which provides transparent Return a wrapped version of file which provides transparent
encoding translation. encoding translation.