reprlib documentation references string module

[magcius]

BPO	14824
Nosy	@merwok, @berkerpeksag
Files	reprlib.rst.patch: straightforward patch reprlib.rst.patch: corrected patch per Jasper

^{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/berkerpeksag'
closed_at = <Date 2014-09-18.03:08:22.416>
created_at = <Date 2012-05-16.05:52:23.830>
labels = ['docs']
title = 'reprlib documentation references string module'
updated_at = <Date 2014-09-18.03:08:22.414>
user = 'https://bugs.python.org/magcius'

bugs.python.org fields:

activity = <Date 2014-09-18.03:08:22.414>
actor = 'berker.peksag'
assignee = 'berker.peksag'
closed = True
closed_date = <Date 2014-09-18.03:08:22.416>
closer = 'berker.peksag'
components = ['Documentation']
creation = <Date 2012-05-16.05:52:23.830>
creator = 'magcius'
dependencies = []
files = ['25607', '27009']
hgrepos = []
issue_num = 14824
keywords = ['patch']
message_count = 7.0
messages = ['160805', '160810', '160867', '161083', '169181', '227025', '227026']
nosy_count = 6.0
nosy_names = ['eric.araujo', 'cvrebert', 'magcius', 'docs@python', 'python-dev', 'berker.peksag']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue14824'
versions = ['Python 3.4', 'Python 3.5']

[magcius]

http://docs.python.org/dev/library/reprlib.html

"""
Formatting methods for specific types are implemented as methods with a name based on the type name. In the method name, TYPE is replaced by string.join(string.split(type(obj).__name__, '_')). Dispatch to these methods is handled by repr1(). Type-specific methods which need to recursively format a value should call self.repr1(subobj, level - 1).
"""

Outstanding.

[cvrebert]

Patch. Though I ponder whether the expression in question might be equivalent to simply:
type(obj).__name__.replace('_', ' ')

[magcius]

Yes. Yes it would. In my opinion, it really shouldn't do this sort of name mangling, as it's a terrible idea, but whatever.

[magcius]

The documentation is just flat out wrong, actually:

    if ' ' in typename:
        parts = typename.split()
        typename = '_'.join(parts)

The documentation is claiming the inverse.

I don't know why we would ever have a space in a typename, ever (and if someone does awful hacks to get to that state, he should probably also do awful hacks to make reprlib work properly). It would be for the best if we could just remove this brain damage, but whatever.

[cvrebert]

Updated patch. I concur that anyone creating a type whose name has whitespace in it is just asking for trouble.

[python-dev]

New changeset e9968782c9ba by Berker Peksag in branch '3.4':
Issue bpo-14824: Update Repr.repr_TYPE documentation to use correct name mangling implementation.
https://hg.python.org/cpython/rev/e9968782c9ba

New changeset a0372781eafb by Berker Peksag in branch 'default':
Issue bpo-14824: Update Repr.repr_TYPE documentation to use correct name mangling implementation.
https://hg.python.org/cpython/rev/a0372781eafb

[berkerpeksag]

I don't know why we would ever have a space in a typename, ever (and if someone does awful hacks to get to that state, he should probably also do awful hacks to make reprlib work properly).

That part of the code has been added 22 years ago: https://hg.python.org/cpython/rev/a0d4c5ef1d5d#l9.22 So probably the reason is that the code is just old.

Thanks for the patch, Chris!