From: Marc-André Lemburg <mal@egenix.com>
Date: Wed, 19 Sep 2001 11:33:31 +0000 (+0000)
Subject: Docs and News item for the codecs.py additions.
X-Git-Tag: v2.2.1c1~1732
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=494f2aea8e56a73012f7aeb31ecdd14b13c6da59;p=python

Docs and News item for the codecs.py additions.
---

diff --git a/Doc/lib/libcodecs.tex b/Doc/lib/libcodecs.tex
index acbed9a164..844f6ec7b8 100644
--- a/Doc/lib/libcodecs.tex
+++ b/Doc/lib/libcodecs.tex
@@ -63,6 +63,38 @@ is found, a \exception{LookupError} is raised. Otherwise, the codecs
 tuple is stored in the cache and returned to the caller.
 \end{funcdesc}
 
+To simply access to the various codecs, the module provides these
+additional functions which use \function{lookup()} for the codec
+lookup:
+
+\begin{funcdesc}{getencoder}{encoding}
+Lookup up the codec for the given encoding and return its encoder
+function.
+
+Raises a \exception{LookupError} in case the encoding cannot be found.
+\end{funcdesc}
+
+\begin{funcdesc}{getdecoder}{encoding}
+Lookup up the codec for the given encoding and return its decoder
+function.
+
+Raises a \exception{LookupError} in case the encoding cannot be found.
+\end{funcdesc}
+
+\begin{funcdesc}{getreader}{encoding}
+Lookup up the codec for the given encoding and return its StreamReader
+class or factory function.
+
+Raises a \exception{LookupError} in case the encoding cannot be found.
+\end{funcdesc}
+
+\begin{funcdesc}{getwriter}{encoding}
+Lookup up the codec for the given encoding and return its StreamWriter
+class or factory function.
+
+Raises a \exception{LookupError} in case the encoding cannot be found.
+\end{funcdesc}
+
 To simplify working with encoded files or stream, the module
 also defines these utility functions:
 
diff --git a/Misc/NEWS b/Misc/NEWS
index aca9b8bf77..f1037054d1 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -34,6 +34,10 @@ Core
 
 Library
 
+- The codecs module has grown four new helper APIs to access
+  builtin codecs: getencoder(), getdecoder(), getreader(),
+  getwriter().
+
 - SimpleXMLRPCServer: a new module (based upon SimpleHTMLServer)
   simplifies writing XML RPC servers.