Skip to content

gh-139398: Make dir(Enum) include public _sunder_ helpers for REPL completions #139418

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-139398: Make dir(Enum) include public _sunder_ helpers for REPL completions #139418

wants to merge 4 commits into from

Conversation

SimonGPrs
Copy link

…for REPL completions (gh-139398)

  • I guess this enhances EnumType.dir to include documented public sunder helpers (add_alias, add_value_alias) if present on the Enum class
  • I think this could enabrle rlcompleter and the REPL show completions for these supported helpers and matching the intent of the enum API docs...
  • Normally I think no change to other (private or internal) sunder names
  • Fixes: REPL does not show completions for some members of the Enum module #139398

@SimonGPrs
Update enum.py [enum] Make dir(Enum) include public _sunder_ helpers …
a526094 
…for REPL completions (pythongh-139398)

- I guess this enhances EnumType.__dir__ to include documented public _sunder_ helpers
  (_add_alias_, _add_value_alias_) if present on the Enum class
- I think this could enabrle rlcompleter and the REPL show completions for these
  supported helpers and matching the intent of the enum API docs...
- Normally I think no change to other (private or internal) _sunder_ names
- Fixes: pythongh-139398
@python-cla-bot
Copy link

python-cla-bot bot commented Sep 29, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app

This comment was marked as resolved.

Sign in to view
@SimonGPrs SimonGPrs changed the title Update enum.py [enum] Make dir(Enum) include public _sunder_ helpers … [enum] Make dir(Enum) include public _sunder_ helpers for REPL completions (gh-139398) Sep 29, 2025
@bedevere-app bedevere-app bot mentioned this pull request Sep 29, 2025
Open
@SimonGPrs
[enum] Make dir(Enum) include public _sunder_ helpers for REPL comple…
7ab184a 
…tions (pythongh-139398)

Fix indentation in EnumType.__dir__ (pythongh-139398)

Add NEWS entry for enum dir(Enum) completions (pythongh-139398)
@bedevere-app

This comment was marked as resolved.

Sign in to view
@SimonGPrs

This comment was marked as resolved.

Sign in to view
@SimonGPrs

This comment was marked as resolved.

Sign in to view
@SimonGPrs
Update enum.py Trim trailing whitespace and fix formatting in enum.py
01d3a59 
- Remove trailing spaces to satisfy lint/pre-commit checks
- The code itself is not chnaged it is just the issue of the test
@RafaelWO

This comment was marked as resolved.

Sign in to view
@StanFromIreland StanFromIreland changed the title [enum] Make dir(Enum) include public _sunder_ helpers for REPL completions (gh-139398) gh-139398: Make dir(Enum) include public _sunder_ helpers for REPL completions (gh-139398) Sep 29, 2025
StanFromIreland
StanFromIreland reviewed Sep 29, 2025
View reviewed changes
Lib/enum.py
Comment on lines +776 to +800
interesting = set([
'__class__', '__contains__', '__doc__', '__getitem__',
'__iter__', '__len__', '__members__', '__module__',
'__name__', '__qualname__',
] + cls._member_names_)

if cls._new_member_ is not object.__new__:
interesting.add('__new__')
if cls.__init_subclass__ is not object.__init_subclass__:
interesting.add('__init_subclass__')

# SGP: Include documented public _sunder_ helpers defined on the Enum class.
# SGP: This makes them discoverable via dir(Enum) so rlcompleter can surface
# SGP: them in REPL completions. (rlcompleter drives dotted-name completion
# SGP: from dir(); _add_alias_/_add_value_alias_ are supported _sunder_ APIs.)
for _n in ("_add_alias_", "_add_value_alias_"):
if _n in cls.__dict__:
interesting.add(_n)

if cls._member_type_ is object:
return sorted(interesting)
else:
# return whatever mixed-in data type has
# SGP: union the mixin's dir() with 'interesting'
return sorted(set(dir(cls._member_type_)) | interesting)
Copy link
Member

Choose a reason for hiding this comment

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

The indentation is missed up.

Copy link
Author

Choose a reason for hiding this comment

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

I corrected the indentation I thought! OK I guess I am really not good enough...I should not have tried contributing and will first try to improve myself, I am sorry.

Copy link
Member

Choose a reason for hiding this comment

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

Everyone makes such small mistakes, all contributions are welcome:-) I think you accidentally unindented the whole section in 01d3a59

@StanFromIreland

This comment was marked as resolved.

Sign in to view
@RafaelWO

This comment was marked as off-topic.

Sign in to view
ethanfurman
ethanfurman requested changes Sep 29, 2025
View reviewed changes
@bedevere-app
Copy link

bedevere-app bot commented Sep 29, 2025

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.

@SimonGPrs
Copy link
Author

Not sure, but it looks like an AI bot/agent created this... at least it looks fishy to me 🧐 GH account also looks fresh.

I am not a bot...

@SimonGPrs
Copy link
Author

I think we should avoid making such accusations and give Simon the benefit of the doubt. However, note that our policy on generative ai can be found in the devguide.

I am sorry and you are right. Thanks for the link to the devguide!

Thank you! I am not great but studying intensly.

@SimonGPrs
Copy link
Author

OK I am sorry for the time taken to all of you and this catastrophic pull request, I will take some months on my side and try to improve.

@SimonGPrs
Copy link
Author

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.

OK I will have a look, I guess I am just bad, or at least not good enough to try to do that.

@bedevere-app
Copy link

bedevere-app bot commented Sep 29, 2025

Thanks for making the requested changes!

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

@bedevere-app bedevere-app bot requested a review from ethanfurman September 29, 2025 16:13
@SimonGPrs
Copy link
Author

Thanks for making the requested changes!

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

Wait why are asking to review? I did not make any changes yet!

@StanFromIreland
Copy link
Member

It seems like a bug in the bot, not your fault.

@SimonGPrs
Copy link
Author

It seems like a bug in the bot, not your fault.

OK I had not understood that he was a bot...I realized I am not good enough anyway. I will give this one last try and then give up. Hopefully I am not blacklisted. I guess I am stupid. I thought I could be strong enough to fix this. Anyway...I guess it was extreme hubris.

@ethanfurman
Copy link
Member

@SimonGPrs: Don't give up! Most PRs need some extra work. As long as you're learning, keep on trying. :-)

@SimonGPrs
Copy link
Author

@SimonGPrs: Don't give up! Most PRs need some extra work. As long as you're learning, keep on trying. :-)

Thank you for your incredible patience, I thought I would generate an huge amount of frustration on your side! Thanks you! I will do my best to improve.

@picnixz picnixz changed the title gh-139398: Make dir(Enum) include public _sunder_ helpers for REPL completions (gh-139398) gh-139398: Make dir(Enum) include public _sunder_ helpers for REPL completions Sep 29, 2025
@picnixz
Copy link
Member

picnixz commented Sep 29, 2025

Wait why are asking to review? I did not make any changes yet!

That's because you quoted the message that contained the sentence that asked for a review :)

@RafaelWO
Copy link
Contributor

Not sure, but it looks like an AI bot/agent created this... at least it looks fishy to me 🧐 GH account also looks fresh.

I am not a bot...

@SimonGPrs I feel ashamed of my accusation and regret it...

You are very welcome here and I am sure you can do it 😊

@SimonGPrs
Copy link
Author

Not sure, but it looks like an AI bot/agent created this... at least it looks fishy to me 🧐 GH account also looks fresh.

I am not a bot...

@SimonGPrs I feel ashamed of my accusation and regret it...

You are very welcome here and I am sure you can do it 😊

Many thanks! I will try to find simpler open source project, I think I have been a bit crazy ambitious... but thank you for the warmth of this community!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

@ethanfurman ethanfurman Awaiting requested review from ethanfurman ethanfurman is a code owner

Assignees
No one assigned
Labels
awaiting changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

REPL does not show completions for some members of the Enum module
5 participants
@SimonGPrs @RafaelWO @StanFromIreland @ethanfurman @picnixz