gh-113570: reprlib.repr does not use builtin __repr__ for reshadowed builtins by georgepittock · Pull Request #113577 · python/cpython

georgepittock · 2023-12-30T00:21:30Z

Fixes issue: gh-113570 where objects that reshadow certain builtins would call a specific method and could cause errors, e.g.

import reprlib

class array:
    def __repr__(self):
        return "not array.array!"

reprlib.repr(array())
# previously raised an error, now "not array.array"

This uses a mapping of (module, object name): method to map to the right method, as mentioned in the issue.

…thod on shadowed Python built-in types.

ghost · 2023-12-30T00:21:33Z

All commit authors signed the Contributor License Agreement.

bedevere-app · 2023-12-30T00:21:35Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

sobolevn

Please, also take a look at this doctest failure:

 Document: library/reprlib
-------------------------
**********************************************************************
File "library/reprlib.rst", line 481, in default
Failed example:
    import reprlib
    import sys

    class MyRepr(reprlib.Repr):

        def repr_TextIOWrapper(self, obj, level):
            if obj.name in {'<stdin>', '<stdout>', '<stderr>'}:
                return obj.name
            return repr(obj)

    aRepr = MyRepr()
    print(aRepr.repr(sys.stdin))         # prints '<stdin>'
Expected:
    <stdin>
Got:
    <_io.TextIOWr...oding='utf-8'>
1 items passed all tests:
   8 tests in indent
**********************************************************************
1 items had failures:
   1 of   7 in default
15 tests in 2 items.
14 passed and 1 failed.
***Test Failed*** 1 failures.

Lib/reprlib.py

georgepittock · 2023-12-30T17:34:45Z

To handle the failing doctest some more edge cases need to be handled so cases where someone has defined a custom method still work.

To keep something somewhat similar to what we had there a (4) cases. I am saying there is a predefined method for an object of type a if the class has a method repr_x.

No predefined method
There is a predefined method that is not in our lookup (user defined in a subclass)
There is a predefined method, that is in our lookup and has the same module and type as what we expect
There is a predefined method, that is in our lookup and has a different module and type as what we expect (reprlib (used by pytest) infers builtin types based on class __name__ #113570)

In cases 1 and 4 we will return self.repr_instance(x, level), but in 2 and 3 getattr(self, predefined_method_name)(x, level)

I have added an explicit unit test for case 2 in my latest commit, cases 1, 3 and 4 are already there.

…sue-pythongh-113570

georgepittock · 2024-01-28T08:48:42Z

@sobolevn are you able to look at the updated changes from your comments?

sobolevn

Generally, looks ok to me, but there are several nitpicks :)

Lib/reprlib.py

georgepittock · 2024-01-28T22:09:18Z

Fixed those two comments @sobolevn

sobolevn

This is the last comment, thank you! :)

Lib/test/test_reprlib.py

…ng builtin "list" calls its own __repr__

georgepittock · 2024-01-29T07:14:24Z

That's sorted @sobolevn !

georgepittock · 2024-07-23T22:02:00Z

Is this all good now @sobolevn ?

serhiy-storchaka

Please remove unrelated style changes.

Lib/reprlib.py

…r review

serhiy-storchaka

Thank you for your update, @georgepittock. One minor nitpick. The rest LGTM.

Lib/reprlib.py

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

georgepittock · 2024-10-17T16:08:21Z

CI failure looks unrelated, merging main into branch so trigger CI again...

miss-islington-app · 2024-10-17T16:34:40Z

Thanks @georgepittock for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…dowed builtins (pythonGH-113577) (cherry picked from commit 04d6dd2) Co-authored-by: George Pittock <66332098+georgepittock@users.noreply.github.com>

bedevere-app · 2024-10-17T16:34:57Z

GH-125654 is a backport of this pull request to the 3.13 branch.

bedevere-app · 2024-10-17T16:35:01Z

GH-125655 is a backport of this pull request to the 3.12 branch.

…adowed builtins (GH-113577) (GH-125655) (cherry picked from commit 04d6dd2) Co-authored-by: George Pittock <66332098+georgepittock@users.noreply.github.com>

…adowed builtins (GH-113577) (GH-125654) (cherry picked from commit 04d6dd2) Co-authored-by: George Pittock <66332098+georgepittock@users.noreply.github.com>

…dowed builtins (pythonGH-113577)

Fixed a bug in reprlib.repr where it incorrectly called the repr me…

dce1f02

…thod on shadowed Python built-in types.

bedevere-app bot added the awaiting review label Dec 30, 2023

bedevere-app bot mentioned this pull request Dec 30, 2023

reprlib (used by pytest) infers builtin types based on class __name__ #113570

Closed

blurb-it bot and others added 2 commits December 30, 2023 00:21

📜🤖 Added by blurb_it.

5a4691b

use double backticks in news entry

04ed3cd

sobolevn reviewed Dec 30, 2023

View reviewed changes

Lib/reprlib.py Outdated Show resolved Hide resolved

Lib/reprlib.py Outdated Show resolved Hide resolved

fix so that subclasses that define repr_{type} methods still work

7a69467

fix variable name

c7ae05b

georgepittock changed the title ~~gh-113570: reprlib.repr does not use builtin repr for reshadowed builtins~~ gh-113570: reprlib.repr does not use builtin __repr__ for reshadowed builtins Jan 2, 2024

georgepittock and others added 3 commits January 3, 2024 17:46

add back handling of type(x).__name__ containing spaces

8badac9

Merge branch 'python:main' into fix-issue-pythongh-113570

0d7a3aa

Merge remote-tracking branch 'origin/fix-issue-gh-113570' into fix-is…

a8877f5

…sue-pythongh-113570

sobolevn reviewed Jan 28, 2024

View reviewed changes

Lib/reprlib.py Outdated Show resolved Hide resolved

Lib/reprlib.py Outdated Show resolved Hide resolved

refactor multiple hasattr, getattr calls into one

660030e

sobolevn reviewed Jan 29, 2024

View reviewed changes

Lib/test/test_reprlib.py Show resolved Hide resolved

add a test case for that reprlib.repr on a user defined class shadowi…

5b718e3

…ng builtin "list" calls its own __repr__

Merge branch 'main' into fix-issue-pythongh-113570

c800488

sobolevn requested a review from serhiy-storchaka July 24, 2024 07:59

Merge branch 'main' into fix-issue-pythongh-113570

5df4a7b

serhiy-storchaka reviewed Oct 17, 2024

View reviewed changes

Address review comments to remove unrelated style changes

24ac638

serhiy-storchaka reviewed Oct 17, 2024

View reviewed changes

Lib/reprlib.py Outdated Show resolved Hide resolved

Lib/reprlib.py Outdated Show resolved Hide resolved

Lib/reprlib.py Outdated Show resolved Hide resolved

remove redundancy of lookup dictionary plus a few style changes as pe…

59af49a

…r review

remove trailing whitespace

0bcf8db

serhiy-storchaka approved these changes Oct 17, 2024

View reviewed changes

Lib/reprlib.py Outdated Show resolved Hide resolved

bedevere-app bot added awaiting merge and removed awaiting review labels Oct 17, 2024

Change .get to __getitem__ as we already know typename is in the dict

70ba74c

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

serhiy-storchaka enabled auto-merge (squash) October 17, 2024 15:51

serhiy-storchaka added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Oct 17, 2024

Merge branch 'main' into fix-issue-pythongh-113570

c25a0d9

serhiy-storchaka merged commit 04d6dd2 into python:main Oct 17, 2024

bedevere-app bot removed the awaiting merge label Oct 17, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 17, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 17, 2024

georgepittock deleted the fix-issue-gh-113570 branch October 17, 2024 16:38

ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025

pythongh-113570: reprlib.repr does not use builtin __repr__ for resha…

01b624f

…dowed builtins (pythonGH-113577)

Uh oh!

Conversation

georgepittock commented Dec 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Dec 30, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-app bot commented Dec 30, 2023

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

georgepittock commented Dec 30, 2023

Uh oh!

georgepittock commented Jan 28, 2024

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

georgepittock commented Jan 28, 2024

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

georgepittock commented Jan 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

georgepittock commented Jul 23, 2024

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

georgepittock commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

miss-islington-app bot commented Oct 17, 2024

Uh oh!

bedevere-app bot commented Oct 17, 2024

Uh oh!

bedevere-app bot commented Oct 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

georgepittock commented Dec 30, 2023 •

edited

Loading

ghost commented Dec 30, 2023 •

edited by ghost

Loading

georgepittock commented Jan 29, 2024 •

edited

Loading

georgepittock commented Oct 17, 2024 •

edited

Loading