Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommikaikkonen/prettyprinter
Syntax-highlighting, declarative and composable pretty printer for Python 3.5+
https://github.com/tommikaikkonen/prettyprinter
pretty prettyprint prettyprinter print
Last synced: 5 days ago
JSON representation
Syntax-highlighting, declarative and composable pretty printer for Python 3.5+
- Host: GitHub
- URL: https://github.com/tommikaikkonen/prettyprinter
- Owner: tommikaikkonen
- License: mit
- Created: 2017-12-08T09:18:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T22:22:37.000Z (12 months ago)
- Last Synced: 2024-11-21T08:14:13.485Z (21 days ago)
- Topics: pretty, prettyprint, prettyprinter, print
- Language: Python
- Homepage: https://prettyprinter.readthedocs.io
- Size: 1.01 MB
- Stars: 336
- Watchers: 9
- Forks: 20
- Open Issues: 39
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
- starred-awesome - prettyprinter - Syntax-highlighting, declarative and composable pretty printer for Python 3.5+ (Python)
README
=============
PrettyPrinter
=============
Documentation_
Syntax-highlighting, declarative and composable pretty printer for Python 3.5+
.. code:: bash
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
.. image:: prettyprinterscreenshot.png
:alt:
.. image:: ../prettyprinterscreenshot.png
:alt:
.. image:: prettyprinterlightscreenshot.png
:alt:
.. image:: ../prettyprinterlightscreenshot.png
:alt:
Pretty print common Python values:
.. code:: python
>>> 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:
.. code:: python
>>> 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, which you can enable by calling ``prettyprinter.install_extras()``:
- ``datetime`` - (installed by default)
- ``enum`` - (installed by default)
- ``pytz`` - (installed by default)
- ``dataclasses`` - any new class you create will be pretty printed automatically
- ``attrs`` - pretty prints any new class you create with ``attrs``
- ``django`` - pretty prints your Models and QuerySets
- ``numpy`` - pretty prints numpy scalars with explicit types
- ``requests`` - pretty prints Requests, Responses, Sessions, and more from the ``requests`` library
* Free software: MIT license
* Documentation: Documentation_.
.. _Documentation: https://prettyprinter.readthedocs.io