Skip to content

gh-130433: Update documentation for MultipartConversionError #130436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 26, 2025
Merged

gh-130433: Update documentation for MultipartConversionError #130436

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36fc6b6
gh-130433: Update documentation for `MultipartConversionError`
Feb 21, 2025
434e3f9
Fixup
Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions Doc/library/email.errors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,8 @@ The following exception classes are defined in the :mod:`email.errors` module:

.. exception:: MultipartConversionError()

Raised when a payload is added to a :class:`~email.message.Message` object
using :meth:`add_payload`, but the payload is already a scalar and the
message's :mailheader:`Content-Type` main type is not either
:mimetype:`multipart` or missing. :exc:`MultipartConversionError` multiply
inherits from :exc:`MessageError` and the built-in :exc:`TypeError`.
Comment on lines -51 to -52
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you retain the note about inheriting from MessageError and TypeError?


Since :meth:`Message.add_payload` is deprecated, this exception is rarely
raised in practice. However the exception may also be raised if the
:meth:`~email.message.Message.attach`
method is called on an instance of a class derived from
Raised if the :meth:`~email.message.Message.attach` method is called
on an instance of a class derived from
:class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g.
:class:`~email.mime.image.MIMEImage`).

Expand Down
Loading