每日一“酷”之pprint

pprint – 美观打印

作用：美观打印数据结构

pprint 包含一个“美观打印机”，用于生成数据结构的一个美观视图。格式化工具会生成数据结构的一些表示，不仅可以由解释器正确地解析，而且便于人类阅读。输出尽可能放在一行上，分解为多行时则需要缩进。

这一节中的列子都用到了pprint_data.py，其中包含一下数据

1 data = [(1,{'a':'A','b':'B','c':'C','d':'D'}),
2         (2,{'e':'E','f':'F','g':'G','h':'H',
3             'i':'I','j':'J','k':'K','l':'L'
4             }),
5         ]

1、  打印

要使用这个模块，最简单的方法就是利用pprint()函数 

1 from pprint import pprint
2 from pprint_data import data
3 
4 print 'PRINT:'
5 print data
6 print 
7 print 'PPRINT:'
8 pprint(data)

运行结果：

pprint()格式化一个对象，并把它写至一个数据流，这个数据流作为参数传入（或者是默认的sys.stdout）

注意为什么第二个字典中会显示一竖列，因为pprint打印支持8个对象以上的竖列打印

 

2、  格式化

格式化一个数据结构而不把它直接写至一个流（例如用于日志记录），可以使用pformat()来构造一个字符串表示。 

 1 import logging
 2 from pprint import pformat
 3 from pprint_data import data
 4 
 5 logging.basicConfig(level = logging.DEBUG,
 6                     format = '%(levelname)-8s %(message)s',
 7                     )
 8 logging.debug('Logging pformatted data')
 9 formatted = pformat(data)
10 for line in formatted.splitlines():
11     logging.debug(line.rstrip())

运行结果：

然后可以单独低打印格式化的字符串或者计入日志

splitlines() 按行分割()

rstrip()去除右边的空格 lstrip()去除左边的空格 strip()去除两边空格。默认为去除空格，也可以传入需要从两边或者其中一边去除的字符，如strip(‘a’)就是去除字符串两边的字符’a’

3、  任意类

如果定制类定义了一个__repr__()方法，pprint()使用的PrettyPrinter类还可以处理这些定制类。

 1 from pprint import pprint 
 2 
 3 class node(object):
 4     def __init__(self,name,contents =[]):
 5         self.name = name
 6         self.contents = contents[:]
 7     def __repr__(self):
 8         return ('node(' + repr(self.name) + ',' +
 9                 repr(self.contents) + ')'
10                 )
11 
12 trees = [node('node-1'),
13          node('node-2',[node('node-2-1')]),
14          node('node-3',[node('node-3-1')]),         
15          ]
16 pprint(trees)

运行结果：

由PrettyPrinter组合嵌套对象的表示，从而返回完整字符串表示。

 4、  递归

递归数据结构有指向原数据源的引用来表示，形式为<Recursion on typename with id=number>。 

1 from pprint import pprint 
2 
3 local_data = ['a','b',1,2]
4 local_data.append(local_data)
5 print 'id(local_data) =>',id(local_data)
6 pprint(local_data)
7 print local_data

运行结果：

在这个例子中，列表local_data增加到了其自身，这会创建一个递归引用

内置函数id()作用是获得对象的id值，理论上讲每个对象都有一个id值，如果是整数和字符串（(相对较小的时候)），那么相同的值会有相同的id值，但是如果是类，及时相同也会有不同的id值。测试如下： 

 1 #int or float or lon 都一样(比较小的时候)
 2 a = 65464131311513l
 3 b = 65464131311513l
 4 c = 65464131311513l
 5 print id(a)
 6 print id(b)
 7 print id(c)
 8 print
 9 a = '12312312'
10 b = '12312312'
11 c = '12312312'
12 print id(a)
13 print id(b)
14 print id(c)
15 print 
16 
17 a = 65464131311513l*11
18 b = 65464131311513l*11
19 c = 65464131311513l*11
20 print id(a)
21 print id(b)
22 print id(c)
23 print
24 a = '12312312'*11
25 b = '12312312'*11
26 c = '12312312'*11
27 print id(a)
28 print id(b)
29 print id(c)
30 print 
31 
32 class Test(object):
33     def __init__(self):
34         pass
35 a = Test()
36 b = Test()
37 c = Test()
38 print id(a)
39 print id(b)
40 print id(c)
41 print

测试结果：

5、  限制嵌套输出

对于非常深的数据结构，可能不要求输出包含所有细节。有可能数据没有是当地格式化，也可能格式化文本过大而无法管理，或者默写数据时多余的。 

 1 from pprint import pprint 
 2 from pprint_data import data
 3 
 4 print 'depth 1 :'
 5 pprint(data,depth=1)
 6 print 
 7 print 'depth 2 :'
 8 pprint(data,depth=2)
 9 print 
10 print 'depth 3 :'
11 pprint(data,depth=3)

运行结果：

使用depth参数可以控制美观打印机递归处理嵌套数据结构的深度。输出中未包含的层次由一个省略号表示 

6、  控制输出宽度

格式化文本的默认输出宽度为80列。要调整这个宽度，可以再pprint()中使用参数width。 

1 from pprint import pprint
2 from pprint_data import data
3 
4 for width in [80,5]:
5     print 'WIDTH = ', width
6     pprint(data,width = width)
7     print 

运行结果：

宽度大小不能适应格式化数据结构时，如果斩断或转行会引入非法的语法，就不会进行截断或转行。