mirror of
https://github.com/python/cpython
synced 2024-10-14 09:43:55 +00:00
gh-101021: Document binary parameters as bytes (#101024)
This commit is contained in:
parent
ef633e5000
commit
49cae39ef0
|
@ -114,9 +114,9 @@ Here are the classes:
|
|||
|
||||
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
|
||||
:class:`MIMEApplication` class is used to represent MIME message objects of
|
||||
major type :mimetype:`application`. *_data* is a string containing the raw
|
||||
byte data. Optional *_subtype* specifies the MIME subtype and defaults to
|
||||
:mimetype:`octet-stream`.
|
||||
major type :mimetype:`application`. *_data* contains the bytes for the raw
|
||||
application data. Optional *_subtype* specifies the MIME subtype and defaults
|
||||
to :mimetype:`octet-stream`.
|
||||
|
||||
Optional *_encoder* is a callable (i.e. function) which will perform the actual
|
||||
encoding of the data for transport. This callable takes one argument, which is
|
||||
|
@ -145,7 +145,7 @@ Here are the classes:
|
|||
|
||||
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
|
||||
:class:`MIMEAudio` class is used to create MIME message objects of major type
|
||||
:mimetype:`audio`. *_audiodata* is a string containing the raw audio data. If
|
||||
:mimetype:`audio`. *_audiodata* contains the bytes for the raw audio data. If
|
||||
this data can be decoded as au, wav, aiff, or aifc, then the
|
||||
subtype will be automatically included in the :mailheader:`Content-Type` header.
|
||||
Otherwise you can explicitly specify the audio subtype via the *_subtype*
|
||||
|
@ -179,7 +179,7 @@ Here are the classes:
|
|||
|
||||
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
|
||||
:class:`MIMEImage` class is used to create MIME message objects of major type
|
||||
:mimetype:`image`. *_imagedata* is a string containing the raw image data. If
|
||||
:mimetype:`image`. *_imagedata* contains the bytes for the raw image data. If
|
||||
this data type can be detected (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm,
|
||||
rast, xbm, bmp, webp, and exr attempted), then the subtype will be
|
||||
automatically included in the :mailheader:`Content-Type` header. Otherwise
|
||||
|
|
|
@ -17,7 +17,7 @@ def __init__(self, _data, _subtype='octet-stream',
|
|||
_encoder=encoders.encode_base64, *, policy=None, **_params):
|
||||
"""Create an application/* type MIME document.
|
||||
|
||||
_data is a string containing the raw application data.
|
||||
_data contains the bytes for the raw application data.
|
||||
|
||||
_subtype is the MIME content type subtype, defaulting to
|
||||
'octet-stream'.
|
||||
|
|
|
@ -18,7 +18,7 @@ def __init__(self, _audiodata, _subtype=None,
|
|||
_encoder=encoders.encode_base64, *, policy=None, **_params):
|
||||
"""Create an audio/* type MIME document.
|
||||
|
||||
_audiodata is a string containing the raw audio data. If this data
|
||||
_audiodata contains the bytes for the raw audio data. If this data
|
||||
can be decoded as au, wav, aiff, or aifc, then the
|
||||
subtype will be automatically included in the Content-Type header.
|
||||
Otherwise, you can specify the specific audio subtype via the
|
||||
|
|
|
@ -17,7 +17,7 @@ def __init__(self, _imagedata, _subtype=None,
|
|||
_encoder=encoders.encode_base64, *, policy=None, **_params):
|
||||
"""Create an image/* type MIME document.
|
||||
|
||||
_imagedata is a string containing the raw image data. If the data
|
||||
_imagedata contains the bytes for the raw image data. If the data
|
||||
type can be detected (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm,
|
||||
rast, xbm, bmp, webp, and exr attempted), then the subtype will be
|
||||
automatically included in the Content-Type header. Otherwise, you can
|
||||
|
|
Loading…
Reference in a new issue