bpo-35075: Fix broken url in the pprint documentation #10201

pablogsal · 2018-10-28T21:17:44Z

https://bugs.python.org/issue35075

lysnikolaou · 2018-10-28T21:30:59Z

This doesn't work on my local Python build with a TypeError: decode() argument 1 must be str, not None. Apparently http_info.get_content_charset() returns None.

pablogsal · 2018-10-28T22:00:31Z

@lysnikolaou Yup, the http_info charset may be missing, so let's default to utf-8 if there is no charset in the headers.

Thanks for the catch!

methane · 2018-10-29T06:38:11Z

Doc/library/pprint.rst

@@ -217,9 +217,10 @@ let's fetch information about a project from `PyPI <https://pypi.org>`_::
   >>> import json
   >>> import pprint
   >>> from urllib.request import urlopen
-   >>> with urlopen('http://pypi.org/project/Twisted/json') as url:
+   >>> with urlopen('https://pypi.org/pypi/Twisted/json') as url:


Output of this URL is changed, and it's too large for example. (Output is in below).
I think we should find better json example.

Maybe we can add a new JSON file in https://github.com/python/pythontestdotnet which is used for testing purposes? Is it necessary to make a request to pypi since we can define a minimal custom dict based on the current example to show the output and usage of other parameters like depth and width

By using PyPI, it looks more "pragmatic" rather than "artificial" example.

I found nice example: https://pypi.org/pypi/sampleproject/json
This project is maintained by PyPA.

methane · 2018-10-29T06:40:00Z

Doc/library/pprint.rst

   ...     http_info = url.info()
-   ...     raw_data = url.read().decode(http_info.get_content_charset())
+   ...     charset = http_info.get_content_charset(failobj="utf-8")
+   ...     raw_data = url.read().decode(charset)


This is example of pprint. So this part should be simple as possible:

with urlopen('https://pypi.org/pypi/Twisted/json') as resp: project_info = json.load(resp)

Note that json.load and json.loads now support loading bytes encoded with UTF-8.
So no need to manual decode.

bedevere-bot · 2018-10-29T06:40:09Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

pablogsal · 2018-10-29T16:35:14Z

I have made the requested changes; please review again

bedevere-bot · 2018-10-29T16:35:19Z

Thanks for making the requested changes!

@methane: please review the changes made to this pull request.

Doc/library/pprint.rst

Co-Authored-By: pablogsal <[email protected]>

Doc/library/pprint.rst

methane · 2018-10-31T13:15:13Z

Doc/library/pprint.rst

-   ...     raw_data = url.read().decode(http_info.get_content_charset())
-   >>> project_info = json.loads(raw_data)
+   >>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
+...        project_info = json.load(resp)


Suggested change

... project_info = json.load(resp)

... project_info = json.load(resp)

methane · 2018-10-31T13:38:37Z

Hm, output seems long yet. Please try only 'info' part:

project_info = json.load(resp)['info']

And depth=1, width=60, instead of depth=2 and width=50.

Doc/library/pprint.rst

Co-Authored-By: pablogsal <[email protected]>

miss-islington · 2018-11-01T12:29:41Z

Thanks @pablogsal for the PR 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖

https://bugs.python.org/issue35075 (cherry picked from commit bf46a09) Co-authored-by: Pablo Galindo <[email protected]>

bedevere-bot · 2018-11-01T12:29:49Z

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

https://bugs.python.org/issue35075 (cherry picked from commit bf46a09) Co-authored-by: Pablo Galindo <[email protected]>

bedevere-bot · 2018-11-01T12:29:55Z

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

https://bugs.python.org/issue35075 (cherry picked from commit bf46a09) Co-authored-by: Pablo Galindo <[email protected]>

bpo-35075: Fix broken url in the pprint documentation

00341b9

pablogsal added the skip news label Oct 28, 2018

the-knights-who-say-ni added the CLA signed label Oct 28, 2018

bedevere-bot added docs Documentation in the Doc dir awaiting merge labels Oct 28, 2018

pablogsal requested a review from methane October 28, 2018 21:17

pablogsal self-assigned this Oct 28, 2018

fixup! bpo-35075: Fix broken url in the pprint documentation

f0f9993

methane requested changes Oct 29, 2018

View reviewed changes

bedevere-bot removed the awaiting merge label Oct 29, 2018

bedevere-bot added the awaiting changes label Oct 29, 2018

Use output of https://pypi.org/pypi/sampleproject/json

63563b2

pablogsal force-pushed the bpo35075 branch from fbd462a to 63563b2 Compare October 29, 2018 15:42

bedevere-bot added awaiting change review and removed awaiting changes labels Oct 29, 2018

methane reviewed Oct 30, 2018

View reviewed changes

Doc/library/pprint.rst Outdated Show resolved Hide resolved

Simplify reading to json

5ef90ec

Co-Authored-By: pablogsal <[email protected]>

methane reviewed Oct 30, 2018

View reviewed changes

Doc/library/pprint.rst Outdated Show resolved Hide resolved

methane reviewed Oct 31, 2018

View reviewed changes

pablogsal force-pushed the bpo35075 branch from 3767aec to 5ef90ec Compare October 31, 2018 13:24

fixup! Simplify reading to json

be1499d

Use only 'info' part of the response

bf2c8f4

methane reviewed Nov 1, 2018

View reviewed changes

Doc/library/pprint.rst Outdated Show resolved Hide resolved

Fix indentation

3aea007

Co-Authored-By: pablogsal <[email protected]>

methane approved these changes Nov 1, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Nov 1, 2018

methane added needs backport to 3.6 labels Nov 1, 2018

miss-islington merged commit bf46a09 into python:master Nov 1, 2018

bedevere-bot removed the awaiting merge label Nov 1, 2018

bedevere-bot removed the needs backport to 3.7 label Nov 1, 2018

bedevere-bot removed the needs backport to 3.6 label Nov 1, 2018

miss-islington added a commit that referenced this pull request Nov 1, 2018

bpo-35075: Fix broken url in the pprint documentation (GH-10201)

7344b9f

https://bugs.python.org/issue35075 (cherry picked from commit bf46a09) Co-authored-by: Pablo Galindo <[email protected]>

pablogsal deleted the bpo35075 branch November 1, 2018 13:38

miss-islington added a commit that referenced this pull request Nov 1, 2018

bpo-35075: Fix broken url in the pprint documentation (GH-10201)

7d35553

https://bugs.python.org/issue35075 (cherry picked from commit bf46a09) Co-authored-by: Pablo Galindo <[email protected]>

Wulian233 mentioned this pull request Nov 12, 2024

Outdated pprint.pp doc example about pypi sampleproject version #126731

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-35075: Fix broken url in the pprint documentation #10201

bpo-35075: Fix broken url in the pprint documentation #10201

pablogsal commented Oct 28, 2018 •

edited by bedevere-bot

Loading

lysnikolaou commented Oct 28, 2018

pablogsal commented Oct 28, 2018 •

edited

Loading

methane Oct 29, 2018

tirkarthi Oct 29, 2018

methane Oct 29, 2018

methane Oct 29, 2018

bedevere-bot commented Oct 29, 2018

pablogsal commented Oct 29, 2018

bedevere-bot commented Oct 29, 2018

methane Oct 31, 2018

methane commented Oct 31, 2018

miss-islington commented Nov 1, 2018

bedevere-bot commented Nov 1, 2018

bedevere-bot commented Nov 1, 2018

	... project_info = json.load(resp)
	... project_info = json.load(resp)

bpo-35075: Fix broken url in the pprint documentation #10201

bpo-35075: Fix broken url in the pprint documentation #10201

Conversation

pablogsal commented Oct 28, 2018 • edited by bedevere-bot Loading

lysnikolaou commented Oct 28, 2018

pablogsal commented Oct 28, 2018 • edited Loading

methane Oct 29, 2018

Choose a reason for hiding this comment

tirkarthi Oct 29, 2018

Choose a reason for hiding this comment

methane Oct 29, 2018

Choose a reason for hiding this comment

methane Oct 29, 2018

Choose a reason for hiding this comment

bedevere-bot commented Oct 29, 2018

pablogsal commented Oct 29, 2018

bedevere-bot commented Oct 29, 2018

methane Oct 31, 2018

Choose a reason for hiding this comment

methane commented Oct 31, 2018

miss-islington commented Nov 1, 2018

bedevere-bot commented Nov 1, 2018

bedevere-bot commented Nov 1, 2018

pablogsal commented Oct 28, 2018 •

edited by bedevere-bot

Loading

pablogsal commented Oct 28, 2018 •

edited

Loading