mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-30 14:44:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Update get_param() description to reflect changes to the docstring.

Browse source
This commit is contained in:
Barry Warsaw 2003-08-19 04:26:59 +00:00
parent c86c24e44d
commit 463c5a868f
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Doc/lib/emailmessage.tex
View file

@ -354,15 +354,18 @@ instead of \mailheader{Content-Type}.
Parameter keys are always compared case insensitively. The return
value can either be a string, or a 3-tuple if the parameter was
\rfc{2231} encoded. When it's a 3-tuple, the elements of the value are of
the form \code{(CHARSET, LANGUAGE, VALUE)}, where \code{LANGUAGE} may
be the empty string. Your application should be prepared to deal with
3-tuple return values, which it can convert to a Unicode string like
so:
the form \code{(CHARSET, LANGUAGE, VALUE)}. Note that both \code{CHARSET} and
\code{LANGUAGE} can be \code{None}, in which case you should consider
\code{VALUE} to be encoded in the \code{us-ascii} charset. You can
usually ignore \code{LANGUAGE}.
Your application should be prepared to deal with 3-tuple return
values, and can convert the parameter to a Unicode string like so:
\begin{verbatim}
param = msg.get_param('foo')
if isinstance(param, tuple):
param = unicode(param[2], param[0])
param = unicode(param[2], param[0] or 'us-ascii')
\end{verbatim}
In any case, the parameter value (either the returned string, or the