From dbf69a043fafc818e618d5e8ae4f2d1298b8bb09 Mon Sep 17 00:00:00 2001 From: Bob Kline Date: Sat, 14 Jan 2023 14:01:27 -0500 Subject: [PATCH] [3.10] gh-101021: Document binary parameters as bytes (GH-101024). (cherry picked from commit 49cae39ef020eaf242607bb2d2d193760b9855a6) Co-authored-by: Bob Kline --- Doc/library/email.mime.rst | 10 +++++----- Lib/email/mime/application.py | 2 +- Lib/email/mime/audio.py | 2 +- Lib/email/mime/image.py | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst index f37f6aa28dec7d..98e1258eb352a7 100644 --- a/Doc/library/email.mime.rst +++ b/Doc/library/email.mime.rst @@ -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 by the standard Python module :mod:`sndhdr`, 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 can be decoded by the standard Python module :mod:`imghdr`, then the subtype will be automatically included in the :mailheader:`Content-Type` header. Otherwise you can explicitly specify the image subtype via the *_subtype* diff --git a/Lib/email/mime/application.py b/Lib/email/mime/application.py index 6877e554e10271..f67cbad3f03407 100644 --- a/Lib/email/mime/application.py +++ b/Lib/email/mime/application.py @@ -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'. diff --git a/Lib/email/mime/audio.py b/Lib/email/mime/audio.py index 4bcd7b224a862a..7cca3f99f12861 100644 --- a/Lib/email/mime/audio.py +++ b/Lib/email/mime/audio.py @@ -46,7 +46,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 by the standard Python `sndhdr' module, then the subtype will be automatically included in the Content-Type header. Otherwise, you can specify the specific audio subtype via the diff --git a/Lib/email/mime/image.py b/Lib/email/mime/image.py index 92724643cdeeac..6dc7ec4ca2016d 100644 --- a/Lib/email/mime/image.py +++ b/Lib/email/mime/image.py @@ -20,7 +20,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 this data + _imagedata contains the bytes for the raw image data. If the data can be decoded by the standard Python `imghdr' module, then the subtype will be automatically included in the Content-Type header. Otherwise, you can specify the specific image subtype via the _subtype