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

相关文章

新特性抢先看! Ubuntu 25.04 Beta 发布:Linux 6.14 内核

《新特性抢先看!Ubuntu25.04Beta发布:Linux6.14内核》Canonical公司近日发布了Ubuntu25.04Beta版,这一版本被赋予了一个活泼的代号——“Plu... Canonical 昨日(3 月 27 日)放出了 Beta 版 Ubuntu 25.04 系统镜像,代号“Pluc

Python 中的异步与同步深度解析(实践记录)

《Python中的异步与同步深度解析(实践记录)》在Python编程世界里,异步和同步的概念是理解程序执行流程和性能优化的关键,这篇文章将带你深入了解它们的差异,以及阻塞和非阻塞的特性,同时通过实际... 目录python中的异步与同步:深度解析与实践异步与同步的定义异步同步阻塞与非阻塞的概念阻塞非阻塞同步

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash?1.1

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

Python下载Pandas包的步骤

《Python下载Pandas包的步骤》:本文主要介绍Python下载Pandas包的步骤,在python中安装pandas库,我采取的方法是用PIP的方法在Python目标位置进行安装,本文给大... 目录安装步骤1、首先找到我们安装python的目录2、使用命令行到Python安装目录下3、我们回到Py

Python GUI框架中的PyQt详解

《PythonGUI框架中的PyQt详解》PyQt是Python语言中最强大且广泛应用的GUI框架之一,基于Qt库的Python绑定实现,本文将深入解析PyQt的核心模块,并通过代码示例展示其应用场... 目录一、PyQt核心模块概览二、核心模块详解与示例1. QtCore - 核心基础模块2. QtWid

Python实现自动化接收与处理手机验证码

《Python实现自动化接收与处理手机验证码》在移动互联网时代,短信验证码已成为身份验证、账号注册等环节的重要安全手段,本文将介绍如何利用Python实现验证码的自动接收,识别与转发,需要的可以参考下... 目录引言一、准备工作1.1 硬件与软件需求1.2 环境配置二、核心功能实现2.1 短信监听与获取2.

使用Python实现获取网页指定内容

《使用Python实现获取网页指定内容》在当今互联网时代,网页数据抓取是一项非常重要的技能,本文将带你从零开始学习如何使用Python获取网页中的指定内容,希望对大家有所帮助... 目录引言1. 网页抓取的基本概念2. python中的网页抓取库3. 安装必要的库4. 发送HTTP请求并获取网页内容5. 解

mysql如何查看当前连接数

《mysql如何查看当前连接数》:本文主要介绍mysql如何查看当前连接数问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录mysql查看当前连接数查看mysql数据库允许最大连接数总结mysql查看当前连接数查看当前连接数SHOW STATUS LIKE

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark