Python 第三方打印库 PrettyPrinter

简介

默认 Python 中的 print 打印的结果可能不够美观，同时打印「字典」等数据类型的时候不会有层级关系。为了让输出更加好看，可以尝试使用 PrettyPrinter。

PrettyPrinter适用于 Python 3.5+ 的语法高亮。他是对 pprint 的改进，尽力产生漂亮的输出。下面是 PrettyPrinter 的演示截图：

参考资料

• PrettyPrinter Document Usage，PrettyPrinter 的官方说明文档（以下内容主要参考本文）；
• PrettyPrinter -- Github，PrettyPrinter 的 Github 链接；
• Python 的第三方打印类库 —— PrettyPrinter

PrettyPrinter 的使用

首先需要安装 prettyprinter 库，使用 pip 来进行安装：

pip install prettyprinter

接着只需要在使用的时候 import 即可。使用 cpprint 可以有颜色的输出：

而将 c 去掉的 pprint 则是没有颜色：

在 Python 代码中使用 PrettyPrinter

我们可以使用 cpprint 来获得带有颜色的输出。例如下面的例子我们将一个字典（dict）用较好的样式显示出来：

最终的显示效果如下所示，层级关系都是很清楚的，同时也加上了颜色：

上面默认的样式是深色模式（dark），可以使用下面的方式将样式调整为浅色模式（light）：

对 Numpy 数据进行高亮

我们可以通过 prettyprinter.install_extras 来为第三方库注册 prettyprinter。目前支持的有'ipython', 'ipython_repr_pretty', 'django', 'python', 'dataclasses', 'numpy', 'attrs', 'requests'（关于这部分可以查看 PrettyPrinter -- API Rederence 查看更加详细的说明）。

例如下面我们为 numpy 来注册，同时设置打印的宽度（在 cpprint 中设置 width 即可），并查看最终的效果：

最终效果如下图所示，可以看到打印的结果有了颜色高亮：

对自定义类设计样式

我们可以对自定义类注册 pretty printer。我们定义一个类：

接着都该类进行注册 pretty printer，后面在打印的时候就会出现样式：

之后我们直接类实例化，然后进行打印：

最终打印的结果如下所示：

打印的时候加上 comment

有的时候我们在打印的时候希望加上一些注释。例如现在有一个类描述链接的状态，有 Open 和 Close 这两种状态：

我们可以对该类注册 pretty printer，同时使用 prettyprinter.comment 可以在打印结果后面加上注释，例如 Status: Open 或是 Status: Close。

最终的结果如下所示，可以看到在打开和关闭情况下，打印会在最后有一个注释：