dir() should only return strings

[smontanaro]

BPO	1056293
Nosy	@loewis, @smontanaro, @vstinner, @devdanzin
Files	dir_type.patch

^{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 = None
closed_at = <Date 2009-03-20.00:47:56.267>
created_at = <Date 2004-10-28.18:08:16.000>
labels = ['interpreter-core', 'type-bug']
title = 'dir() should only return strings'
updated_at = <Date 2009-03-20.00:47:56.244>
user = 'https://github.com/smontanaro'

bugs.python.org fields:

activity = <Date 2009-03-20.00:47:56.244>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2009-03-20.00:47:56.267>
closer = 'vstinner'
components = ['Interpreter Core']
creation = <Date 2004-10-28.18:08:16.000>
creator = 'skip.montanaro'
dependencies = []
files = ['13109']
hgrepos = []
issue_num = 1056293
keywords = ['patch']
message_count = 5.0
messages = ['60592', '60593', '81448', '82255', '83837']
nosy_count = 4.0
nosy_names = ['loewis', 'skip.montanaro', 'vstinner', 'ajaksu2']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue1056293'
versions = ['Python 2.7']

[smontanaro]

Calling this a bug in Python is probably a misnomer.
Think of it as more of a "request for workaround".
Recent versions of SWIG create wrapper classes that
contain a Python class as a key in their __dict__'s.
Consequently, something like

[k for k in dir(obj) if k.startswith("set_")]

because there is an element in dir(obj) that's not a
string or a unicode object.

I realize dir() is mostly a debugging aid, unlikely to be
used frequently in production code, but I'd like see the
docs updated so that it's guaranteed to only return
strings or unicode objects and I'd like its implementation
changed to enforce that (and maybe even warn if
something else is found).

If this is seen as an acceptable change I will work up a
patch.

[loewis]

Logged In: YES
user_id=21627

It seems that the documentation guarantees that it returns
"names" ("the list contains the object's attributes' names,
..."). Most people certainly expect names to be strings
(although they might be Unicode objects at some point in the
future :-).

So I think it is ok to fix dir in this respect.

[devdanzin]

Still present in trunk:69418:

class obj: pass

obj.__dict__[1] = 0
[k for k in dir(obj) if k.startswith("set_")]

[vstinner]

Yes, the issue still exists in 2009. Attached patch contains a test +
a patch to test the type of each value of the dir() result.

I'm not sure that it's a good idea to apply my patch. It's maybe not
the job of Python to check the types of dir() result.

[vstinner]

It's a feature request and it looks like except of Skip Montanaro in
2004, nobody requires this feature. I don't like my patch because it
slows down Python just for a very rare case (this issue).

I choose to close it. Reopen this issue if you think that this feature
(check type of dir() result) is a must have ;-)