让你的Python输出更有 B 格
引言
每种编程语言都可以输出。在控制台中打印变量可以被认为是最基本的调试方法,这对 Python 来说更是如此。然而,您是否对输出的格式感到困扰? 例如:
本文介绍的 Pretty Printer 库将为你很好的解决上述问题。
1.基本用法
首先,我们需要导入库,并编写一个示例字典。
import pprint as pp
sample_dict = {
'name': 'Chris',
'age': 33,
'message': 'Thank you for reading my article!',
'topic':'Python Programming'
}
现在,如果我们简单地打印这个字典,所有的内容都会在一行中输出。
print(sample_dict)
好吧,这可能不算太糟,但是如果我们有更多的键值对或者一些值非常长呢?它将很难阅读。现在,让我们来看看 Pretty Printer 库可以做什么。
pp.pprint(sample_dict)
首先,每个键值对都显示在一行中,这样更具可读性。此外,你可能没有注意到,字典是自动按照键名的字母顺序排序。
2. 文本换行
我想大多数 Python 开发人员都知道上面所示的基本用法。但是你是否知道 Pretty Printer 库有更多的参数和标志,可以用来进一步定制输出?
其中一个示例用法是文本换行。假设我们不仅满足于每行有一个键值对,而且还希望在值太长时进行文本换行。在这种情况下,我们可以使用 width 参数。
pp.pprint(sample_dict, width=30)
因此,我们可以使用 width 来约束行的长度,以实现更好的可读性。除此之外,indent 参数还可以在每一行的前面添加缩进。
pp.pprint(sample_dict, width=30, indent=10)
3. 嵌套对象截断
有时候,我们可能不想查看我们打印到输出的所有细节。例如,我们可能希望防止递归打印的内容,或者只是对嵌套对象中更深层次的内容不感兴趣。
假设我们有一个如下所示的嵌套 Python 列表。
sample_list = ['level1', ['level2', ['level3']]]
如果我们使用普通 Pretty Printer ,就不会有什么不同于普通 print 的输出。
pp.pprint(sample_list)
但是,如果我们指定了 depth 参数,任何比参数更深的内容都会被截断。
pp.pprint(sample_list, depth=2)
# OR
pp.pprint(sample_list, depth=1)
4. 实例化 Pretty Printer
到目前为止,这还是相当酷的。但是,每次编写上面演示的代码只是为了打印某些内容,可能会过于冗长。
当你想使用 Pretty Printer 不只一次,而是多次。每次编写带参数的函数也很累。实际上,我们可以用所有必要的参数实例化 Pretty Printer 类。然后,我们可以一次又一次地重复使用它。
PrettyPrinter类位于pprint软件包的根级别。因此,让我们重新导入它。
import pprint
然后,我们可以像下面这样在构造函数中传递参数。
pp = pprint.PrettyPrinter(depth=2)
在此之后,我们得到了具有预定义样式的实例,该样式可以直接使用。
pp.pprint(sample_list)
总结
在本文中,我介绍了 Python 内置的 Pretty Printer 库。当然,我们不必使用它来替换默认的打印函数。我们必须在使用之前导入它,代码将变得冗长。但是,在某些情况下,我们可以使用它来生成更好的可读输出,从而简化编程和调试活动。