gh-118455: Fix mangle_from_ default value in email.policy.Policy.__doc__ #118456
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docstring says it defaults to True, but it actually defaults to False. Only the Compat32 subclass overrides that.
wimglenn
force-pushed
the
mangle-from-default
branch
from
8dd7c92
to
63e9592
Compare
sobolevn
reviewed
May 4, 2024
| @@ -0,0 +1 @@ | |||
| Correct default value of mangle_from\_ in email.policy.Policy docstring | |||
There was a problem hiding this comment.
We don't need NEWS for a doc-only change.
There was a problem hiding this comment.
Agree, but the CI fails without that and I don't have permission to add labels 🤷
sobolevn
approved these changes
May 5, 2024
There was a problem hiding this comment.
mangle_from_ is documented to be:
If optional *mangle_from_* is ``True``, put a ``>`` character in front of
any line in the body that starts with the exact string ``"From "``, that is
``From`` followed by a space at the beginning of a line. *mangle_from_*
defaults to the value of the :attr:`~email.policy.Policy.mangle_from_`
setting of the *policy* (which is ``True`` for the
:data:`~email.policy.compat32` policy and ``False`` for all others).
*mangle_from_* is intended for use when messages are stored in Unix mbox
format (see :mod:`mailbox` and `WHY THE CONTENT-LENGTH FORMAT IS BAD
<https://www.jwz.org/doc/content-length.html>`_).
It is set to False here:
cpython/Lib/email/_policybase.py
Line 166 in fed8d73
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 5, 2024
…y.__doc__ (pythonGH-118456) * Fix mangle_from_ default value in email.policy.Policy.__doc__ The docstring says it defaults to True, but it actually defaults to False. Only the Compat32 subclass overrides that. --------- (cherry picked from commit fed8d73) Co-authored-by: wim glenn <[email protected]> Co-authored-by: Nikita Sobolev <[email protected]>
|
GH-118586 is a backport of this pull request to the 3.12 branch. |
sobolevn
added a commit
that referenced
this pull request
May 5, 2024
…cy.__doc__ (GH-118456) (#118586) gh-118455: Fix mangle_from_ default value in email.policy.Policy.__doc__ (GH-118456) * Fix mangle_from_ default value in email.policy.Policy.__doc__ The docstring says it defaults to True, but it actually defaults to False. Only the Compat32 subclass overrides that. --------- (cherry picked from commit fed8d73) Co-authored-by: wim glenn <[email protected]> Co-authored-by: Nikita Sobolev <[email protected]>
SonicField
pushed a commit
to SonicField/cpython
that referenced
this pull request
May 8, 2024
…y.__doc__ (python#118456) * Fix mangle_from_ default value in email.policy.Policy.__doc__ The docstring says it defaults to True, but it actually defaults to False. Only the Compat32 subclass overrides that. --------- Co-authored-by: Nikita Sobolev <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The docstring says it defaults to True, but it actually defaults to False. Only the Compat32 subclass overrides that, if I understand correctly (cc @bitdancer ).