Skip to content

gh-133311: have MIMEImage respect policy.max_line_length #133322

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+17 −3
Open

gh-133311: have MIMEImage respect policy.max_line_length #133322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b8d3df
mime: have MIMEImage respect policy.max_line_length
vedant713 May 2, 2025
d309c31
bpo-133311: have MIMEImage respect policy.max_line_length
vedant713 May 2, 2025
9e6d97f
bpo-133311: add NEWS entry
vedant713 May 2, 2025
c10626b
📜🤖 Added by blurb_it.
blurb-it[bot] May 2, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions Lib/email/mime/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

from email import encoders
from email.mime.nonmultipart import MIMENonMultipart
import base64
Copy link
Contributor

Choose a reason for hiding this comment

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

It's best to sort the imports, although there won't be any negative impact if we don't do so :)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this repo allow some sort of pre-commit? Like isort and blake hooks. Those things can help do this automatically.
Copy link
Contributor

@abhi-jha abhi-jha May 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Wait, I do see a pre-commit setup : https://github.com/python/cpython/blob/main/.pre-commit-config.yaml

The CIs don't seem to be imposing these?

Linter failures : https://github.com/python/cpython/actions/runs/14805087091/job/41571892036?pr=133322
from textwrap import wrap
Copy link
Member

Choose a reason for hiding this comment

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

base64 and textwrap are expensive imports. It might be a good idea to move them to the method to reduce import time.


class MIMEImage(MIMENonMultipart):
Expand Down Expand Up @@ -39,9 +41,19 @@ def __init__(self, _imagedata, _subtype=None,
raise TypeError('Could not guess image MIME subtype')
MIMENonMultipart.__init__(self, 'image', _subtype, policy=policy,
**_params)
self.set_payload(_imagedata)
_encoder(self)

#self.set_payload(_imagedata)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we remove these comments?
#_encoder(self)
# 1) Turn your image bytes into one long Base64 string
b64str = base64.b64encode(_imagedata).decode('ascii')

# 2) Ask the policy “how long should each line be?”
maxlen = getattr(self.policy, 'max_line_length', 76)

# 3) Break that long string into chunks of that length
wrapped = "\r\n".join(wrap(b64str, maxlen))

# 4) Give the email library those nice, wrapped lines
self.set_payload(wrapped, 'base64', policy=self.policy)

_rules = []

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/133311.rst
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

We only need one news entry, and the title is in the wrong format, so delete this one.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix email.mime.image.MIMEImage to respect policy.max_line_length (bpo-133311).
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2025-05-02-23-35-26.gh-issue-133311.c36IjF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix email.mime.image.MIMEImage to respect policy.max_line_length when Base64-encoding image payloads.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Fix email.mime.image.MIMEImage to respect policy.max_line_length when Base64-encoding image payloads.
Fix :class:`email.mime.image.MIMEImage` not respecting :attr:`~email.policy.Policy.max_line_length` when Base64-encoding image payloads.
Loading