gh-112632 : Added an option for block formatting to `pprint` #129274

StefanTodoran · 2025-01-25T02:34:00Z

Adds a block print option to pprint. This option is not compatible with compact. Although the original issue only mentions dictionaries, this implementation implements block style for every datastructure supported by pprint. I've been testing it with the code in this gist, which is just a bunch of random datastructures filled with dummy data.

Issue: pprint with compact indent #112632

ghost · 2025-01-25T02:34:02Z

All commit authors signed the Contributor License Agreement.

bedevere-app · 2025-01-25T02:34:07Z

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.

donBarbos · 2025-02-05T23:01:15Z

looks pretty good 👍, but

I think you can move test cases from your gist to Lib/test/test_pprint.py.
It is also important to update documentation, you'll find them here Doc/library/pprint.rst.

And please try to make sure CI passes

bedevere-app · 2025-02-06T23:35:52Z

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.

bedevere-app · 2025-02-06T23:43:40Z

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.

bedevere-app · 2025-02-07T00:14:10Z

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.

donBarbos · 2025-02-07T00:23:08Z

Could you also add a News entry into the Misc/NEWS.d (check bedevere's comments)?

And I think it's a full fledged new feature so this update deserves to be in Doc/whatsnew/ (What's New entry)

StefanTodoran · 2025-02-07T00:39:41Z

I've added a test case for the new block_style parameter and updated the documentation. Will add the news entry now. Quick question:

How can I make the CI pass? I've only changed Lib.pprint.py and I pass Lib/test/test_pprint.py, so I don't understand why exactly the Tests / Thread sanitizer (free-threading) CI test is failing.

donBarbos · 2025-02-07T00:46:30Z

How can I make the CI pass? I've only changed Lib.pprint.py and I pass Lib/test/test_pprint.py, so I don't understand why exactly the Tests / Thread sanitizer (free-threading) CI test is failing.

sometimes the problem may not be in you and you need to wait and update your branch (at least it helped me)

Misc/NEWS.d/next/Library/2025-02-07-00-48-07.gh-issue-112632.95MM0C.rst

Doc/library/pprint.rst

Lib/test/test_pprint.py

donBarbos · 2025-02-09T11:30:43Z

and don't forget to add news to Doc/whatsnew/3.14.rst

And I think it's a full fledged new feature so this update deserves to be in Doc/whatsnew/ (What's New entry)

Co-authored-by: donBarbos <donbarbos@proton.me>

StefanTodoran · 2025-02-25T17:02:44Z

I've merged those changes. Thanks for helping me out with that! Is there anything else?

donBarbos · 2025-02-25T17:09:44Z

I've merged those changes. Thanks for helping me out with that! Is there anything else?

Let's try to solve problems with test_pprint.QueryTestCase.test_block_style

Lib/test/test_pprint.py

Co-authored-by: donBarbos <donbarbos@proton.me>

donBarbos · 2025-02-26T16:47:42Z

I think we can ping @tomasr8 if you're done making changes.

StefanTodoran · 2025-02-26T19:19:53Z

Sounds good, I have no more changes to add.

tomasr8

I think it's looking pretty good now! Just two comments:

Doc/whatsnew/3.14.rst

tomasr8 · 2025-02-26T20:42:25Z

Lib/pprint.py

-        stream.write(cls.__name__ + '({')
-        if self._indent_per_level > 1:
+        stream.write(self._format_block_start(cls.__name__ + '({', indent))
+        if self._indent_per_level > 1 and not self._block_style:


This is not covered by tests (the condition is always False).

For such a large change, I suggest running coverage and checking the html report to make sure your tests cover all cases. There's a guide here, but the gist is:

./python -m ensurepip ./python -m pip install coverage ./python -m coverage run --pylib --source=pprint Lib/test/regrtest.py test_pprint ./python -m coverage html -i --include=`pwd`/Lib/* --omit="Lib/test/*,Lib/*/tests/*"

I don't understand, what do you mean the case is not covered? The existing tests already covered the case where _block_style is False and _indent_per_level is >1.

Also when I run the coverage command I don't see anything missing, am I doing something wrong?

python3 -m coverage run --pylib --source=pprint Lib/test/regrtest.py test_pprint /Users/stodoran/Desktop/cpython/venv/lib/python3.13/site-packages/coverage/inorout.py:486: CoverageWarning: Already imported a file that will be measured: /opt/homebrew/Cellar/python@3.13/3.13.2/Frameworks/Python.framework/Versions/3.13/lib/python3.13/pprint.py (already-imported) self.warn(msg, slug="already-imported") Using random seed: 4261013096 0:00:00 load avg: 4.87 Run 1 test sequentially in a single process 0:00:00 load avg: 4.87 [1/1] test_pprint == Tests result: SUCCESS == 1 test OK. Total duration: 129 ms Total tests: run=44 Total test files: run=1/1 Result: SUCCESS

python3 -m coverage html -i --include=`pwd`/Lib/* --omit="Lib/test/*,Lib/*/tests/*" No data to report.

From what I can see it's not covered:

I think there's some issue with the coverage command you ran as it says:

No data to report.

Try running it with the compiled binary directly, not with some other system python.

@StefanTodoran if you can't get HTML-based report you can use cli:

$ ./python -m coverage report --show-missing Name Stmts Miss Branch BrPart Cover Missing ----------------------------------------------------------- Lib/pprint.py 476 81 182 7 87% 37-46, 57, 67-72, 77, 82, 87-99, 102, 110, 115-116, 172, 174-177, 182, 185, 189, 192-195, 220, 226, 232, 243-245, 262-264, 276-278, 284-286, 293-295, 312-315, 353->326, 367-369, 388-390, 400-402, 409-411, 424-426, 444, 464, 507, 513, 516, 523, 537-539, 546, 556-558, 560-561, 573-575, 595-597, 600-602, 605-607, 610-612, 694, 703, 717->exit ----------------------------------------------------------- TOTAL 476 81 182 7 87%

I don't know why on the main branch this line is shown as covered, but this can be solved by adding an explicit pass of indent>1 to the QueryTestCase.test_counter test, like this:

d = collections.Counter('senselessness') self.assertEqual(pprint.pformat(d, indent=2, width=1), """\ Counter({ 's': 6, 'e': 4, 'n': 2, 'l': 1})""")

and the line will become covered 👍
(unfortunately i can't send you a suggestion as there is no diff nearby, so please add it yourself)

lordmauve · 2025-03-25T11:03:46Z

Lib/pprint.py

-        stream.write('[')
+        stream.write(self._format_block_start('[', indent))
        self._format_items(object, stream, indent, allowance + 1,
                           context, level)
-        stream.write(']')
+        stream.write(self._format_block_end(']', indent))


You have a lot of repeated code here conditional on self._block_style. How about defining a context manager to clean this up?

with self._block(stream, indent, '[', ']') as new_indent: self._format_items(object, stream, new_indent, allowance + 1, context, level)

AA-Turner · 2025-04-20T22:28:55Z

Doc/library/pprint.rst

+                 compact=False, sort_dicts=False, underscore_numbers=False, \
+                 block_style=False)


These are keyword-only (after *), so we have the luxury of alphabetical sorting:

Suggested change

compact=False, sort_dicts=False, underscore_numbers=False, \

block_style=False)

block_style=False, compact=False, sort_dicts=False, \

underscore_numbers=False)

AA-Turner · 2025-04-20T22:29:53Z

Doc/library/pprint.rst

+                     compact=False, sort_dicts=True, \
+                     underscore_numbers=False, block_style=False)


Likewise

Suggested change

compact=False, sort_dicts=True, \

underscore_numbers=False, block_style=False)

block_style=False, compact=False, \

sort_dicts=True, underscore_numbers=False)

AA-Turner · 2025-04-20T22:30:57Z

Doc/library/pprint.rst

+      If ``True``,
+      opening parentheses and brackets will be followed by a newline and the
+      following content will be indented by one level, similar to block style
+      JSON formatting. This option is not compatible with *compact*.


This option is not compatible with compact.

A passing thought: Perhaps introduce a mode (str) argument, and deprecate compact in favour of it? It's not great to have two conflicting Booleans, though it may be the best option for now.

AA-Turner · 2025-04-20T22:31:31Z

Doc/library/pprint.rst

+                      compact=False, sort_dicts=True, \
+                      underscore_numbers=False, block_style=False)


Likewise

Suggested change

compact=False, sort_dicts=True, \

underscore_numbers=False, block_style=False)

block_style=False, compact=False, \

sort_dicts=True, underscore_numbers=False)

AA-Turner · 2025-04-20T22:32:00Z

Doc/library/pprint.rst

+                         compact=False, sort_dicts=True, \
+                         underscore_numbers=False, block_style=False)


Likewise

Suggested change

compact=False, sort_dicts=True, \

underscore_numbers=False, block_style=False)

block_style=False, compact=False, \

sort_dicts=True, underscore_numbers=False)

AA-Turner · 2025-04-20T22:33:39Z

Lib/pprint.py

+                 compact=False, sort_dicts=True, underscore_numbers=False,
+                 block_style=False):


Suggested change

compact=False, sort_dicts=True, underscore_numbers=False,

block_style=False):

block_style=False, compact=False, sort_dicts=True,

underscore_numbers=False):

AA-Turner · 2025-04-20T22:34:26Z

Lib/pprint.py

+            pretty-printed json.dumps() when `indent` is supplied. Incompatible
+            with compact mode.


Suggested change

pretty-printed json.dumps() when `indent` is supplied. Incompatible

with compact mode.

pretty-printed json.dumps() when ``indent`` is supplied.

Incompatible with compact mode.

AA-Turner · 2025-04-20T22:35:43Z

Lib/pprint.py

+        else:
+            return start_str


Suggested change

else:

return start_str

return start_str

AA-Turner · 2025-04-20T22:35:52Z

Lib/pprint.py

+        else:
+            return end_str


Suggested change

else:

return end_str

return end_str

AA-Turner · 2025-04-20T22:36:19Z

Lib/pprint.py

    def _pprint_dataclass(self, object, stream, indent, allowance, context, level):
        # Lazy import to improve module import time
        from dataclasses import fields as dataclass_fields

        cls_name = object.__class__.__name__
-        indent += len(cls_name) + 1
+        indent += len(cls_name) + 1 if not self._block_style else self._indent_per_level


Please keep to 79/80 characters (PEP 8)

Added an option for block formatting to pprint

b9baf94

bedevere-app bot added the awaiting review label Jan 25, 2025

bedevere-app bot mentioned this pull request Jan 25, 2025

pprint with compact indent #112632

Open

tomasr8 self-requested a review January 25, 2025 09:29

Small bug fix for indent=1, added to unit test

f5fcbfc

Merge branch 'main' into fix-issue-112632

31a4d1e

Remove set from block style unit test (since order kept changing)

a92ef3d

blurb-it bot and others added 3 commits February 7, 2025 00:48

📜🤖 Added by blurb_it.

d9a147f

Merge branch 'main' into fix-issue-112632

ffef3b0

Fix params in news entry

19e4e08

donBarbos reviewed Feb 7, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2025-02-07-00-48-07.gh-issue-112632.95MM0C.rst Outdated Show resolved Hide resolved

Fix line length for news entry

8ef085f

donBarbos reviewed Feb 7, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2025-02-07-00-48-07.gh-issue-112632.95MM0C.rst Show resolved Hide resolved

StefanTodoran added 2 commits February 6, 2025 17:58

Shorten news entry

c446aa1

Merge branch 'main' into fix-issue-112632

f9bd6ef

donBarbos reviewed Feb 9, 2025

View reviewed changes

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

donBarbos reviewed Feb 9, 2025

View reviewed changes

Lib/test/test_pprint.py Outdated Show resolved Hide resolved

StefanTodoran added 3 commits February 19, 2025 10:23

Address documentation related PR comments

49b1108

Merge branch 'main' into fix-issue-112632

62dd5e5

Fix length of title underline :/

0b8fd2b

StefanTodoran and others added 16 commits February 25, 2025 08:47

Update Doc/library/pprint.rst

142b92b

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Doc/whatsnew/3.14.rst

2273be2

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

d8b5942

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

8c3ed5c

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

9c7afd5

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

4e7fbff

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

5abab85

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/pprint.py

5e8a624

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

5ffbd0d

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

fa4cdac

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

6bffc7e

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

c8ce4ff

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

879f1da

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

21c9fa6

Co-authored-by: donBarbos <donbarbos@proton.me>

Update Lib/test/test_pprint.py

815e1da

Co-authored-by: donBarbos <donbarbos@proton.me>

Merge branch 'main' into fix-issue-112632

9d12a8a

donBarbos reviewed Feb 25, 2025

View reviewed changes

Lib/test/test_pprint.py Outdated Show resolved Hide resolved

donBarbos reviewed Feb 25, 2025

View reviewed changes

Lib/test/test_pprint.py Outdated Show resolved Hide resolved

Apply suggestions from code review

a7c26dd

Co-authored-by: donBarbos <donbarbos@proton.me>

tomasr8 reviewed Feb 26, 2025

View reviewed changes

lordmauve reviewed Mar 25, 2025

View reviewed changes

StefanTodoran added 3 commits March 27, 2025 18:21

Split large test case into multiple smaller ones, update news entry

37312d9

Merge branch 'main' into fix-issue-112632

e3b09fa

Merge changes

712b644

AA-Turner changed the title ~~gh-112632 : Added an option for block formatting to Lib/pprint.py~~ gh-112632 : Added an option for block formatting to pprint Apr 20, 2025

AA-Turner reviewed Apr 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-112632 : Added an option for block formatting to `pprint` #129274

gh-112632 : Added an option for block formatting to `pprint` #129274

StefanTodoran commented Jan 25, 2025 •

edited by bedevere-app bot

Loading

ghost commented Jan 25, 2025 •

edited by ghost

Loading

bedevere-app bot commented Jan 25, 2025

donBarbos commented Feb 5, 2025

bedevere-app bot commented Feb 6, 2025

bedevere-app bot commented Feb 6, 2025

bedevere-app bot commented Feb 7, 2025

donBarbos commented Feb 7, 2025

StefanTodoran commented Feb 7, 2025 •

edited

Loading

donBarbos commented Feb 7, 2025 •

edited

Loading

donBarbos commented Feb 9, 2025

StefanTodoran commented Feb 25, 2025

donBarbos commented Feb 25, 2025

donBarbos commented Feb 26, 2025

StefanTodoran commented Feb 26, 2025

tomasr8 left a comment

tomasr8 Feb 26, 2025

StefanTodoran Mar 28, 2025

tomasr8 Apr 5, 2025

donBarbos Apr 18, 2025 •

edited

Loading

lordmauve Mar 25, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

AA-Turner Apr 20, 2025

		compact=False, sort_dicts=False, underscore_numbers=False, \
		block_style=False)

		compact=False, sort_dicts=True, \
		underscore_numbers=False, block_style=False)

		compact=False, sort_dicts=True, underscore_numbers=False,
		block_style=False):

		pretty-printed json.dumps() when `indent` is supplied. Incompatible
		with compact mode.

gh-112632 : Added an option for block formatting to pprint #129274

Are you sure you want to change the base?

gh-112632 : Added an option for block formatting to pprint #129274

Conversation

StefanTodoran commented Jan 25, 2025 • edited by bedevere-app bot Loading

ghost commented Jan 25, 2025 • edited by ghost Loading

bedevere-app bot commented Jan 25, 2025

donBarbos commented Feb 5, 2025

bedevere-app bot commented Feb 6, 2025

bedevere-app bot commented Feb 6, 2025

bedevere-app bot commented Feb 7, 2025

donBarbos commented Feb 7, 2025

StefanTodoran commented Feb 7, 2025 • edited Loading

donBarbos commented Feb 7, 2025 • edited Loading

donBarbos commented Feb 9, 2025

StefanTodoran commented Feb 25, 2025

donBarbos commented Feb 25, 2025

donBarbos commented Feb 26, 2025

StefanTodoran commented Feb 26, 2025

tomasr8 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

donBarbos Apr 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gh-112632 : Added an option for block formatting to `pprint` #129274

gh-112632 : Added an option for block formatting to `pprint` #129274

StefanTodoran commented Jan 25, 2025 •

edited by bedevere-app bot

Loading

ghost commented Jan 25, 2025 •

edited by ghost

Loading

StefanTodoran commented Feb 7, 2025 •

edited

Loading

donBarbos commented Feb 7, 2025 •

edited

Loading

donBarbos Apr 18, 2025 •

edited

Loading