python库帮助文档

‘壹’ python 帮助文档 怎么使用

1. python帮助文档是chm格式的（即英语“Compiled Help Manual”的简写，即“已编译的帮助文件”。）

2. CHM是微软新一代的帮助文件格式，利用HTML作源文，把帮助内容以类似数据库的形式编译储存。

   python帮助文档在python安装目录的doc文件夹下，双击即可打开。

   
   

   

   
   

‘贰’ 怎样查找python标准库和第三方库中函数的说明

第一种方法：
>>> import numpy
>>> help(numpy.array)
第二种方法：查官方文档

‘叁’ Python Word文档处理 上篇：python-docx

某天我收到一个需求：希望能够用python对word文档进行一些处理，比如更换一些文字以及添加批注。

简单搜索后，我发现 python-docx 是一个处理docx文档的常用python库，因此我打算用它来进行进一步开发。

官方文档 提供了一个简单的示例

python-docx 将文档抽象为document对象、paragraph对象以及run对象，提供了围绕这些对象进行简单处理的API

然而在文档中并没有出现关于批注操作的部分，我在搜寻 一些文章 后发现了在某个 issue 中提及了添加批注相关信息，然而还是没有得到具体的解决办法

docx文档底层是由XML文件组成的

我们可以将一个 xx.docx 文件的后缀名改为 .rar 然后将其手动解压，可以得到下面这些文件

在诸多文件当中主要用到的是 document.xml 文件，这里保存了文档的内容

打开一份 document.xml 文件，抛开header、footer、table以及其他特殊项，去掉样式等修饰项，一份朴素的docx文档主要可以分为三个部分：paragraph、run、text

paragraph即段落，就是我们在word当中看到的一段。text即文本，就是真实的内容。run比较抽象，我们可以将其理解为片段，即语句的切分。

为了更好地理解run是什么，打开一篇word文档定位其中一句话

让我们看看这篇文档解压之后的 document.xml 文件中对应的部分

OK，我们可以看到原本完整的一句话在word中被拆分成了许多个 <w:r> 标签，这就是 run ，word切分 run 的规则很多，有的根据标点符号，有的根据中文分词，句子中如果存在不同样式的字词也会单独切分出来，因此我们很难预估一句话究竟会被分成几个片段。

在issue中搜索comment关键字发现在一个 merge request 上已经给出了添加批注的解决方案，可以通过 paragraph 对象上的 add_comment 方法给一个段落添加批注

但这还是不符合我的需求，我的目标是精准添加到某个词或者短语上

打开 这个贡献者的源码 进行研究

其实就是在P标签内插入comment标签引用，同时添加comment标签到xx文件

同理我们可以在r标签内插入comment标签引用，同时添加comment标签到xx文件，这样就能实现给特定词添加批注的需求了

‘肆’ 我想学Python，请教几个问题

既然你想学，或者是说喜欢，总觉着给你些意见，并不是为了要分。

python现在主要分为python2, python3，这两者差别大。通常都建议你学习python2。下载2.7的最新包就可以了。

入门教程不要多。有一个就可以。python的入门很容易。如果你有基础就下狠功夫。看完入门教程也基本会了后要从两个方面入手。
第一是将python的基本库看一遍。它自带的那个帮助文档就可以。自己喜欢哪个库就看哪个，大概的都要看一遍
第二就是找一些有趣的程序，拿来学习一下。这方面例子相当多。只要有应用的地方往往都有python的身影。不管是运维测试工具，还是互联网，游戏，科学计算，还是极客手段都有很多例子。

以后学习主要还是靠自己练习，尝试再加上学习别人的代码。python的库大部分都是开源的。如果没有帮助直接去看代码。而且往往都自带测试用例。测试驱动开发是python的典型开发模式。

尽量一开始就用严格的编程规范。不要随意写程序。这样你会受益更多。可以坚持严谨的设计规范。

DRY要用一下。什么时候用OO什么时候用结构化编程也要多想一想。不要盲目。

‘伍’ 如何查看python库函数的代码

python 所有版本的源代码可以在这里下载到：

https://www.python.org/downloads/source/

python没有像matlab那样的函数可以直接查看某个函数的源代码，只有去下载整个源代码查看了，不过找起来应该也不难，另外你也可以写一个小程序来查看对应函数的源代码。

Python的函数调用方式是通过import来调用的对应的py文件。

库函数有内建函数build_in（会写python的时候已经可以不用看了，不会写的时候看也看不懂），和通过pip直接下载或者github上下载再安装的函数。本质上都是py文件。后者有时候由于环境的不同需要自行修改（这种情况较少），一般在安装路径下"Libsite-packages"文件夹中存在。

学习库函数最好的方法是看网上官方的帮助文档，此外还可以通过python自带的dir()方法查看所有的属性和方法，或者用help()方法查看帮助文档（部分别人造的轮子不一定有）。
另外推荐使用ipython，Python创始人之一的成员编写的交互式系统。

‘陆’ python如何查看库的说明

第一步，获取本地帮助文档的路径

打开终端，输入python -m pydoc -p 0，此时它会返回pydoc server ready at http://localhost:port/的信息。