[Python-checkins] CVS: python/dist/src/Doc/lib libbinascii.tex,1.20,1.21 libquopri.tex,1.13,1.14

Martin v. L?wis loewis@users.sourceforge.net
Sun, 30 Sep 2001 13:32:12 -0700


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

Modified Files:
	libbinascii.tex libquopri.tex 
Log Message:
Patch #462190, patch #464070: Support quoted printable in the binascii module.
Decode and encode underscores for header style encoding. Fixes bug #463996.


Index: libbinascii.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libbinascii.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** libbinascii.tex	2001/05/09 15:50:17	1.20
--- libbinascii.tex	2001/09/30 20:32:10	1.21
***************
*** 41,44 ****
--- 41,62 ----
  \end{funcdesc}
  
+ \begin{funcdesc}{a2b_qp}{string\optional{, header}}
+ Convert a block of quoted-printable data back to binary and return the
+ binary data. More than one line may be passed at a time.
+ If the optional argument \var{header} is present and true, underscores
+ will be decoded as spaces.
+ \end{funcdesc}
+ 
+ \begin{funcdesc}{b2a_qp}{data\optional{, quotetabs, istext, header}}
+ Convert binary data to a line(s) of \ASCII{} characters in
+ quoted-printable encoding.  The return value is the converted line(s).
+ If the optional argument \var{quotetabs} is present and true, all tabs
+ and spaces will be encoded.  If the optional argument \var{header} is
+ present and true, spaces will be encoded as underscores per RFC1522.
+ If the optional argument \var{header} is present and false, newline
+ characters will be encoded as well, otherwise linefeed conversion might
+ corrupt the binary data stream.
+ \end{funcdesc}
+ 
  \begin{funcdesc}{a2b_hqx}{string}
  Convert binhex4 formatted \ASCII{} data to binary, without doing
***************
*** 119,121 ****
--- 137,141 ----
  
    \seemodule{uu}{Support for UU encoding used on \UNIX.}
+ 
+   \seemodule{quopri}{Support for quoted-printable encoding used in MIME email messages. }
  \end{seealso}

Index: libquopri.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libquopri.tex,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** libquopri.tex	2001/06/19 19:44:42	1.13
--- libquopri.tex	2001/09/30 20:32:10	1.14
***************
*** 8,21 ****
  
  This module performs quoted-printable transport encoding and decoding,
! as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)
! Part One''.  The quoted-printable encoding is designed for data where
! there are relatively few nonprintable characters; the base64 encoding
! scheme available via the \refmodule{base64} module is more compact if there
! are many such characters, as when sending a graphics file.
  \indexii{quoted-printable}{encoding}
  \index{MIME!quoted-printable encoding}
  
  
! \begin{funcdesc}{decode}{input, output}
  Decode the contents of the \var{input} file and write the resulting
  decoded binary data to the \var{output} file.
--- 8,23 ----
  
  This module performs quoted-printable transport encoding and decoding,
! as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail
! Extensions) Part One: Mechanisms for Specifying and Describing the
! Format of Internet Message Bodies''.  The quoted-printable encoding is
! designed for data where there are relatively few nonprintable
! characters; the base64 encoding scheme available via the
! \refmodule{base64} module is more compact if there are many such
! characters, as when sending a graphics file.
  \indexii{quoted-printable}{encoding}
  \index{MIME!quoted-printable encoding}
  
  
! \begin{funcdesc}{decode}{input, output\optional{,header}}
  Decode the contents of the \var{input} file and write the resulting
  decoded binary data to the \var{output} file.
***************
*** 23,26 ****
--- 25,32 ----
  mimic the file object interface. \var{input} will be read until
  \code{\var{input}.readline()} returns an empty string.
+ If the optional argument \var{header} is present and true, underscore
+ will be decoded as space. This is used to decode
+ ``Q''-encoded headers as described in \rfc{1522}: ``MIME (Multipurpose Internet Mail Extensions)
+ Part Two: Message Header Extensions for Non-ASCII Text''.
  \end{funcdesc}
  
***************
*** 37,41 ****
  \end{funcdesc}
  
! \begin{funcdesc}{decodestring}{s}
  Like \function{decode()}, except that it accepts a source string and
  returns the corresponding decoded string.
--- 43,47 ----
  \end{funcdesc}
  
! \begin{funcdesc}{decodestring}{s\optional{,header}}
  Like \function{decode()}, except that it accepts a source string and
  returns the corresponding decoded string.