6.2　自带电池

“Python自带‘电池’”，听说过这种说法吗？

在Python被安装的时候，就有不少模块也随着安装到本地的计算机上了。这些东西就如同“能源”、“电力”一样，让Python拥有了无限生机，能够非常轻而易举地免费使用很多模块。所以，称之为“自带电池”。

那些在安装Python时就默认已经安装好的模块被称为“标准库”。

熟悉标准库是编程之必须。

6.2.1　引用方式

所有模块都服从下述引用方式，是最基本的、也是最常用的，还是可读性非常好的：

  1. import modulename

例如：

  1. >>> import pprint
  2. >>> a = {"lang":"python", "book":"www.itdiffer.com", "teacher":"qiwsir", "goal":"from beginner to master"}
  3. >>> pprint.pprint(a)
  4. {'book': 'www.itdiffer.com',
  5.  'goal': 'from beginner to master',
  6.  'lang': 'python',
  7.  'teacher': 'qiwsir'}

在对模块进行说明的过程中，以标准库pprint为例。

以pprint.pprint()的方式使用模块中的一种方法，这种方法能够让字典格式化输出。看看结果是不是比原来更容易阅读了呢？

在import后面，理论上可以跟好多模块名称，但是在实践中，还是建议大家一次跟一个名称，太多了看着头晕眼花，不容易阅读。

这是用import pprint的样式引入，并以点号“.”（英文半角）的形式引用其方法。

还有下面的方式：

  1. >>> from pprint import pprint

意思是从pprint模块中只将pprint()引入，之后就可以直接使用它了。

  1. >>> pprint(a)
  2. {'book': 'www.itdiffer.com',
  3.  'goal': 'from beginner to master',
  4.  'lang': 'python',
  5.  'teacher': 'qiwsir'}

再懒惰一些，可以：

  1. >>> from pprint import *

将pprint模块中的一切都引入了，于是可以像上面那样直接使用每个函数。但是，这样造成的结果是可读性不是很好，并且，不管是不是用得到，都拿过来，是不是太贪婪了？贪婪的结果是内存会消耗不少。所以，这种方法可以用于常用的并且模块属性或方法不是很多的情况，莫贪婪。

诚然，如果很明确使用模块中的哪些方法或属性，那么使用类似from modulename import name1，name2，name3…也未尝不可。需要再次提醒的是不能因为引入了模块而降低了可读性，让别人不知道呈现在眼前的方法是从何而来。

有时候引入的模块或者方法名称有点长，可以给它重命名。如：

  1. >>> import pprint as pr
  2. >>> pr.pprint(a)
  3. {'book': 'www.itdiffer.com',
  4.  'goal': 'from beginner to master',
  5.  'lang': 'python',
  6.  'teacher': 'qiwsir'}

当然，还可以这样：

  1. >>> from pprint import pprint as pt
  2. >>> pt(a)
  3. {'book': 'www.itdiffer.com',
  4.  'goal': 'from beginner to master',
  5.  'lang': 'python',
  6.  'teacher': 'qiwsir'}

但是不管怎么样，一定要让人看懂，且要过了若干时间，自己也还能看懂。记住：软件很多时候是给人看的，只是偶尔让机器执行。

6.2.2　深入探究

继续以pprint为例，深入研究：

  1. >>> import pprint
  2. >>> dir(pprint)
  3. ['PrettyPrinter', '_StringIO', '__all__', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '_commajoin', '_id', '_len', '_perfcheck', '_recursion', '_safe_repr', '_sorted', '_sys', '_type', 'isreadable', 'isrecursive', 'pformat', 'pprint', 'saferepr', 'warnings']

对dir()并不陌生。从结果中可以看到pprint的属性和方法。其中有不少是以双画线、单画线开头的。但为了不影响我们的视觉，先把它们去掉。

  1. >>> [ m for m in dir(pprint) if not m.startswith('_') ]
  2. ['PrettyPrinter', 'isreadable', 'isrecursive', 'pformat', 'pprint', 'saferepr', 'warnings']

针对这几个，为了能够搞清楚它们的含义，可以使用help()，比如：

  1. >>> help(isreadable)
  2. Traceback (most recent call last):
  3.   File "<stdin>", line 1, in <module>
  4. NameError: name 'isreadable' is not defined

这样做是错误的，知道错在何处吗？

  1. >>> help(pprint.isreadable)

前面是用import pprint方式引入模块的：

  1. Help on function isreadable in module pprint:
  2. isreadable(object)
  3.     Determine if saferepr(object) is readable by eval().

通过帮助信息，能够查看到该方法的详细说明。可以用这种方法一个一个地查过来，对每个方法都熟悉一些。

注意pprint.PrettyPrinter是一个类，后面的是函数（方法）。

再回头看看dir（pprint）的结果：

  1. >>> pprint.__all__
  2. ['pprint', 'pformat', 'isreadable', 'isrecursive', 'saferepr', 'PrettyPrinter']

这个结果是不是眼熟？除了"warnings"，跟前面通过列表解析式得到的结果一样。

其实，当我们使用from pprint import*的时候，就是将all里面的方法引入，如果没有这个，就会将其他所有属性、方法等引入，包括那些以双画线或者单画线开头的变量、函数，事实上这些东西很少在引入模块时被使用。

6.2.3　帮助、文档和源码

你能记住每个模块的属性和方面吗？比如前面刚刚查询过的pprint模块中的属性和方法，现在能背诵出来吗？我的记忆力不行，都记不住。所以，我非常喜欢使用dir()和help()，这也是本书从开始到现在，乃至到以后，总在提倡的方式。

  1. >>> print pprint.__doc__
  2. Support to pretty-print lists, tuples, & dictionaries recursively.
  3.  
  4. Very simple, but useful, especially in debugging data structures.
  5.  
  6. Classes
  7. -------
  8.  
  9. PrettyPrinter()
  10.     Handle pretty-printing operations onto a stream using a configured
  11.     set of formatting parameters.
  12.  
  13. Functions
  14. ---------
  15.  
  16. pformat()
  17.     Format a Python object into a pretty-printed representation.
  18.  
  19. pprint()
  20.     Pretty-print a Python object to a stream [default is sys.stdout].
  21.  
  22. saferepr()
  23.     Generate a 'standard' repr()-like value, but protect against recursive
  24.     data structures.

pprint.doc是查看整个类的文档，还知道整个文档写在什么地方吗？

还是使用pm.py那个文件，增加如下内容：

  1. #!/usr/bin/env python
  2. # coding=utf-8
  3.  
  4. """                                          #增加的
  5. This is a document of the python module.     #增加的
  6. """                                          #增加的
  7.  
  8. def lang():
  9.     ...                                      #省略了，后面的也省略了

在这个文件的开始部分，在所有类、方法和import之前，写一个用三个引号包括的字符串，这就是文档。

  1. >>> import sys
  2. >>> sys.path.append("~/Documents/VBS/StarterLearningPython/2code")
  3. >>> import pm
  4. >>> print pm.__doc__
  5.  
  6. This is a document of the python module.

这就是撰写模块文档的方法，即在.py文件的最开始写相应的内容，这个要求应该成为开发者的习惯。

对于Python的标准库和第三方模块，不仅可以看帮助信息和文档，还能够查看源码，因为它是开放的。

还是回头到dir（pprint）中找一找，有一个file，它就告诉我们这个模块的位置：

  1. >>> print pprint.__file__
  2. /usr/lib/python2.7/pprint.pyc

我是在Ubuntu中操作，读者要注意观察自己的操作系统结果。

虽然是.pyc文件，但是不用担心，根据显示的目录，找到相应的.py文件即可。

  1. $ ls /usr/lib/python2.7/pp*
  2. /usr/lib/python2.7/pprint.py  /usr/lib/python2.7/pprint.pyc

果然有一个pprint.py，打开它，就看到源码了。

  1. $ cat /usr/lib/python2.7/pprint.py
  2.  
  3. ...
  4.  
  5. """Support to pretty-print lists, tuples, & dictionaries recursively.
  6.  
  7. Very simple, but useful, especially in debugging data structures.
  8.  
  9. Classes
  10. -------
  11.  
  12. PrettyPrinter()
  13.     Handle pretty-printing operations onto a stream using a configured
  14.     set of formatting parameters.
  15.  
  16. Functions
  17. ---------
  18.  
  19. pformat()
  20.     Format a Python object into a pretty-printed representation.
  21.  
  22. ....
  23. """

我只查抄了文档中的部分信息，是不是跟前面通过doc查看的结果一样呢？

请读者在闲暇时间阅读源码。事实证明，这种标准库中的源码是质量最好的。阅读高质量的代码，是提高编程水平的途径之一。