Skip to content

gh-134759: UnboundLocalError in email.message.Message.get_payload #136071

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 12 commits into
base: main
Choose a base branch
from
Open

gh-134759: UnboundLocalError in email.message.Message.get_payload #136071

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
46be53f
Fix UnboundLocalError for bytes payload and quoted-printable cte.
skv0zsneg Jun 28, 2025
2d2906d
Add test for getting bytes payload with quoted-printable cte.
skv0zsneg Jun 28, 2025
771288d
Merge branch 'main' into fix-issue-134759
skv0zsneg Jun 28, 2025
8ccd326
Add myself to ACKS list.
skv0zsneg Jun 28, 2025
2271433
📜🤖 Added by blurb_it.
blurb-it[bot] Jun 28, 2025
e156408
Change elif statement to if
skv0zsneg Jun 28, 2025
e09adad
Merge branch 'fix-issue-134759' of github.com:skv0zsneg/cpython into …
skv0zsneg Jun 28, 2025
125a69a
Update Misc/NEWS.d/next/Library/2025-06-28-11-32-57.gh-issue-134759.A…
skv0zsneg Jun 28, 2025
14bc4e8
Merge branch 'main' into fix-issue-134759
skv0zsneg Jun 28, 2025
1789c2d
Merge branch 'main' into fix-issue-134759
skv0zsneg Jun 29, 2025
af9dae0
Upd test for using public method.
skv0zsneg Jun 29, 2025
9db7b01
Merge branch 'fix-issue-134759' of github.com:skv0zsneg/cpython into …
skv0zsneg Jun 29, 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
2 changes: 2 additions & 0 deletions Lib/email/message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ def get_payload(self, i=None, decode=False):
# If it does happen, turn the string into bytes in a way
# guaranteed not to fail.
bpayload = payload.encode('raw-unicode-escape')
else:
bpayload = payload
if cte == 'quoted-printable':
return quopri.decodestring(bpayload)
elif cte == 'base64':
Expand Down
7 changes: 7 additions & 0 deletions Lib/test/test_email/test_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,6 +1055,13 @@ def test_get_body_malformed(self):
# AttributeError: 'str' object has no attribute 'is_attachment'
m.get_body()

def test_get_bytes_payload_with_quoted_printable_encoding(self):
payload = b'Some payload'
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
def test_get_bytes_payload_with_quoted_printable_encoding(self):
payload = b'Some payload'
def test_get_bytes_payload_with_quoted_printable_encoding(self):
# See https://github.com/python/cpython/issues/134759.
payload = b'Some payload'

This comment was marked as resolved.

Sign in to view

Copy link
Member

Choose a reason for hiding this comment

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

We can use the following for only using public methods:

        payload = memoryview(b'Some payload')
        m = self._make_message()
        m.add_header('Content-Transfer-Encoding', 'quoted-printable')
        m.set_payload(payload)
        self.assertEqual(m.get_payload(decode=True), payload)

Copy link
Author

Choose a reason for hiding this comment

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

Yes, I was trying to reproduce bug with "public" method .set_payload(). I'm achieved that by passing BytesIO(b"Some payload") buffer but was not sure about correct arg type of .set_payload() (typeshed want object only with the .decode() method), so came up to put bytes directly.

I'll change the way you suggest, no problem :)

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, decode() is not present on memoryview but it's a buffer-like protocol so I think it should be fine. However, this may be a side-effect of the current implementation :) (also, the current implementation only does duck typing, not true isinstance() checks when setting the payload)

m = self._make_message()
m.add_header('Content-Transfer-Encoding', 'quoted-printable')
m._payload = payload
self.assertEqual(m.get_payload(decode=True), payload)


class TestMIMEPart(TestEmailMessageBase, TestEmailBase):
# Doing the full test run here may seem a bit redundant, since the two
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,7 @@ Alexander Lakeev
David Lam
Thomas Lamb
Valerie Lambert
Kliment Lamonov
Peter Lamut
Jean-Baptiste "Jiba" Lamy
Ronan Lamy
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2025-06-28-11-32-57.gh-issue-134759.AjjKcG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix :exc:`UnboundLocalError` in :func:`email.message.Message.get_payload` when
the payload to decode is a :class:`bytes` object. Patch by Kliment Lamonov.
Loading