Linux下面查看python帮助文档

2024-09-04 22:32

本文主要是介绍Linux下面查看python帮助文档,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

因为python网站被墙,所以在线查看帮助比较困难。好在Linux自身通常都已经带了python的联机帮助,对应的命令是pydoc。


使用方法:

flying-bird@flyingbird:~/examples/python/print_file_type$ pydoc --help
pydoc - the Python documentation toolpydoc <name> ...Show text documentation on something.  <name> may be the name of aPython keyword, topic, function, module, or package, or a dottedreference to a class or function within a module or module in apackage.  If <name> contains a '/', it is used as the path to aPython source file to document. If name is 'keywords', 'topics',or 'modules', a listing of these things is displayed.pydoc -k <keyword>Search for a keyword in the synopsis lines of all available modules.pydoc -p <port>Start an HTTP server on the given port on the local machine.pydoc -gPop up a graphical interface for finding and serving documentation.pydoc -w <name> ...Write out the HTML documentation for a module to a file in the currentdirectory.  If <name> contains a '/', it is treated as a filename; ifit names a directory, documentation is written for all the contents.flying-bird@flyingbird:~/examples/python/print_file_type$  

最简单就是第一种:pydoc <name>,其效果和常用的man一样,可以试下如下两个命令,观察使用效果:

pydoc subprocess
pydoc subprocess.Popen

如果对命令行不习惯,可以用pydoc -g,命令行输入这个命令之后,就会启动GUI窗口,如下:

可以在这个search for中输入关键字,比如subprocess,回车就是下面的样子:

选中某一条目,就打开了对应的帮助页面:



注意到,在执行pydoc -g的时候,已经启动了一个pydoc server,端口号为7464。事实上,在pydoc -g命令后出现的第一次窗口中,选择open browser,可以看到下面的窗口:


另外一种就是pydoc -w <name>,示例如下:

flying-bird@flyingbird:~/examples/python/print_file_type$ ll
total 16
drwxrwxr-x 2 flying-bird flying-bird 4096  6月 18 19:28 ./
drwxrwxr-x 8 flying-bird flying-bird 4096  6月 18 21:01 ../
-rwxrwxr-x 1 flying-bird flying-bird  586  6月 18 19:28 print_file_type.py*
-rwxrwxr-x 1 flying-bird flying-bird  586  6月 18 19:27 print_file_type.py~*
flying-bird@flyingbird:~/examples/python/print_file_type$ pydoc -w subprocess
wrote subprocess.html
flying-bird@flyingbird:~/examples/python/print_file_type$ ll
total 56
drwxrwxr-x 2 flying-bird flying-bird  4096  6月 18 21:17 ./
drwxrwxr-x 8 flying-bird flying-bird  4096  6月 18 21:01 ../
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:28 print_file_type.py*
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:27 print_file_type.py~*
-rw-rw-r-- 1 flying-bird flying-bird 39516  6月 18 21:17 subprocess.html
flying-bird@flyingbird:~/examples/python/print_file_type$ 

可以打开这个文件:



看到这个,就想到用pydoc subprocess > the_doc.html。但效果如下:

flying-bird@flyingbird:~/examples/python/print_file_type$ pydoc -w subprocess
wrote subprocess.html
flying-bird@flyingbird:~/examples/python/print_file_type$ ll
total 56
drwxrwxr-x 2 flying-bird flying-bird  4096  6月 18 21:17 ./
drwxrwxr-x 8 flying-bird flying-bird  4096  6月 18 21:01 ../
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:28 print_file_type.py*
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:27 print_file_type.py~*
-rw-rw-r-- 1 flying-bird flying-bird 39516  6月 18 21:17 subprocess.html
flying-bird@flyingbird:~/examples/python/print_file_type$ pydoc subprocess > the_doc.html
flying-bird@flyingbird:~/examples/python/print_file_type$ ll
total 76
drwxrwxr-x 2 flying-bird flying-bird  4096  6月 18 21:21 ./
drwxrwxr-x 8 flying-bird flying-bird  4096  6月 18 21:01 ../
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:28 print_file_type.py*
-rwxrwxr-x 1 flying-bird flying-bird   586  6月 18 19:27 print_file_type.py~*
-rw-rw-r-- 1 flying-bird flying-bird 39516  6月 18 21:17 subprocess.html
-rw-rw-r-- 1 flying-bird flying-bird 19738  6月 18 21:21 the_doc.html
flying-bird@flyingbird:~/examples/python/print_file_type$ 

然后打开这个重定向的文件是这个样子:


不过到现在也好理解,因为pydoc subprocess出来的是没有HTML语法的文本,自然没有在浏览器中如预期显示。再者,pydoc为了满足用户潜在的重定向功能,直接就提供了-w选项,保存为html文件,非常方便!


这篇关于Linux下面查看python帮助文档的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1137212

相关文章

python: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别: 当你在一个模块(文件)中使用 global 声明变量时,这个变量只在该模块的全局命名空

linux-基础知识3

打包和压缩 zip 安装zip软件包 yum -y install zip unzip 压缩打包命令: zip -q -r -d -u 压缩包文件名 目录和文件名列表 -q:不显示命令执行过程-r:递归处理,打包各级子目录和文件-u:把文件增加/替换到压缩包中-d:从压缩包中删除指定的文件 解压:unzip 压缩包名 打包文件 把压缩包从服务器下载到本地 把压缩包上传到服务器(zip

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

Linux 网络编程 --- 应用层

一、自定义协议和序列化反序列化 代码: 序列化反序列化实现网络版本计算器 二、HTTP协议 1、谈两个简单的预备知识 https://www.baidu.com/ --- 域名 --- 域名解析 --- IP地址 http的端口号为80端口,https的端口号为443 url为统一资源定位符。CSDNhttps://mp.csdn.net/mp_blog/creation/editor

【Python编程】Linux创建虚拟环境并配置与notebook相连接

1.创建 使用 venv 创建虚拟环境。例如,在当前目录下创建一个名为 myenv 的虚拟环境: python3 -m venv myenv 2.激活 激活虚拟环境使其成为当前终端会话的活动环境。运行: source myenv/bin/activate 3.与notebook连接 在虚拟环境中,使用 pip 安装 Jupyter 和 ipykernel: pip instal

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程(Gaussian Process,简称GP)是一种概率模型,用于描述一组随机变量的联合概率分布,其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数(或核函数) 1.3 核函数1.4 高斯过程回归(Gauss

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络(1)sklearn

系列文章目录 监督学习:参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归(SAheart.csv) 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学

Linux_kernel驱动开发11

一、改回nfs方式挂载根文件系统         在产品将要上线之前,需要制作不同类型格式的根文件系统         在产品研发阶段,我们还是需要使用nfs的方式挂载根文件系统         优点:可以直接在上位机中修改文件系统内容,延长EMMC的寿命         【1】重启上位机nfs服务         sudo service nfs-kernel-server resta

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能