标题## 语句与语法:学会python中的_doc_和pydoc——python学习手册笔记之3
光看书不练习很难学好python,光看书不做点学习笔记,恐怕连书本的东西也是半知半解,不知所云。这手册的第三部分草草看完,好像还没有出现多少练的东西,这个笔记3,算是对于这个第三部分的读后复习吧。
阅读中感觉那个导入的函数import很重要,先简略理解一下import,因为它的确有点复杂,也就先做粗略了解,在实践中继续理解。这import之后的sys也是这样,要非常了解它们,你还得有一些非常的经验不可,也是略知再说。
标题一、两个函数:import和sys
函数import是用来导入模块的指令,你要导入math模块,那在python解释器中就使用import math,而你要导入sys模块,你在解释器中照葫芦画瓢,那就打上import sys。
本篇笔记关注sys中的文档字符串资源,所以我们导入的就是sys。
何谓sys呢?这个稍微多一点文字,它大概来自system一词,取其前三个字母sys。我录下python文本中对它的描述:
这个模块提供入口给某些对象,这些对象在解释器中被使用或者维护,同时,它也提供函数以便于解释器深度地交互使用(英文原文:This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpret)。
于是我们就开始在解释器中导入sys,以便进一步理解如何在python中编写文档,以及使用它现成的文档(document)资源,所以本笔记主要复习的是第15章的内容,它的主题就是文档(p444-469),如教材所言,我们接触的只是冰山一角。
标题二、一个有趣的指令:doc
于是我们导入sys:使用import sys
代码
略去有关目录查找对象属性的那一部分,把焦点集中在文档字符串(docstrings)的指令__doc__上面.我们先做导入文本的练习。
第一步:做一个docstrings.py的代码,其中包含用三引号围住的文本符号。
第二步:在python解释器中运行这个代码,使用导入import,把刚才的文件名置入其后。
第三步:使用打印函数。
请看代码
>>> import docstrings
25
that interact strongly to the
Module documentation Words Go Here
>>> print(docstrings.__doc__)
This module provides access to
some objects used or maintained
by the interpreter and to functions
that interact strongly with the interpret
Module documentation Words Go Here
只要是代码中的文本文件都可以用这个_doc_导入进来。第一段是代码中部的文本。后面一段是代码头部的文本,都是用print函数来打印那些想调用的文本。这是自制代码文本的调用,打印,使用的是双下划线的_doc_函数。
这个函数不仅可以用来打印自制文本,还可以用来打印内置文档字