Python输出帮助文档的方法及命令详解

文章目录

• 写在前面
• 命令与详解
• 一些其他用途

写在前面

最近学习Python，发现帮助文档在控制台一页一页翻起来不是很方便，于是试着把帮助文档直接输出并保存为文件，但是发现使用以前的方法

import sys

with open('Tutorial.txt', 'w') as f:
    f.write(help(sys))

并不能实现，原因是help(sys)是一个None对象，而非文档中的字符串。经过一番学习和了解后，我找到了答案。原来是要调用sys系统库中的sys.stdout对象，这个对象其实是print函数调用的一个方法，也即：print('Hello World!')与sys.stdout.write('Hello World!\n')是等价的。

命令与详解

将下面的代码保存为save_Tutorial.py文件（如果在终端运行会报错），然后运行，即可在同目录下生成帮助文档的文本文件。

import sys
import turtle

# 定义待写入的文件（以写入方式打开）
f = open('turtle库帮助文档.txt','w')
# 将文件定向到控制台
sys.stdout = f
# 读取帮助文档
help(turtle)
# 调用`.close()`方法关闭控制台（也可以不加这行）
sys.stdout.close()

一些其他用途

这个方法也可以用于保存控制台的输出，方法只需要将输出的语句放在help(turtle)语句的位置即可。