HTTPStatus has incomplete dir() listing

[rhettinger]

BPO	40084
Nosy	@rhettinger, @ethanfurman, @serhiy-storchaka, @miss-islington, @tirkarthi, @lem2clide
PRs	bpo-40084: Enum.__dir__ listing includes entries from instance dict #19219 [3.8] bpo-40084: Enum - dir() includes member attributes (GH-19219) #22338 [3.9] bpo-40084: Enum - dir() includes member attributes (GH-19219) #22339 [3.8] bpo-40084: Enum - dir() includes member attributes (GH-19219) #22853 [3.9] bpo-40084: Enum - dir() includes member attributes (GH-19219) #22854 [3.9] bpo-40084: Enum - dir() includes member attributes (GH-19219) #23746

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/ethanfurman'
closed_at = <Date 2020-12-14.23:59:07.569>
created_at = <Date 2020-03-27.07:16:45.111>
labels = ['easy', 'type-bug', '3.8', '3.9', '3.10', 'library']
title = 'HTTPStatus has incomplete dir() listing'
updated_at = <Date 2020-12-14.23:59:07.569>
user = 'https://github.com/rhettinger'

bugs.python.org fields:

activity = <Date 2020-12-14.23:59:07.569>
actor = 'ethan.furman'
assignee = 'ethan.furman'
closed = True
closed_date = <Date 2020-12-14.23:59:07.569>
closer = 'ethan.furman'
components = ['Library (Lib)']
creation = <Date 2020-03-27.07:16:45.111>
creator = 'rhettinger'
dependencies = []
files = []
hgrepos = []
issue_num = 40084
keywords = ['patch', 'newcomer friendly']
message_count = 5.0
messages = ['365138', '365180', '377254', '382803', '383011']
nosy_count = 6.0
nosy_names = ['rhettinger', 'ethan.furman', 'serhiy.storchaka', 'miss-islington', 'xtreak', 'lem2clide']
pr_nums = ['19219', '22338', '22339', '22853', '22854', '23746']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue40084'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

[rhettinger]

The dir() listing omits the attributes "description" and "phrase":

>>> import http
>>> from pprint import pp
>>> r = http.HTTPStatus(404)
>>> pp(vars(r))
{'_value_': 404,
 'phrase': 'Not Found',
 'description': 'Nothing matches the given URI',
 '_name_': 'NOT_FOUND',
 '__objclass__': <enum 'HTTPStatus'>}
>>> r.value
404
>>> r.name
'NOT_FOUND'
>>> r.description
'Nothing matches the given URI'
>>> r.phrase
'Not Found'
>>> dir(r)
['__class__', '__doc__', '__module__', 'as_integer_ratio', 'bit_length', 'conjugate', 'denominator', 'from_bytes', 'imag', 'name', 'numerator', 'real', 'to_bytes', 'value']

One fix would be to teach IntEnum.__dir__() to include entries in the instance dict. Another fix would be to provide a way for a IntEnum subclass to add to the known members list.

[ethanfurman]

Adding to the existing dir() is as easy as writing one's own __dir__.

I think using the instance dict and omitting any keys with a leading underscore will do the right thing most of the time.

The fix should into Enum and not just IntEnum as other enumerations could also have extra attributes.

[ethanfurman]

New changeset 68526fe by Angelin BOOZ in branch 'master':
bpo-40084: Enum - dir() includes member attributes (GH-19219)
68526fe

[ethanfurman]

New changeset f6d1520 by Miss Islington (bot) in branch '3.8':
bpo-40084: [Enum] dir() includes member attributes (GH-19219) (GH-22853)
f6d1520

[miss-islington]

New changeset 33cbb04 by Miss Islington (bot) in branch '3.9':
bpo-40084: Enum - dir() includes member attributes (GH-19219)
33cbb04