Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv5163
Modified Files:
email.tex emailgenerator.tex emailparser.tex
Log Message:
nits
Index: email.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/email.tex,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** email.tex 1 Oct 2002 14:17:10 -0000 1.15
--- email.tex 1 Oct 2002 15:29:08 -0000 1.16
***************
*** 101,104 ****
--- 101,105 ----
\item The \module{email.Header} and \module{email.Charset} modules
have been added.
+
\item The pickle format for \class{Message} instances has changed.
Since this was never (and still isn't) formally defined, this
***************
*** 108,111 ****
--- 109,113 ----
instances now have private variables \var{_charset} and
\var{_default_type}.
+
\item Several methods in the \class{Message} class have been
deprecated, or their signatures changed. Also, many new methods
***************
*** 113,116 ****
--- 115,119 ----
class for details. The changes should be completely backward
compatible.
+
\item The object structure has changed in the face of
\mimetype{message/rfc822} content types. In \module{email}
***************
*** 133,136 ****
--- 136,140 ----
\method{set_payload()} with a \class{Message} instance on a
container with a content type of \mimetype{message/rfc822}.
+
\item The \class{Parser} constructor's \var{strict} argument was
added, and its \method{parse()} and \method{parsestr()} methods
***************
*** 138,153 ****
--- 142,162 ----
also added to functions \function{email.message_from_file()}
and \function{email.message_from_string()}.
+
\item \method{Generator.__call__()} is deprecated; use
\method{Generator.flatten()} instead. The \class{Generator}
class has also grown the \method{clone()} method.
+
\item The \class{DecodedGenerator} class in the
\module{email.Generator} module was added.
+
\item The intermediate base classes \class{MIMENonMultipart} and
\class{MIMEMultipart} have been added, and interposed in the
class hierarchy for most of the other MIME-related derived
classes.
+
\item The \var{_encoder} argument to the \class{MIMEText} constructor
has been deprecated. Encoding now happens implicitly based
on the \var{_charset} argument.
+
\item The following functions in the \module{email.Utils} module have
been deprecated: \function{dump_address_pairs()},
***************
*** 156,159 ****
--- 165,169 ----
\function{make_msgid()}, \function{decode_rfc2231()},
\function{encode_rfc2231()}, and \function{decode_params()}.
+
\item The non-public function \function{email.Iterators._structure()}
was added.
***************
*** 185,190 ****
--- 195,202 ----
\item \function{messageFromString()} has been renamed to
\function{message_from_string()}.
+
\item \function{messageFromFile()} has been renamed to
\function{message_from_file()}.
+
\end{itemize}
***************
*** 193,207 ****
--- 205,227 ----
\begin{itemize}
\item The method \method{asString()} was renamed to \method{as_string()}.
+
\item The method \method{ismultipart()} was renamed to
\method{is_multipart()}.
+
\item The \method{get_payload()} method has grown a \var{decode}
optional argument.
+
\item The method \method{getall()} was renamed to \method{get_all()}.
+
\item The method \method{addheader()} was renamed to \method{add_header()}.
+
\item The method \method{gettype()} was renamed to \method{get_type()}.
+
\item The method\method{getmaintype()} was renamed to
\method{get_main_type()}.
+
\item The method \method{getsubtype()} was renamed to
\method{get_subtype()}.
+
\item The method \method{getparams()} was renamed to
\method{get_params()}.
***************
*** 210,229 ****
--- 230,257 ----
the key/value pairs of the parameters, split on the \character{=}
sign.
+
\item The method \method{getparam()} was renamed to \method{get_param()}.
+
\item The method \method{getcharsets()} was renamed to
\method{get_charsets()}.
+
\item The method \method{getfilename()} was renamed to
\method{get_filename()}.
+
\item The method \method{getboundary()} was renamed to
\method{get_boundary()}.
+
\item The method \method{setboundary()} was renamed to
\method{set_boundary()}.
+
\item The method \method{getdecodedpayload()} was removed. To get
similar functionality, pass the value 1 to the \var{decode} flag
of the {get_payload()} method.
+
\item The method \method{getpayloadastext()} was removed. Similar
functionality
is supported by the \class{DecodedGenerator} class in the
\refmodule{email.Generator} module.
+
\item The method \method{getbodyastext()} was removed. You can get
similar functionality by creating an iterator with
***************
*** 252,261 ****
--- 280,292 ----
and \var{_minor} have changed to \var{_maintype} and
\var{_subtype} respectively.
+
\item The \code{Image} class/module has been renamed to
\code{MIMEImage}. The \var{_minor} argument has been renamed to
\var{_subtype}.
+
\item The \code{Text} class/module has been renamed to
\code{MIMEText}. The \var{_minor} argument has been renamed to
\var{_subtype}.
+
\item The \code{MessageRFC822} class/module has been renamed to
\code{MIMEMessage}. Note that an earlier version of
Index: emailgenerator.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/emailgenerator.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** emailgenerator.tex 1 Oct 2002 04:33:14 -0000 1.5
--- emailgenerator.tex 1 Oct 2002 15:29:09 -0000 1.6
***************
*** 106,116 ****
--- 106,122 ----
\begin{itemize}
\item \code{type} -- Full MIME type of the non-\mimetype{text} part
+
\item \code{maintype} -- Main MIME type of the non-\mimetype{text} part
+
\item \code{subtype} -- Sub-MIME type of the non-\mimetype{text} part
+
\item \code{filename} -- Filename of the non-\mimetype{text} part
+
\item \code{description} -- Description associated with the
non-\mimetype{text} part
+
\item \code{encoding} -- Content transfer encoding of the
non-\mimetype{text} part
+
\end{itemize}
Index: emailparser.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/emailparser.tex,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** emailparser.tex 1 Oct 2002 04:33:16 -0000 1.7
--- emailparser.tex 1 Oct 2002 15:29:09 -0000 1.8
***************
*** 136,139 ****
--- 136,140 ----
\code{False} for \method{is_multipart()}. Their
\method{get_payload()} method will return a string object.
+
\item All \mimetype{multipart} type messages will be parsed as a
container message object with a list of sub-message objects for
***************
*** 142,145 ****
--- 143,147 ----
\method{get_payload()} method will return the list of
\class{Message} subparts.
+
\item Most messages with a content type of \mimetype{message/*}
(e.g. \mimetype{message/deliver-status} and
In directory usw-pr-cvs1:/tmp/cvs-serv5163
Modified Files:
email.tex emailgenerator.tex emailparser.tex
Log Message:
nits
Index: email.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/email.tex,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** email.tex 1 Oct 2002 14:17:10 -0000 1.15
--- email.tex 1 Oct 2002 15:29:08 -0000 1.16
***************
*** 101,104 ****
--- 101,105 ----
\item The \module{email.Header} and \module{email.Charset} modules
have been added.
+
\item The pickle format for \class{Message} instances has changed.
Since this was never (and still isn't) formally defined, this
***************
*** 108,111 ****
--- 109,113 ----
instances now have private variables \var{_charset} and
\var{_default_type}.
+
\item Several methods in the \class{Message} class have been
deprecated, or their signatures changed. Also, many new methods
***************
*** 113,116 ****
--- 115,119 ----
class for details. The changes should be completely backward
compatible.
+
\item The object structure has changed in the face of
\mimetype{message/rfc822} content types. In \module{email}
***************
*** 133,136 ****
--- 136,140 ----
\method{set_payload()} with a \class{Message} instance on a
container with a content type of \mimetype{message/rfc822}.
+
\item The \class{Parser} constructor's \var{strict} argument was
added, and its \method{parse()} and \method{parsestr()} methods
***************
*** 138,153 ****
--- 142,162 ----
also added to functions \function{email.message_from_file()}
and \function{email.message_from_string()}.
+
\item \method{Generator.__call__()} is deprecated; use
\method{Generator.flatten()} instead. The \class{Generator}
class has also grown the \method{clone()} method.
+
\item The \class{DecodedGenerator} class in the
\module{email.Generator} module was added.
+
\item The intermediate base classes \class{MIMENonMultipart} and
\class{MIMEMultipart} have been added, and interposed in the
class hierarchy for most of the other MIME-related derived
classes.
+
\item The \var{_encoder} argument to the \class{MIMEText} constructor
has been deprecated. Encoding now happens implicitly based
on the \var{_charset} argument.
+
\item The following functions in the \module{email.Utils} module have
been deprecated: \function{dump_address_pairs()},
***************
*** 156,159 ****
--- 165,169 ----
\function{make_msgid()}, \function{decode_rfc2231()},
\function{encode_rfc2231()}, and \function{decode_params()}.
+
\item The non-public function \function{email.Iterators._structure()}
was added.
***************
*** 185,190 ****
--- 195,202 ----
\item \function{messageFromString()} has been renamed to
\function{message_from_string()}.
+
\item \function{messageFromFile()} has been renamed to
\function{message_from_file()}.
+
\end{itemize}
***************
*** 193,207 ****
--- 205,227 ----
\begin{itemize}
\item The method \method{asString()} was renamed to \method{as_string()}.
+
\item The method \method{ismultipart()} was renamed to
\method{is_multipart()}.
+
\item The \method{get_payload()} method has grown a \var{decode}
optional argument.
+
\item The method \method{getall()} was renamed to \method{get_all()}.
+
\item The method \method{addheader()} was renamed to \method{add_header()}.
+
\item The method \method{gettype()} was renamed to \method{get_type()}.
+
\item The method\method{getmaintype()} was renamed to
\method{get_main_type()}.
+
\item The method \method{getsubtype()} was renamed to
\method{get_subtype()}.
+
\item The method \method{getparams()} was renamed to
\method{get_params()}.
***************
*** 210,229 ****
--- 230,257 ----
the key/value pairs of the parameters, split on the \character{=}
sign.
+
\item The method \method{getparam()} was renamed to \method{get_param()}.
+
\item The method \method{getcharsets()} was renamed to
\method{get_charsets()}.
+
\item The method \method{getfilename()} was renamed to
\method{get_filename()}.
+
\item The method \method{getboundary()} was renamed to
\method{get_boundary()}.
+
\item The method \method{setboundary()} was renamed to
\method{set_boundary()}.
+
\item The method \method{getdecodedpayload()} was removed. To get
similar functionality, pass the value 1 to the \var{decode} flag
of the {get_payload()} method.
+
\item The method \method{getpayloadastext()} was removed. Similar
functionality
is supported by the \class{DecodedGenerator} class in the
\refmodule{email.Generator} module.
+
\item The method \method{getbodyastext()} was removed. You can get
similar functionality by creating an iterator with
***************
*** 252,261 ****
--- 280,292 ----
and \var{_minor} have changed to \var{_maintype} and
\var{_subtype} respectively.
+
\item The \code{Image} class/module has been renamed to
\code{MIMEImage}. The \var{_minor} argument has been renamed to
\var{_subtype}.
+
\item The \code{Text} class/module has been renamed to
\code{MIMEText}. The \var{_minor} argument has been renamed to
\var{_subtype}.
+
\item The \code{MessageRFC822} class/module has been renamed to
\code{MIMEMessage}. Note that an earlier version of
Index: emailgenerator.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/emailgenerator.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** emailgenerator.tex 1 Oct 2002 04:33:14 -0000 1.5
--- emailgenerator.tex 1 Oct 2002 15:29:09 -0000 1.6
***************
*** 106,116 ****
--- 106,122 ----
\begin{itemize}
\item \code{type} -- Full MIME type of the non-\mimetype{text} part
+
\item \code{maintype} -- Main MIME type of the non-\mimetype{text} part
+
\item \code{subtype} -- Sub-MIME type of the non-\mimetype{text} part
+
\item \code{filename} -- Filename of the non-\mimetype{text} part
+
\item \code{description} -- Description associated with the
non-\mimetype{text} part
+
\item \code{encoding} -- Content transfer encoding of the
non-\mimetype{text} part
+
\end{itemize}
Index: emailparser.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/emailparser.tex,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** emailparser.tex 1 Oct 2002 04:33:16 -0000 1.7
--- emailparser.tex 1 Oct 2002 15:29:09 -0000 1.8
***************
*** 136,139 ****
--- 136,140 ----
\code{False} for \method{is_multipart()}. Their
\method{get_payload()} method will return a string object.
+
\item All \mimetype{multipart} type messages will be parsed as a
container message object with a list of sub-message objects for
***************
*** 142,145 ****
--- 143,147 ----
\method{get_payload()} method will return the list of
\class{Message} subparts.
+
\item Most messages with a content type of \mimetype{message/*}
(e.g. \mimetype{message/deliver-status} and