Skip to content
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

Jump to bottom

bpo-33256: Replace square brackets around python object repr to display it in html #6442

Merged
merged 6 commits into from
Apr 29, 2018
Merged

bpo-33256: Replace square brackets around python object repr to display it in html #6442

merged 6 commits into from
Apr 29, 2018

Conversation

sblondon
Copy link
Contributor

@sblondon sblondon commented Apr 10, 2018 •
edited by bedevere-bot
Loading

This PR replace '<' and '>' in func so an representation of an object will be displayed. It will not change the display of functions.

https://bugs.python.org/issue33256

vadmium
vadmium reviewed Apr 11, 2018
View reviewed changes
Lib/cgitb.py Outdated
@@ -124,7 +124,7 @@ def html(einfo, context=5):
args, varargs, varkw, locals = inspect.getargvalues(frame)
call = ''
if func != '?':
call = 'in ' + strong(func) + \
call = 'in ' + strong(func.replace("<", "&lt;").replace(">", "&gt;")) + \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could call pydoc.html.escape like the rest of the code. Maybe it doesn’t matter too much here, but in general it is important to escape ampersands.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vadmium Thank you for the review. :) It's fixed now.

serhiy-storchaka
serhiy-storchaka approved these changes Apr 19, 2018
View reviewed changes
Lib/cgitb.py
@@ -124,7 +124,7 @@ def html(einfo, context=5):
args, varargs, varkw, locals = inspect.getargvalues(frame)
call = ''
if func != '?':
call = 'in ' + strong(func) + \
call = 'in ' + strong(pydoc.html.escape(func)) + \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use pydoc.html.escape() also in line 285.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 285 is not modified by the patch but I agree it's good to reuse pydoc.html.escape() there.
I committed the requested change.

Misc/NEWS.d/next/Library/2018-04-10-20-57-14.bpo-33256.ndHkqu.rst Outdated
@@ -0,0 +1 @@
Fix display of ``<module>`` call in the html produced by ``cgitb.html()``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add "Patch by your name." And add your name in Misc/ACKS if it was not added before.

@serhiy-storchaka serhiy-storchaka added type-bug An unexpected behavior, bug, or error needs backport to 3.6 labels Apr 19, 2018
@serhiy-storchaka serhiy-storchaka merged commit 7d68bfa into python:master Apr 29, 2018
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-6637 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 29, 2018
@sblondon @miss-islington
bpo-33256: Replace angle brackets around python object repr to displa…
e0aed42 
…y it in html (pythonGH-6442)

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
@miss-islington
Copy link
Contributor

Sorry, @sblondon and @serhiy-storchaka, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 7d68bfa82654ba01d860b8a772ff63bf0bd183ee 2.7

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 29, 2018
@sblondon @miss-islington
bpo-33256: Replace angle brackets around python object repr to displa…
183eafc 
…y it in html (pythonGH-6442)

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
@bedevere-bot
Copy link

GH-6638 is a backport of this pull request to the 3.6 branch.

miss-islington added a commit that referenced this pull request Apr 29, 2018
@miss-islington @sblondon
bpo-33256: Replace angle brackets around python object repr to displa…
736f17f 
…y it in html (GH-6442)

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Apr 29, 2018
@miss-islington @sblondon
bpo-33256: Replace angle brackets around python object repr to displa…
ef91552 
…y it in html (GH-6442)

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Apr 30, 2018
@sblondon @serhiy-storchaka
[2.7] bpo-33256: Replace angle brackets around python object repr to …
bd887b8 
…display it in html (pythonGH-6442).

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
@bedevere-bot
Copy link

GH-6650 is a backport of this pull request to the 2.7 branch.

serhiy-storchaka added a commit that referenced this pull request Apr 30, 2018
@serhiy-storchaka @sblondon
[2.7] bpo-33256: Replace angle brackets around python object repr to …
07ad02f 
…display it in html (GH-6442). (GH-6650)

(cherry picked from commit 7d68bfa)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
@sblondon sblondon deleted the remove-angle-brackets-to-display-module branch April 30, 2021 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vadmium vadmium vadmium left review comments

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees
No one assigned
Labels
type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@sblondon @miss-islington @bedevere-bot @vadmium @serhiy-storchaka @the-knights-who-say-ni