gh-122873: Allow "python3 -m json" to work by treyhunner · Pull Request #122884 · python/cpython

treyhunner · 2024-08-10T18:43:50Z

Allow python3 -m json to work in addition to python3 -m json.tool and update documentation to use python3 -m json instead of python3 -m json.tool.

Issue: #122873

Issue: Allow "-m json" instead of "-m json.tool" #122873

📚 Documentation preview 📚: https://cpython-previews--122884.org.readthedocs.build/

Doc/library/json.rst

Lib/json/__main__.py

treyhunner · 2024-08-10T21:37:34Z

Thank you @AA-Turner for reviewing. Let me know if you'd like any variation of the suggestions I commented on made.

I just used blurb to add a NEWS.d entry as well.
I wrote the same copy as in "What's New".
I'm fuzzy on the use of "What's New" and NEWS.d, so please correct me if either should be updated or removed.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner · 2024-08-10T21:44:50Z

I just used blurb to add a NEWS.d entry as well.
I wrote the same copy as in "What's New".
I'm fuzzy on the use of "What's New" and NEWS.d, so please correct me if either should be updated or removed.

NEWS.d goes into the full changelog, whatsnes is for bigger or user visible changes. Using the same text for both is fine, you've done the right thing here.

A

hugovk · 2024-08-10T21:49:47Z

I'm fuzzy on the use of "What's New" and NEWS.d, so please correct me if either should be updated or removed.

We do want both.

"What's New" is the main set release notes. This'll be the main document people read about the release (~30k views/month):

https://docs.python.org/3.14/whatsnew/3.14.html#json

NEWS.d files eventually becomes part of the giant changelog, not read so often (~4k views/month), but can be useful to filter via the search box:

https://docs.python.org/3.14/whatsnew/changelog.html

hugovk

Let's also change ./Doc/library/cmdline.rst:

-* :ref:`json.tool <json-commandline>`
+* :ref:`json <json-commandline>`

https://cpython-previews--122884.org.readthedocs.build/en/122884/library/cmdline.html

For the What's New and NEWS.d, shall we also mention python -m json explicitly, and include a link to the json-commandline reference?

And there's some json.tool -> json we can update in the Lib/json/__init__.py docstring.

Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst

Doc/whatsnew/3.14.rst

Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst

ncoghlan

PR mostly looks good to me, just some comments inline around keeping a minimal level of json.tool documentation (since the submodule still exists and isn't going anywhere).

Doc/library/json.rst

Doc/whatsnew/3.14.rst

Lib/json/tool.py

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>

hugovk · 2024-08-13T14:42:26Z

I think this is almost ready!

Please also change Doc/library/cmdline.rst:

-* :ref:`json.tool <json-commandline>`
+* :ref:`json <json-commandline>`

https://cpython-previews--122884.org.readthedocs.build/en/122884/library/cmdline.html

treyhunner · 2024-08-13T15:01:40Z

I think this is almost ready!

Please also change Doc/library/cmdline.rst:
-* :ref:`json.tool <json-commandline>`
+* :ref:`json <json-commandline>`
https://cpython-previews--122884.org.readthedocs.build/en/122884/library/cmdline.html

Just updated.

I had no idea this page existed. I wish I had known about it when writing my post on Python's CLIs! 😆

hugovk

Thank you!

AA-Turner · 2024-08-13T16:09:45Z

Thanks @treyhunner!

A

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>

bedevere-app bot mentioned this pull request Aug 10, 2024

Allow "-m json" instead of "-m json.tool" #122873

Closed

bedevere-app bot added the awaiting review label Aug 10, 2024

treyhunner added 10 commits August 10, 2024 12:24

Rename json.tool to json.__main__

27e449d

Make json.tool delegate to json.__main__

423c971

Note json.tool deprecation

1c1a8fa

Move main function from json.__main__ to json.tool

f8f6931

Remove deprecation warning

834fbd7

Fix module name as shown at command-line

62afcf1

Update docs and what's new for json.tool to json

f58e60a

Remove duplicate json module description from docs

168082a

Give up on marking -m as an option

52039ee

Remove unnecessary newline in changed note

2e37475

treyhunner force-pushed the json-script2 branch from 4a8fdb0 to 2e37475 Compare August 10, 2024 19:36

Remove now-invalid json.tool module reference

efd0503

AA-Turner reviewed Aug 10, 2024

View reviewed changes

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

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

Lib/json/__main__.py Outdated Show resolved Hide resolved

Lib/json/__main__.py Outdated Show resolved Hide resolved

Add news entry with blurb

c6bb211

treyhunner and others added 3 commits August 10, 2024 14:38

Remove older raw string usage in docstring

e768e39

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Use sentence case in section title

a6b5c0d

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Add CLI invocation for easier copy-pasting

3105bc2

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

hugovk reviewed Aug 10, 2024

View reviewed changes

Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst Outdated Show resolved Hide resolved

treyhunner added 3 commits August 10, 2024 15:58

Update json.__init__ docstring for python -m json

238fc57

Note python -m json in What's New

7f704bf

Use SystemExit consistently in json package

fba68ac

AA-Turner reviewed Aug 11, 2024

View reviewed changes

Doc/whatsnew/3.14.rst Outdated Show resolved Hide resolved

Misc/NEWS.d/next/Library/2024-08-10-14-16-59.gh-issue-122873.XlHaUn.rst Outdated Show resolved Hide resolved

Improve grammar in news

8662c81

ncoghlan reviewed Aug 12, 2024

View reviewed changes

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

Doc/library/json.rst Show resolved Hide resolved

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

Doc/whatsnew/3.14.rst Outdated Show resolved Hide resolved

Lib/json/tool.py Show resolved Hide resolved

Add json.tool submodule documentation reference back in.

52129e6

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

treyhunner and others added 3 commits August 12, 2024 07:01

Note that json.tool still works for compatibility reasons

016206d

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>

Note that json.tool implements the CLI

9b22285

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>

Reference json.__main__ in json.tool docstring

9fd0c1c

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>

Switch json.tool to json on listing of Python CLIs

734fbf9

hugovk approved these changes Aug 13, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Aug 13, 2024

AA-Turner approved these changes Aug 13, 2024

View reviewed changes

AA-Turner merged commit 906b796 into python:main Aug 13, 2024

bedevere-app bot removed the awaiting merge label Aug 13, 2024

treyhunner deleted the json-script2 branch August 13, 2024 16:10

Uh oh!

Comments

Conversation

treyhunner commented Aug 10, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

treyhunner commented Aug 10, 2024

Uh oh!

AA-Turner commented Aug 10, 2024

Uh oh!

hugovk commented Aug 10, 2024

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ncoghlan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

treyhunner commented Aug 13, 2024

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

AA-Turner commented Aug 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

treyhunner commented Aug 10, 2024 •

edited by github-actions bot

Loading

ncoghlan left a comment •

edited

Loading

hugovk commented Aug 13, 2024 •

edited

Loading