bpo-37479: on Enum subclasses with mixins, format uses overridden str #14545

thatneat · 2019-07-02T05:42:02Z

https://bugs.python.org/issue37479

… __str__

the-knights-who-say-ni · 2019-07-02T05:42:05Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

ericvsmith

In addition to the test you have, I'd like to see some tests with classes that define format, and with format and str.

thatneat · 2019-07-02T20:06:14Z

Test coverage is now something like:

overrides `__str__`	overrides `__format__`	mixin/"pure" `Enum`	asserts `str`	asserts `format`	test name
y	n	pure	y	y	`test_str_override_enum` (new)
n	y	pure	y	y	`test_format_override_enum` (new)
y	y	pure	y	y	`test_str_and_format_override_enum` (new)
y	n	mixin	y	y	`test_str_override_mixin` (new)
y	y	mixin	y	y	`test_str_and_format_override_mixin` (new)
n	y	mixin	y (new)	y	`test_format_override_mixin` (renamed)
n	n	mixin	n	y	`test_format_enum_date etc`
n	n	mixin	y	n	`test_multiple_mixin`
y	n	pure	y	n	`TestFlag.test_str`

ethanfurman

Just a couple changes needed.

Also, please add yourself to the ACKS file.

Thank you for working on this!

Doc/library/enum.rst

Lib/test/test_enum.py

bedevere-bot · 2019-07-04T01:42:09Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

thatneat · 2019-07-04T03:43:14Z

Thanks for the review! I have made the requested changes; please review again :)

bedevere-bot · 2019-07-04T03:43:17Z

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

ethanfurman

Nearly there!

Doc/library/enum.rst

bedevere-bot · 2019-07-04T06:05:46Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

thatneat · 2019-07-04T15:31:39Z

I have made the requested changes; please review again - though check the comment above in case we want to do one more quick round.

bedevere-bot · 2019-07-04T15:31:42Z

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

miss-islington · 2019-07-04T18:31:01Z

Sorry, @thatneat and @ethanfurman, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.7

miss-islington · 2019-07-04T18:31:03Z

Sorry @thatneat and @ethanfurman, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.8

thatneat · 2019-07-04T19:52:39Z

Is that something I can do, or something you'll need to do @ethanfurman?

…

On Thu, Jul 4, 2019 at 11:31 AM Miss Islington (bot) < ***@***.***> wrote: Sorry @thatneat <https://github.com/thatneat> and @ethanfurman <https://github.com/ethanfurman>, I had trouble checking out the 3.8 backport branch. Please backport using cherry_picker <https://pypi.org/project/cherry-picker/> on command line. cherry_picker 2f19e82 3.8 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#14545?email_source=notifications&email_token=AAZPVU5MNB7SQAPGOS4EFULP5Y6ZTA5CNFSM4H4YFV2KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZH6VPY#issuecomment-508553919>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAZPVU6LWIWBZRJANCZR2D3P5Y6ZTANCNFSM4H4YFV2A> .

ethanfurman · 2019-07-04T20:01:10Z

@thatneat If you know your way around git and GitHub feel free! My git-fu is very weak. In case you haven't seen it, the dev guide is here:

https://devguide.python.org/

thatneat · 2019-07-04T20:25:45Z

It looks like I don't have the permissions I need to use the cherry_picker tool. I almost got there, but it requires push access to the repo. I didn't even have to get too dirty in git-land. All I had to do was:

pip install cherry_picker --user
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.7

Then, manually edit Misc/ACKS to remove the merge markers but keep the additions (search for ">>>>" and delete the 3 lines that don't belong), then

git add Misc/ACKS
cherry_picker --continue # This is where I was blocked by not being allowed to push to the 3.7 branch

# This one didn't even appear to require a manual merge; it was just good to go.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.8

… __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__

(cherry picked from commit 2f19e82)

miss-islington · 2020-09-13T20:14:12Z

Thanks @thatneat for the PR, and @ethanfurman for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington · 2020-09-13T20:14:18Z

Sorry, @thatneat and @ethanfurman, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.8

…ridden __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__. (cherry picked from commit 2f19e82) Co-authored-by: thatneat <thatneat@users.noreply.github.com>

bedevere-bot · 2020-09-13T20:20:13Z

GH-22227 is a backport of this pull request to the 3.8 branch.

miss-islington · 2020-09-13T20:22:33Z

Thanks @thatneat for the PR, and @ethanfurman for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington · 2020-09-13T20:22:36Z

Sorry @thatneat and @ethanfurman, I had trouble checking out the 3.7 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.7

…ridden __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__. (cherry picked from commit 2f19e82) Co-authored-by: thatneat <thatneat@users.noreply.github.com>

bedevere-bot · 2020-09-13T20:25:00Z

GH-22228 is a backport of this pull request to the 3.7 branch.

miss-islington · 2020-09-13T20:45:41Z

Thanks @thatneat for the PR, and @ethanfurman for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

miss-islington · 2020-09-13T20:45:47Z

Sorry, @thatneat and @ethanfurman, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2f19e82fbe98ce86bcd98a176328af2808b678e8 3.9

* bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__. (cherry picked from commit 2f19e82) Co-authored-by: thatneat <thatneat@users.noreply.github.com>

dvarrazzo · 2022-05-16T18:09:02Z

Maybe this change should be mentioned in the 3.11 what's new. It has the potential of breaking a lot of code.

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden…

60ee8a6

… __str__

the-knights-who-say-ni added the CLA not signed label Jul 2, 2019

bedevere-bot added the awaiting review label Jul 2, 2019

ericvsmith reviewed Jul 2, 2019

View changes

thatneat added 2 commits Jul 2, 2019

More complete test coverage

f46f951

NEWS entry

91fb2cd

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Jul 2, 2019

one more test to fill out the grid

e54d60d

ethanfurman self-assigned this Jul 3, 2019

ethanfurman requested changes Jul 4, 2019

View changes

Doc/library/enum.rst Outdated Show resolved Hide resolved

Doc/library/enum.rst Outdated Show resolved Hide resolved

Lib/test/test_enum.py Outdated Show resolved Hide resolved

bedevere-bot added awaiting changes and removed awaiting review labels Jul 4, 2019

PR feedback: minor tweaks and ACKS entry

89991af

bedevere-bot added awaiting change review and removed awaiting changes labels Jul 4, 2019

ethanfurman requested changes Jul 4, 2019

View changes

Doc/library/enum.rst Outdated Show resolved Hide resolved

bedevere-bot added awaiting changes and removed awaiting change review labels Jul 4, 2019

fix markdown copy-paste

9ddf8ff

bedevere-bot added awaiting change review and removed awaiting changes labels Jul 4, 2019

LorenzMende pushed a commit to LorenzMende/cpython that referenced this issue Aug 11, 2019

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden…

5563ee4

… __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__

lisroach pushed a commit to lisroach/cpython that referenced this issue Sep 10, 2019

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden…

badd72d

… __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__

DinoV pushed a commit to DinoV/cpython that referenced this issue Jan 14, 2020

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden…

f21bae2

… __str__ (pythonGH-14545) * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__

ethanfurman pushed a commit to ethanfurman/cpython that referenced this issue Sep 13, 2020

bpo-37479: Enum - use correct __format__ (pythonGH-14545)

5d4b529

(cherry picked from commit 2f19e82)

ethanfurman added needs backport to 3.8 and removed needs backport to 3.7 needs backport to 3.8 labels Sep 13, 2020

bedevere-bot removed the needs backport to 3.8 label Sep 13, 2020

ethanfurman added the needs backport to 3.7 label Sep 13, 2020

bedevere-bot removed the needs backport to 3.7 label Sep 13, 2020

ethanfurman added the needs backport to 3.9 label Sep 13, 2020

ethanfurman removed the needs backport to 3.9 label Sep 13, 2020

ethanfurman mentioned this pull request Oct 2, 2020

bpo-41907: fix format() behavior for IntFlag #22497

Merged

python / cpython Public

bpo-37479: on Enum subclasses with mixins, format uses overridden str #14545

bpo-37479: on Enum subclasses with mixins, format uses overridden str #14545

thatneat commented Jul 2, 2019 •

edited by bedevere-bot

the-knights-who-say-ni commented Jul 2, 2019

ericvsmith left a comment

thatneat commented Jul 2, 2019

ethanfurman left a comment

bedevere-bot commented Jul 4, 2019

thatneat commented Jul 4, 2019

bedevere-bot commented Jul 4, 2019

ethanfurman left a comment

bedevere-bot commented Jul 4, 2019

thatneat commented Jul 4, 2019

bedevere-bot commented Jul 4, 2019

miss-islington commented Jul 4, 2019

miss-islington commented Jul 4, 2019

thatneat commented Jul 4, 2019

ethanfurman commented Jul 4, 2019

thatneat commented Jul 4, 2019 •

edited

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

bedevere-bot commented Sep 13, 2020

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

bedevere-bot commented Sep 13, 2020

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

dvarrazzo commented May 16, 2022

python / cpython Public

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__ #14545

bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__ #14545

Conversation

thatneat commented Jul 2, 2019 • edited by bedevere-bot

the-knights-who-say-ni commented Jul 2, 2019

ericvsmith left a comment

thatneat commented Jul 2, 2019

ethanfurman left a comment

bedevere-bot commented Jul 4, 2019

thatneat commented Jul 4, 2019

bedevere-bot commented Jul 4, 2019

ethanfurman left a comment

bedevere-bot commented Jul 4, 2019

thatneat commented Jul 4, 2019

bedevere-bot commented Jul 4, 2019

miss-islington commented Jul 4, 2019

miss-islington commented Jul 4, 2019

thatneat commented Jul 4, 2019

ethanfurman commented Jul 4, 2019

thatneat commented Jul 4, 2019 • edited

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

bedevere-bot commented Sep 13, 2020

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

bedevere-bot commented Sep 13, 2020

miss-islington commented Sep 13, 2020

miss-islington commented Sep 13, 2020

dvarrazzo commented May 16, 2022

bpo-37479: on Enum subclasses with mixins, format uses overridden str #14545

bpo-37479: on Enum subclasses with mixins, format uses overridden str #14545

thatneat commented Jul 2, 2019 •

edited by bedevere-bot

thatneat commented Jul 4, 2019 •

edited