[Python-checkins] cpython (2.7): Merge #11216: document all possible set_charset execution paths.
r.david.murray
python-checkins at python.org
Tue Mar 15 23:01:38 CET 2011
http://hg.python.org/cpython/rev/43ccd051ec6c
changeset: 68564:43ccd051ec6c
branch: 2.7
parent: 68537:2baaabf6bb05
user: R David Murray <rdmurray at bitdance.com>
date: Tue Mar 15 18:01:04 2011 -0400
summary:
Merge #11216: document all possible set_charset execution paths.
files:
Doc/library/email.message.rst
diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -133,8 +133,22 @@
string naming a character set, or ``None``. If it is a string, it will
be converted to a :class:`~email.charset.Charset` instance. If *charset*
is ``None``, the ``charset`` parameter will be removed from the
- :mailheader:`Content-Type` header. Anything else will generate a
- :exc:`TypeError`.
+ :mailheader:`Content-Type` header (the message will not be otherwise
+ modified). Anything else will generate a :exc:`TypeError`.
+
+ If there is no existing :mailheader:`MIME-Version` header one will be
+ added. If there is no existing :mailheader:`Content-Type` header, one
+ will be added with a value of :mimetype:`text/plain`. Whether the
+ :mailheader:`Content-Type` header already exists or not, its ``charset``
+ parameter will be set to *charset.output_charset*. If
+ *charset.input_charset* and *charset.output_charset* differ, the payload
+ will be re-encoded to the *output_charset*. If there is no existing
+ :mailheader:`Content-Transfer-Encoding` header, then the payload will be
+ transfer-encoded, if needed, using the specified
+ :class:`~email.charset.Charset`, and a header with the appropriate value
+ will be added. If a :mailheader:`Content-Transfer-Encoding` header
+ already exists, the payload is assumed to already be correctly encoded
+ using that :mailheader:`Content-Transfer-Encoding` and is not modified.
The message will be assumed to be of type :mimetype:`text/\*`, with the
payload either in unicode or encoded with *charset.input_charset*.
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list