Syntax-highlighting, declarative and composable pretty printer for Python 3.6+
Project description
PrettyPrinter
Syntax-highlighting, declarative and composable pretty printer for Python 3.6+
pip install prettyprinter
Drop in replacement for the standard library pprint: just rename pprint to prettyprinter in your imports.
Uses a modified Wadler-Leijen layout algorithm for optimal formatting
Write pretty printers for your own types with a dead simple, declarative interface
Pretty print common Python values:
>>> from datetime import datetime
>>> from prettyprinter import pprint
>>> pprint({'beautiful output': datetime.now()})
{
'beautiful output': datetime.datetime(
year=2017,
month=12,
day=12,
hour=0,
minute=43,
second=4,
microsecond=752094
)
}
As well as your own, without any manual string formatting:
>>> class MyClass:
... def __init__(self, one, two):
... self.one = one
... self.two = two
>>> from prettyprinter import register_pretty, pretty_call
>>> @register_pretty(MyClass)
... def pretty_myclass(value, ctx):
... return pretty_call(ctx, MyClass, one=value.one, two=value.two)
>>> pprint(MyClass((1, 2, 3), {'a': 1, 'b': 2}))
MyClass(one=(1, 2, 3), two={'a': 1, 'b': 2})
>>> pprint({'beautiful output': datetime.now(), 'beautiful MyClass instance': MyClass((1, 2, 3), {'a': 1, 'b': 2})})
{
'beautiful MyClass instance': MyClass(
one=(1, 2, 3),
two={'a': 1, 'b': 2}
),
'beautiful output': datetime.datetime(
year=2017,
month=12,
day=12,
hour=0,
minute=44,
second=18,
microsecond=384219
)
}
Comes packaged with the following pretty printer definitions:
datetime - (installed by default)
enum - (installed by default)
pytz - (installed by default)
dataclasses - any new class you create will be pretty printed automatically
attrs - any new class you create will be pretty printed automatically
django - your Models and QuerySets will be pretty printed automatically
requests - automatically pretty prints Requests, Responses, Sessions, and more from the requests library
Free software: MIT license
Documentation: Documentation.
History
0.10.0 (2018-01-09)
No breaking changes.
Added support for deferred printer registration, where instead of a concrete type value, you can pass a qualified path to a type as a str to register_pretty. For an example, see the deferred printer registration for uuid.UUID
0.9.0 (2018-01-03)
No breaking changes.
Added pretty printer definition for types.MappingProxyType thanks to GitHub user Cologler
Added support for _repr_pretty_ in the extra ipython_repr_pretty.
0.8.1 (2018-01-01)
Fixed issue #7 where having a str value for IPython’s highlighting_style setting was not properly handled in prettyprinter’s IPython integration, and raised an exception when trying to print data.
0.8.0 (2017-12-31)
Breaking changes:
by default, dict keys are printed in the default order (insertion order in CPython 3.6+). Previously they were sorted like in the pprint standard library module. To let the user control this, an additional keyword argument sort_dict_keys was added to cpprint, pprint, and pformat. Pretty printer definitions can control dict key sorting with the PrettyContext instance passed to each pretty printer function.
Non-breaking changes:
Improved performance of rendering colorized output by caching colors.
Added prettyprinter.pretty_repr that is assignable to __repr__ dunder methods, so you don’t need to write it separately from the pretty printer definition.
Deprecated use of PrettyContext.set in favor of less misleading PrettyContext.assoc
Defined pretty printing for instances of type, i.e. classes.
Defined pretty printing for functions
0.7.0 (2017-12-23)
Breaking change: instances of lists, sets, frozensets, tuples and dicts will be truncated to 1000 elements by default when printing.
Added pretty printing definitions for dataclasses
Improved performance of splitting strings to multiple lines by ~15%
Added a maximum sequence length that applies to subclasses of lists, sets, frozensets, tuples and dicts. The default is 1000. There is a trailing comment that indicates the number of truncated elements. To remove truncation, you can set max_seq_len to None using set_default_config explained below.
Added ability to change the default global configuration using set_default_config. The functions accepts zero to many keyword arguments and replaces those values in the global configuration with the ones provided.
from prettyprinter import set_default_config
set_default_config(
style='dark',
max_seq_len=1000,
width=79,
ribbon_width=71,
depth=None,
)
0.6.0 (2017-12-21)
No backwards incompatible changes.
Added pretty printer definitions for the requests library. To use it, include 'requests' in your install_extras call: prettyprinter.install_extras(include=['requests']).
0.5.0 (2017-12-21)
No backwards incompatible changes.
Added integration for the default Python shell
Wrote docs to explain integration with the default Python shell
Check install_extras arguments for unknown extras
0.4.0 (2017-12-14)
Revised comment to accept both normal Python values and Docs, and reversed the argument order to be more Pythonic
0.3.0 (2017-12-12)
Add set_default_style function, improve docs on working with a light background
0.2.0 (2017-12-12)
Numerous API changes and improvements.
0.1.0 (2017-12-07)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for prettyprinter-0.10.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3647945df97acddc9ce626712a1d8c4f5bb98cfa0fb4cb7cca4bd6c4da3e217 |
|
MD5 | 2b94e26d6ac3ca9ee0888efebac1a47b |
|
BLAKE2b-256 | bd0069419265fa40f285a225ad7be0ba4545e35ca80fc8afaacbad6030a60b76 |