Skip to content

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

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

Merged
ethanfurman merged 13 commits into from
Dec 2, 2021
Merged

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

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0ed36bc
bpo-45535: Improve output of Enum ``dir()``
AlexWaygood Oct 29, 2021
bb4c147
Simplify Enum.__dir__ slightly
AlexWaygood Oct 29, 2021
526d88b
Simplify diff from upstream a little
AlexWaygood Oct 29, 2021
bd30c46
Update enum.py
AlexWaygood Oct 29, 2021
782f3c7
Further simplify diff
AlexWaygood Oct 29, 2021
24e8968
Merge branch 'Enum-dir-improvements' of https://github.com/AlexWaygoo…
AlexWaygood Oct 29, 2021
6dc0ec0
Lookup via __dict__ for non-EnumType classes
AlexWaygood Oct 30, 2021
f5f80ad
Small tweaks
AlexWaygood Oct 30, 2021
6d182a0
More tweaks
AlexWaygood Oct 30, 2021
6b22112
Improve tests w.r.t. classmethods
AlexWaygood Oct 31, 2021
baa8477
More test tweaks
AlexWaygood Oct 31, 2021
f307b22
Another small tweak
AlexWaygood Nov 2, 2021
ce02230
Only use a single sentinel
AlexWaygood Dec 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
More tweaks
  • Loading branch information
@AlexWaygood
AlexWaygood committed Oct 30, 2021
commit 6d182a09fa6c3e3fbbdc1930b9684d0c3d6af024
15 changes: 10 additions & 5 deletions Lib/enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,8 @@ def __dir__(self):
this_module = globals().values()
is_from_this_module = lambda cls: any(cls is thing for thing in this_module)
first_enum_base = next(cls for cls in mro if is_from_this_module(cls))
ignored = set()
# special-case __new__
ignored = {'__new__'}
add_to_ignored = ignored.add

# We want these added to __dir__
Expand All @@ -661,21 +662,25 @@ def __dir__(self):
cls_lookup = cls.__dict__

# If not an instance of EnumType,
# ensure all attributes excluded from that class's `dir()` are ignored.
# ensure all attributes excluded from that class's `dir()` are ignored here.
if not isinstance(cls, EnumType):
cls_lookup = set(cls_lookup).intersection(dir(cls))

for attr_name in cls_lookup:
# Already seen it? Carry on
if attr_name in cls_dir or attr_name in ignored:
continue
# Exclude all sunders from dir(); __new__ is special-cased
elif attr_name == '__new__' or _is_sunder(attr_name):
continue
# Exclude all sunders from dir()
elif _is_sunder(attr_name):
add_to_ignored(attr_name)
# Not an "enum dunder"? Add it to dir() output.
elif attr_name not in enum_dunders:
add_to_dir(attr_name)
# Is an "enum dunder", and is defined by a class from enum.py? Ignore it.
elif getattr(self, attr_name) is getattr(first_enum_base, attr_name, object()):
add_to_ignored(attr_name)
# Is an "enum dunder", and is either user-defined or defined by a mixin class?
# Add it to dir() output.
else:
add_to_dir(attr_name)

Expand Down