Add pformat to config object #33

danr · 2021-03-11T10:43:44Z

I sometimes find pprint.pformat suboptimal so it would be nice if I could drop-in replace it for snoop. This PR adds pp_pformat to the config object (and the snoop.install method) to override it with some other function.

It is also useful if you want to configure pprint.pformat, for example passing sort_keys=False.

alexmojaki · 2021-03-11T11:00:21Z

Thanks, I'm in favour of this. Something similar was requested in #13.

Please:

Change the name from pp_pformat to just pformat which I think is easier.
Set the default in Config.__init__ rather than write.
Use pprintpp if it can be imported, i.e. https://github.com/wolever/pprintpp is installed.
Otherwise, try importing prettyprinter. Let me know if you think the precedence should be swapper, they look like similar quality.
Add some documentation.

alexmojaki · 2021-03-11T11:02:18Z

Oh and there's also https://github.com/panyanyany/beeprint. Why are they all equally good looking lol

danr · 2021-03-11T11:19:47Z

Thanks for the feedback. The prettyprinter library seems like the highest quality from a quick glance.

The precedence I expect is:

The user has explicitly passed pformat to the install method or config object
If installed: prettyprinter.pformat.
If installed: pprintpp.pformat.
The standard pprint.pformat.

I'm a bit hesitant to this check for external libraries during runtime but it's your shot of course. Personally I will just be using my own pretty printer for now.

On the failing test case: I'm not sure what happens on 3.4, but all of the versions get really confused after the with snoop: block. Should I design the test a bit differently perhaps?

danr · 2021-03-11T12:11:06Z

New commit pushed now. I am not sure how to test if the 3rd party printing libraries are there with the tox setup. Ideally both with and without 3rd party printing libraries should be tested.

danr · 2021-03-11T12:12:45Z

I wrote:

On the failing test case: I'm not sure what happens on 3.4, but all of the versions get really confused after the with snoop: block. Should I design the test a bit differently perhaps?

I designed the test a bit differently, now this distractor is not present.

danr · 2021-03-11T12:14:27Z

Ok, python 3.4 is still confused. Is this to be expected?

alexmojaki · 2021-03-11T12:59:41Z

pp is not expected to work in 3.4.

Use FIX_SNOOP_TESTS=1 tox to generate the sample files.

tests/samples/pp_custom_pformat.py

alexmojaki · 2021-03-11T13:03:56Z

all of the versions get really confused after the with snoop: block.

That really shouldn't happen, I will try finding out why later on.

danr · 2021-03-11T13:06:29Z

Do you have some way to install all the python versions for tox? I'm installing python34 from arch linux aur now...

alexmojaki · 2021-03-11T13:08:11Z

pyenv is great, for me at least, not sure about ubuntu.

If you have difficulties, I'll handle the tests.

danr · 2021-03-11T13:35:28Z

Hmm yes please do, I'm struggling getting a 3.4 working.

alexmojaki · 2021-03-12T20:42:42Z

The precedence I expect is:

The user has explicitly passed pformat to the install method or config object

If installed: prettyprinter.pformat.

If installed: pprintpp.pformat.

The standard pprint.pformat.

I'm a bit hesitant to this check for external libraries during runtime but it's your shot of course. Personally I will just be using my own pretty printer for now.

~~Add https://github.com/panyanyany/beeprint to that list.~~

Install all the libraries for tests. Test that it uses prettyprinter by default. Set sys.modules["prettyprinter"] = None (I haven't actually tested this but I'm sure something similar must be possible). Test that it now uses pprintpp by default, etc.

alexmojaki · 2021-03-12T20:53:45Z

Oh, beeprint is not just like pprint, forget that.

alexmojaki · 2021-03-12T20:55:43Z

I'm catching all exceptions rather than just ImportError because that's been an issue for me before: alexmojaki/birdseye#82

alexmojaki · 2021-03-13T11:09:02Z

all of the versions get really confused after the with snoop: block.

That really shouldn't happen, I will try finding out why later on.

Fixed in #34. This was a very weird and interesting problem, see cool-RR/PySnooper#214 for the explanation. Thanks for your contribution which picked this up.

danr · 2021-03-15T16:19:22Z

Added a few lines of documentation and tests for the 3rd party libraries. Turns out you can simply do sys.modules['pprintpp'] = {} to make from pprintpp import pformat fail (since that empty dictionary does not contain {}).

Fixed in #34. This was a very weird and interesting problem, see cool-RR/PySnooper#214 for the explanation. Thanks for your contribution which picked this up.

Nice!

danr · 2021-03-15T16:19:51Z

I only ran tests for 2.7 and 3.9 since that's the versions I have around 😬

alexmojaki · 2021-03-17T21:37:17Z

snoop/configuration.py

-        If you want a custom column, please open an issue to tell me what you're interested in! In the meantime, you can pass a list, where the elements are either strings or callables. The callables should take one argument, which will be an `Event` object. It has attributes `frame`, `event`, and `arg`, as specified in [`sys.settrace()`](https://docs.python.org/3/library/sys.html#sys.settrace), and other attributes which may change. 
+
+        If you want a custom column, please open an issue to tell me what you're interested in! In the meantime, you can pass a list, where the elements are either strings or callables. The callables should take one argument, which will be an `Event` object. It has attributes `frame`, `event`, and `arg`, as specified in [`sys.settrace()`](https://docs.python.org/3/library/sys.html#sys.settrace), and other attributes which may change.
+    - `pformat`: set the pretty formatting function `pp` uses. Default is to use the first of `prettyprinter.pformat`, `pprintpp.pformat` and `pprint.pformat` that can be imported.


Please also mention the pformat argument here and under Output configuration.

It is mentioned there (?) I pushed a new commit which adds it to the README's Output configuration section.

lol my brain only saw mention of the libraries and not the argument.

alexmojaki · 2021-03-26T14:37:24Z

Had to take a detour to fix birdseye which was broken by a new release of sqlalchemy...

alexmojaki · 2021-03-26T18:42:57Z

Ah, I think I meant to say that pformat needs to be mentioned here: https://github.com/alexmojaki/snoop#pp---awesome-print-debugging . But now that I think of it, there's no mention of configuration there, so it's fine.

Anyway, this is released under 0.3.0

Thank you!

danr · 2021-03-27T08:48:30Z

Thanks Alex!

alexmojaki mentioned this pull request Mar 11, 2021

Use pprintpp if insalled #13

Closed

danr force-pushed the master branch from 1feef2f to 5a424cc Compare March 11, 2021 12:09

danr changed the title ~~Add pp_pformat to config object~~ Add pformat to config object Mar 11, 2021

alexmojaki reviewed Mar 11, 2021

View reviewed changes

tests/samples/pp_custom_pformat.py Outdated Show resolved Hide resolved

danr and others added 3 commits March 15, 2021 14:53

Add pformat to config and use 3rd party printers if available

61bf837

Fix tests for 3.4 which can't pp

f1367de

Refactor third party pprint imports, catch all exceptions just in case

9efcf02

danr force-pushed the master branch from ef334bc to 69c90a0 Compare March 15, 2021 16:17

Add documentation and add 3rd party pp libs to tests

69c90a0

alexmojaki reviewed Mar 17, 2021

View reviewed changes

Fix tests

aef660b

Describe pformat in the README Output configuration

605a7b0

alexmojaki merged commit 44d659a into alexmojaki:master Mar 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pformat to config object #33

Add pformat to config object #33

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

danr commented Mar 11, 2021

danr commented Mar 11, 2021 •

edited

Loading

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

alexmojaki commented Mar 12, 2021 •

edited

Loading

alexmojaki commented Mar 12, 2021

alexmojaki commented Mar 12, 2021

alexmojaki commented Mar 13, 2021

danr commented Mar 15, 2021

danr commented Mar 15, 2021

alexmojaki Mar 17, 2021

danr Mar 26, 2021

alexmojaki Mar 26, 2021

alexmojaki commented Mar 26, 2021

alexmojaki commented Mar 26, 2021 •

edited

Loading

danr commented Mar 27, 2021

Add pformat to config object #33

Add pformat to config object #33

Conversation

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

danr commented Mar 11, 2021

danr commented Mar 11, 2021 • edited Loading

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

alexmojaki commented Mar 11, 2021

danr commented Mar 11, 2021

alexmojaki commented Mar 12, 2021 • edited Loading

alexmojaki commented Mar 12, 2021

alexmojaki commented Mar 12, 2021

alexmojaki commented Mar 13, 2021

danr commented Mar 15, 2021

danr commented Mar 15, 2021

alexmojaki Mar 17, 2021

Choose a reason for hiding this comment

danr Mar 26, 2021

Choose a reason for hiding this comment

alexmojaki Mar 26, 2021

Choose a reason for hiding this comment

alexmojaki commented Mar 26, 2021

alexmojaki commented Mar 26, 2021 • edited Loading

danr commented Mar 27, 2021

danr commented Mar 11, 2021 •

edited

Loading

alexmojaki commented Mar 12, 2021 •

edited

Loading

alexmojaki commented Mar 26, 2021 •

edited

Loading