bpo-45535: Improve output of Enum `dir()` #29316

AlexWaygood · 2021-10-29T15:35:53Z

This PR modifies the EnumType.__dir__() and Enum.__dir__() to ensure
that user-defined methods and methods inherited from mixin classes always
show up in the output of help(). This change also makes it easier for
IDEs to provide auto-completion.

Apologies for the big diff on the tests.

https://bugs.python.org/issue45535

This PR modifies the ``EnumType.__dir__()`` and ``Enum.__dir__()`` to ensure that user-defined methods and methods inherited from mixin classes always show up in the output of `help()`. This change also makes it easier for IDEs to provide auto-completion. Apologies for the big diff on the tests.

…d/cpython into Enum-dir-improvements

ethanfurman · 2021-10-30T22:06:38Z

Doc/howto/enum.rst


    >>> dir(Planet)
-    ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
+    ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__init__', '__members__', '__module__', 'surface_gravity']


Does __init__ need to be here? It will never be called after the enum class is created.

surface_gravity is here so completion works?

I think having __init__ show up on dir(Planet) improves the output of help(Planet.EARTH). Without __init__ being present on dir(Planet), there is no reference in the output from help(Planet.EARTH) to the fact that the member has two named attributes, mass and radius. With __init__ being present on dir(Planet), however, the signature of the __init__ function shows up in the output of help(Planet.EARTH), so we can clearly see that the member has two named attributes, mass and radius.

ethanfurman · 2021-10-30T22:14:39Z

Lib/test/test_enum.py

+        self.assertNotIn('__format__', int_enum_dir)
+        self.assertNotIn('__hash__', int_enum_dir)
+
+        class OverridesFormatOutsideEnumModule(Enum):


Do we lose IDE or completion help by not listing __format__ in dir()?

No, we don't, and I agree that __format__ should be excluded from the dir() of Enum, IntEnum and StrEnum, as well as any classes that inherit from these enum classes without overriding __format__. This is still the case in my PR.

But if a user is defining a custom __format__ method in their own Enum class, I think it would be surprising for the user if __format__ did not show up in dir() or help(). Their implementation of __format__ could have some unusual or surprising behaviour, which they might explain in detail in the docstring; but the docstring is of limited use if it doesn't show up in the output of help().

github-actions · 2021-12-02T00:06:02Z

This PR is stale because it has been open for 30 days with no activity.

ethanfurman · 2021-12-02T00:16:50Z

I haven't forgotten. :-)

ethanfurman · 2021-12-02T16:39:17Z

Alex, I'd like to accept and merge this PR and give you credit since the only reason __dir__ is being expanded is because you pushed for it. However, you may not see much of the actual code in the new enum.py file as I'm redoing a lot of the internals and test structure.

The other option is to close the PR, and simply add your name to the whatsnew in the improved __dir__ section.

I think the first option is better for your Github stats. :-)

Which option would you like to take?

AlexWaygood · 2021-12-02T16:45:23Z

Alex, I'd like to accept and merge this PR and give you credit since the only reason __dir__ is being expanded is because you pushed for it. However, you may not see much of the actual code in the new enum.py file as I'm redoing a lot of the internals and test structure.

The other option is to close the PR, and simply add your name to the whatsnew in the improved __dir__ section.

I think the first option is better for your Github stats. :-)

Which option would you like to take?

Thank you, this is such a lovely message to get! It may seem silly, but could we possibly go for Option 1? I'm not currently employed in the tech sector (and am self-taught), but it's something I'd be very interested in potentially exploring in the future, so something like this would help boost my portfolio a little :)

ethanfurman · 2021-12-02T16:48:35Z

Happy to. I mostly didn't want you to be disappointed in the future when you check the code base and the details don't match what is getting committed now.

AlexWaygood · 2021-12-02T16:50:03Z

Happy to. I mostly didn't want you to be disappointed in the future when you check the code base and the details don't match what is getting committed now.

Of course, I completely understand -- thanks for the heads-up!

bedevere-bot · 2021-12-02T17:14:56Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot ARM64 Windows Non-Debug 3.x has failed when building commit b2afdc9.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/730/builds/361) and take a look at the build logs.
Check if the failure is related to this commit (b2afdc9) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/730/builds/361

Summary of the results of the build (if available):

Click to see traceback logs

remote: Enumerating objects: 16, done.        
remote: Counting objects:   6% (1/15)        
remote: Counting objects:  13% (2/15)        
remote: Counting objects:  20% (3/15)        
remote: Counting objects:  26% (4/15)        
remote: Counting objects:  33% (5/15)        
remote: Counting objects:  40% (6/15)        
remote: Counting objects:  46% (7/15)        
remote: Counting objects:  53% (8/15)        
remote: Counting objects:  60% (9/15)        
remote: Counting objects:  66% (10/15)        
remote: Counting objects:  73% (11/15)        
remote: Counting objects:  80% (12/15)        
remote: Counting objects:  86% (13/15)        
remote: Counting objects:  93% (14/15)        
remote: Counting objects: 100% (15/15)        
remote: Counting objects: 100% (15/15), done.        
remote: Compressing objects:   9% (1/11)        
remote: Compressing objects:  18% (2/11)        
remote: Compressing objects:  27% (3/11)        
remote: Compressing objects:  36% (4/11)        
remote: Compressing objects:  45% (5/11)        
remote: Compressing objects:  54% (6/11)        
remote: Compressing objects:  63% (7/11)        
remote: Compressing objects:  72% (8/11)        
remote: Compressing objects:  81% (9/11)        
remote: Compressing objects:  90% (10/11)        
remote: Compressing objects: 100% (11/11)        
remote: Compressing objects: 100% (11/11), done.        
remote: Total 16 (delta 4), reused 4 (delta 4), pack-reused 1        
From https://github.com/python/cpython
 * branch                  main       -> FETCH_HEAD
Note: switching to 'b2afdc95cc8f4e9228148730949a43cef0323f15'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at b2afdc95cc [bpo-45535](https://bugs.python.org/issue45535): Improve output of Enum ``dir()`` (GH-29316)
Switched to and reset branch 'main'

Could Not Find C:\Workspace\buildarea\3.x.linaro-win-arm64.nondebug\build\Lib\*.pyc
The system cannot find the file specified.
Could Not Find C:\Workspace\buildarea\3.x.linaro-win-arm64.nondebug\build\PCbuild\python*.zip

Could Not Find C:\Workspace\buildarea\3.x.linaro-win-arm64.nondebug\build\Lib\*.pyc
The system cannot find the file specified.
Could Not Find C:\Workspace\buildarea\3.x.linaro-win-arm64.nondebug\build\PCbuild\python*.zip

ethanfurman · 2021-12-02T17:47:14Z

I believe this is a false positive.

AlexWaygood requested a review from ethanfurman as a code owner October 29, 2021 15:35

the-knights-who-say-ni added the CLA signed label Oct 29, 2021

bedevere-bot added the awaiting review label Oct 29, 2021

AlexWaygood added 8 commits October 29, 2021 19:27

Simplify Enum.__dir__ slightly

bb4c147

Simplify diff from upstream a little

526d88b

Update enum.py

bd30c46

Further simplify diff

782f3c7

Merge branch 'Enum-dir-improvements' of https://github.com/AlexWaygoo…

24e8968

…d/cpython into Enum-dir-improvements

Lookup via __dict__ for non-EnumType classes

6dc0ec0

Small tweaks

f5f80ad

More tweaks

6d182a0

ethanfurman reviewed Oct 30, 2021

View reviewed changes

AlexWaygood added 3 commits October 31, 2021 17:55

Improve tests w.r.t. classmethods

6b22112

More test tweaks

baa8477

Another small tweak

f307b22

github-actions bot added the stale Stale PR or inactive for long period of time. label Dec 2, 2021

Only use a single sentinel

ce02230

ethanfurman merged commit b2afdc9 into python:main Dec 2, 2021

bedevere-bot removed the awaiting review label Dec 2, 2021

AlexWaygood deleted the Enum-dir-improvements branch December 2, 2021 16:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-45535: Improve output of Enum `dir()` #29316

bpo-45535: Improve output of Enum `dir()` #29316

AlexWaygood commented Oct 29, 2021 •

edited by bedevere-bot

Loading

ethanfurman Oct 30, 2021

ethanfurman Oct 30, 2021

AlexWaygood Oct 30, 2021

ethanfurman Oct 30, 2021

AlexWaygood Oct 31, 2021

github-actions bot commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

AlexWaygood commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

AlexWaygood commented Dec 2, 2021 •

edited

Loading

bedevere-bot commented Dec 2, 2021 •

edited

Loading

ethanfurman commented Dec 2, 2021

bpo-45535: Improve output of Enum dir() #29316

bpo-45535: Improve output of Enum dir() #29316

Conversation

AlexWaygood commented Oct 29, 2021 • edited by bedevere-bot Loading

ethanfurman Oct 30, 2021

Choose a reason for hiding this comment

ethanfurman Oct 30, 2021

Choose a reason for hiding this comment

AlexWaygood Oct 30, 2021

Choose a reason for hiding this comment

ethanfurman Oct 30, 2021

Choose a reason for hiding this comment

AlexWaygood Oct 31, 2021

Choose a reason for hiding this comment

github-actions bot commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

AlexWaygood commented Dec 2, 2021

ethanfurman commented Dec 2, 2021

AlexWaygood commented Dec 2, 2021 • edited Loading

bedevere-bot commented Dec 2, 2021 • edited Loading

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

ethanfurman commented Dec 2, 2021

bpo-45535: Improve output of Enum `dir()` #29316

bpo-45535: Improve output of Enum `dir()` #29316

AlexWaygood commented Oct 29, 2021 •

edited by bedevere-bot

Loading

AlexWaygood commented Dec 2, 2021 •

edited

Loading

bedevere-bot commented Dec 2, 2021 •

edited

Loading