python / python/cpython

Expand payload types for `email.message.Message.set_payload`

Open
#136,397 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stdlib topic-email type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

While working on bug in PR #136071 we (me and @picnixz) discussed that set_payload of email.message.Message method could use list, str, bytes or handle buffer objects as payload to set.

For now it using duck type for objects with decode and encode methods. https://github.com/python/cpython/blob/main/Lib/email/message.py#L335-L353

I guess we need to decide necessary of it and if so the types that need to be support. Also update typing in typeshed for email.message.Message

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

#134759
#136071

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading Lib/email/message.py around lines 335-353 and the linked discussions in #134759 and #136071. Determine the supported payload types and update the typing for email.message.Message in typeshed; done means the type decision is resolved and both runtime behavior and annotations reflect it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.