bpo-37376: pprint support for SimpleNamespace #14318

carlbordum · 2019-06-23T12:24:52Z

https://bugs.python.org/issue37376

serhiy-storchaka

LGTM in general.

Only needed to document this change:

Add the versionchanged directive in the pprint module documentation.
Add a news entry in Misc/NEWS.d (use blurb).
Add an entry in the What's New document.
Add your name in Misc/ACKS if it is not there yet.

Lib/pprint.py

bedevere-bot · 2019-06-23T14:37:25Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

carlbordum · 2019-06-24T09:54:39Z

I have made the requested changes; please review again.

bedevere-bot · 2019-06-24T09:54:42Z

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

Doc/library/pprint.rst

Misc/ACKS

Misc/NEWS.d/next/Library/2019-06-24-11-26-34.bpo-37376.SwSUQ4.rst

carlbordum · 2019-06-24T14:59:17Z

I have made the requested changes; please review again.

bedevere-bot · 2019-06-24T14:59:19Z

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

Doc/library/pprint.rst

ericsnowcurrently

Thanks for working on this! Mostly LGTM. I've left a few comments.

ericsnowcurrently · 2019-06-24T15:59:01Z

Lib/test/test_pprint.py

@@ -346,6 +346,36 @@ def test_mapping_proxy(self):
                          ('lazy', 7),
                          ('dog', 8)]))""")

+    def test_empty_simple_namespace(self):
+        self.assertEqual(pprint.pformat(types.SimpleNamespace()), "namespace()")


FWIW, code is almost always more readable when limited to one action per line. Among other things, it makes it much easier to understand what's happening (especially when parentheses are involved).

Suggested change

self.assertEqual(pprint.pformat(types.SimpleNamespace()), "namespace()")

formatted = pprint.pformat(

types.SimpleNamespace())

self.assertEqual(formatted, "namespace()")

Personally I like to separate the 3 parts (setup, actual-thing-to-test, assertions) with blank lines, for further readability, but that's more personal preference:

Suggested change

self.assertEqual(pprint.pformat(types.SimpleNamespace()), "namespace()")

ns = types.SimpleNamespace()

formatted = pprint.pformat(ns)

self.assertEqual(formatted, "namespace()")

I do not think that adding an empty line after every line of code will make the code more readable. Empty lines should be used for separating logical sections of the code.

This code is consistent with the code in this file and looks clear to me. I do not think that any changes are needed.

I followed most of @ericsnowcurrently's suggestions, but without the empty lines and without textwrap.dedent to be consistent with the rest of the file and I think it has made the test more clear.

Lib/test/test_pprint.py

ericsnowcurrently · 2019-06-24T15:59:01Z

Lib/test/test_pprint.py

+            lazy=7,
+            dog=8,
+        )
+        self.assertEqual(pprint.pformat(n, width=60), """\


As before, I recommend one action per line.

Suggested change

self.assertEqual(pprint.pformat(n, width=60), """\

formatted = pprint.pformat(ns, width=60)

self.assertEqual(formatted, """\

...and separating the key sections of the test.

Suggested change

self.assertEqual(pprint.pformat(n, width=60), """\

formatted = pprint.pformat(ns, width=60)

self.assertEqual(formatted, """\

Lib/pprint.py

bedevere-bot · 2019-06-24T15:59:05Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

carlbordum · 2019-06-25T09:33:27Z

I have made the requested changes; please review again.

@serhiy-storchaka I ended up removing the write = stream.write optimization. If you do think it is worth it in this case, please let me know and I'll bring it back (properly this time, as pointed out by @ericsnowcurrently).

bedevere-bot · 2019-06-25T09:33:29Z

Thanks for making the requested changes!

@ericsnowcurrently, @serhiy-storchaka: please review the changes made to this pull request.

serhiy-storchaka

Add a test for a SimpleNamespace subclass.

bedevere-bot · 2019-06-25T09:40:23Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

carlbordum · 2019-06-25T18:44:57Z

I have made the requested changes; please review again.

@serhiy-storchaka ofc it was because of subclassing. Glad you're here to review! :D

bedevere-bot · 2019-06-25T18:45:00Z

Thanks for making the requested changes!

@ericsnowcurrently, @serhiy-storchaka: please review the changes made to this pull request.

serhiy-storchaka

Thank you Carl. LGTM, just fix an indentation in docs.

serhiy-storchaka · 2019-06-25T19:34:19Z

Doc/library/pprint.rst

@@ -25,6 +25,9 @@ width constraint.

 Dictionaries are sorted by key before the display is computed.

+.. versionchanged:: 3.9
+  Added support for pretty-printing :class:`types.SimpleNamespace`.


Suggested change

Added support for pretty-printing :class:`types.SimpleNamespace`.

Added support for pretty-printing :class:`types.SimpleNamespace`.

ericsnowcurrently

Thanks for working to resolve our various comments!

Other than one small thing, LGTM.

ericsnowcurrently · 2019-06-25T21:20:52Z

Lib/pprint.py

@@ -342,6 +342,31 @@ def _pprint_mappingproxy(self, object, stream, indent, allowance, context, level

    _dispatch[_types.MappingProxyType.__repr__] = _pprint_mappingproxy

+    def _pprint_simplenamespace(self, object, stream, indent, allowance, context, level):
+        cls_name = object.__class__.__name__
+        if cls_name == "SimpleNamespace":


If this check is for the sake of subclasses then I'd recommend being explicit about it:

Suggested change

if cls_name == "SimpleNamespace":

if type(object) is _types.SimpleNamespace:

bedevere-bot · 2019-06-25T21:20:55Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

carlbordum · 2019-06-26T16:42:33Z

I have made the requested changes; please review again.

@ericsnowcurrently I attempted to make it more clear what the class-name-if-statement is about.

Thank you very much to the both of you for the fast, high quality responses. It was a good experience :-)

bedevere-bot · 2019-06-26T16:42:37Z

Thanks for making the requested changes!

@ericsnowcurrently, @serhiy-storchaka: please review the changes made to this pull request.

ericsnowcurrently

LGTM. I'm approving this, but also leaving one last comment. :) (feel free to ignore)

Thanks again for doing this.

ericsnowcurrently · 2019-06-26T20:03:24Z

Lib/pprint.py

@@ -342,6 +342,33 @@ def _pprint_mappingproxy(self, object, stream, indent, allowance, context, level

    _dispatch[_types.MappingProxyType.__repr__] = _pprint_mappingproxy

+    def _pprint_simplenamespace(self, object, stream, indent, allowance, context, level):
+        if type(object) is _types.SimpleNamespace:


Thanks for updating this. It's more clear now (as a reader).

And better. Checking the class by comparing the class name to a string is a bit wonky :D Thanks for pointing out, what I was actually doing.

ericsnowcurrently · 2019-06-26T20:03:24Z

Lib/pprint.py

@@ -342,6 +342,33 @@ def _pprint_mappingproxy(self, object, stream, indent, allowance, context, level

    _dispatch[_types.MappingProxyType.__repr__] = _pprint_mappingproxy

+    def _pprint_simplenamespace(self, object, stream, indent, allowance, context, level):
+        if type(object) is _types.SimpleNamespace:
+            # the SimpleNamespace repr is "namespace", while the class name is


Thanks for adding a comment here. That helps. :) FWIW, the following might be more clear:

# The SimpleNamespace repr has "namespace" instead of the class name, so # we do the same here. For subclasses we just use the class name.

Tried improving it, should be clear now

https://bugs.python.org/issue37376

the-knights-who-say-ni added the CLA signed label Jun 23, 2019

bedevere-bot added the awaiting review label Jun 23, 2019

serhiy-storchaka requested changes Jun 23, 2019

View changes

Lib/pprint.py Outdated Show resolved Hide resolved

bedevere-bot added awaiting changes and removed awaiting review labels Jun 23, 2019

serhiy-storchaka added the type-feature A feature request or enhancement label Jun 23, 2019

carlbordum force-pushed the pprint-simplenamespace branch 2 times, most recently from 8ee8ca1 to 68ff595 Compare Jun 24, 2019

bedevere-bot added awaiting change review and removed awaiting changes labels Jun 24, 2019

serhiy-storchaka reviewed Jun 24, 2019

View changes

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

Misc/ACKS Show resolved Hide resolved

Misc/NEWS.d/next/Library/2019-06-24-11-26-34.bpo-37376.SwSUQ4.rst Outdated Show resolved Hide resolved

carlbordum force-pushed the pprint-simplenamespace branch from 68ff595 to 2bd11f2 Compare Jun 24, 2019

serhiy-storchaka reviewed Jun 24, 2019

View changes

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

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

ericsnowcurrently requested changes Jun 24, 2019

View changes

bedevere-bot removed the awaiting change review label Jun 24, 2019

bedevere-bot added the awaiting changes label Jun 24, 2019

carlbordum force-pushed the pprint-simplenamespace branch from 2bd11f2 to 7d3fbba Compare Jun 25, 2019

bedevere-bot added awaiting change review and removed awaiting changes labels Jun 25, 2019

serhiy-storchaka requested changes Jun 25, 2019

View changes

bedevere-bot removed the awaiting change review label Jun 25, 2019

carlbordum force-pushed the pprint-simplenamespace branch from 7d3fbba to b701a7a Compare Jun 25, 2019

bedevere-bot added awaiting change review and removed awaiting changes labels Jun 25, 2019

serhiy-storchaka approved these changes Jun 25, 2019

View changes

bedevere-bot added awaiting merge and removed awaiting change review labels Jun 25, 2019

ericsnowcurrently requested changes Jun 25, 2019

View changes

bedevere-bot removed the awaiting merge label Jun 25, 2019

bedevere-bot added the awaiting changes label Jun 25, 2019

carlbordum force-pushed the pprint-simplenamespace branch 2 times, most recently from a584309 to 49fa618 Compare Jun 26, 2019

bedevere-bot added awaiting change review and removed awaiting changes labels Jun 26, 2019

ericsnowcurrently approved these changes Jun 26, 2019

View changes

bedevere-bot added awaiting merge and removed awaiting change review labels Jun 26, 2019

bpo-37376: pprint support for SimpleNamespace

8867ef7

carlbordum force-pushed the pprint-simplenamespace branch from 49fa618 to 8867ef7 Compare Jun 26, 2019

ericsnowcurrently added the 🤖 automerge PR will be merged once it's been approved and all CI passed label Jun 26, 2019

miss-islington merged commit 06a8916 into python:master Jun 26, 2019

bedevere-bot removed the awaiting merge label Jun 26, 2019

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019

bpo-37376: pprint support for SimpleNamespace (pythonGH-14318)

6d4192d

https://bugs.python.org/issue37376

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020

bpo-37376: pprint support for SimpleNamespace (pythonGH-14318)

d3a73a4

https://bugs.python.org/issue37376

LewisGaul mentioned this pull request Jan 31, 2021

bpo-43080: pprint for dataclass instances #24389

Merged

bpo-37376: pprint support for SimpleNamespace #14318

bpo-37376: pprint support for SimpleNamespace #14318

carlbordum commented Jun 23, 2019 •

edited by bedevere-bot

serhiy-storchaka left a comment

bedevere-bot commented Jun 23, 2019

carlbordum commented Jun 24, 2019

bedevere-bot commented Jun 24, 2019

carlbordum commented Jun 24, 2019

bedevere-bot commented Jun 24, 2019

ericsnowcurrently left a comment

ericsnowcurrently Jun 24, 2019

serhiy-storchaka Jun 25, 2019

carlbordum Jun 25, 2019

ericsnowcurrently Jun 24, 2019

bedevere-bot commented Jun 24, 2019

carlbordum commented Jun 25, 2019

bedevere-bot commented Jun 25, 2019

serhiy-storchaka left a comment

bedevere-bot commented Jun 25, 2019

carlbordum commented Jun 25, 2019

bedevere-bot commented Jun 25, 2019

serhiy-storchaka left a comment

serhiy-storchaka Jun 25, 2019

ericsnowcurrently left a comment

ericsnowcurrently Jun 25, 2019 •

edited

bedevere-bot commented Jun 25, 2019

carlbordum commented Jun 26, 2019

bedevere-bot commented Jun 26, 2019

ericsnowcurrently left a comment

ericsnowcurrently Jun 26, 2019

carlbordum Jun 26, 2019

ericsnowcurrently Jun 26, 2019

carlbordum Jun 26, 2019

-        self.assertEqual(pprint.pformat(types.SimpleNamespace()), "namespace()")
+        ns = types.SimpleNamespace()
+        formatted = pprint.pformat(ns)
+        self.assertEqual(formatted, "namespace()")

	self.assertEqual(pprint.pformat(n, width=60), """\
	formatted = pprint.pformat(ns, width=60)
	self.assertEqual(formatted, """\

-        self.assertEqual(pprint.pformat(n, width=60), """\
+        formatted = pprint.pformat(ns, width=60)
+        self.assertEqual(formatted, """\

	Added support for pretty-printing :class:`types.SimpleNamespace`.
	Added support for pretty-printing :class:`types.SimpleNamespace`.

	if cls_name == "SimpleNamespace":
	if type(object) is _types.SimpleNamespace:

bpo-37376: pprint support for SimpleNamespace #14318

bpo-37376: pprint support for SimpleNamespace #14318

Conversation

carlbordum commented Jun 23, 2019 • edited by bedevere-bot

serhiy-storchaka left a comment

bedevere-bot commented Jun 23, 2019

carlbordum commented Jun 24, 2019

bedevere-bot commented Jun 24, 2019

carlbordum commented Jun 24, 2019

bedevere-bot commented Jun 24, 2019

ericsnowcurrently 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

bedevere-bot commented Jun 24, 2019

carlbordum commented Jun 25, 2019

bedevere-bot commented Jun 25, 2019

serhiy-storchaka left a comment

bedevere-bot commented Jun 25, 2019

carlbordum commented Jun 25, 2019

bedevere-bot commented Jun 25, 2019

serhiy-storchaka left a comment

Choose a reason for hiding this comment

ericsnowcurrently left a comment

ericsnowcurrently Jun 25, 2019 • edited

Choose a reason for hiding this comment

bedevere-bot commented Jun 25, 2019

carlbordum commented Jun 26, 2019

bedevere-bot commented Jun 26, 2019

ericsnowcurrently 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

carlbordum commented Jun 23, 2019 •

edited by bedevere-bot

ericsnowcurrently Jun 25, 2019 •

edited