pydoc --- 文檔生成器和在線幫助系統(tǒng)?

源代碼: Lib/pydoc.py

pydoc 模塊會(huì)根據(jù) Python 模塊來自動(dòng)生成文檔。 生成的文檔可在控制臺(tái)中顯示為文本頁面，提供給 Web 瀏覽器訪問或者保存為 HTML 文件。

對于模塊、類、函數(shù)和方法，顯示的文檔內(nèi)容取自文檔字符串（即 __doc__ 屬性），并會(huì)遞歸地從其帶文檔的成員中獲取。 如果沒有文檔字符串，pydoc 會(huì)嘗試從類、函數(shù)或方法定義上方，或是模塊頂部的注釋行段落獲取 (參見 inspect.getcomments()).

內(nèi)置函數(shù) help() 會(huì)發(fā)起調(diào)用交互式解釋器的在線幫助系統(tǒng)，該系統(tǒng)使用 pydoc 在終端上生成文本形式的文檔內(nèi)容。 同樣的文本文檔也可以在 Python 解釋器以外通過在操作系統(tǒng)的命令提示符下以腳本方式運(yùn)行 pydoc 來查看。 例如，運(yùn)行

pydoc sys

在終端提示符下將通過 sys 模塊顯示文檔內(nèi)容，其樣式類似于 Unix man 命令所顯示的指南頁面。 pydoc 的參數(shù)可以為函數(shù)、模塊、包，或帶點(diǎn)號的對模塊中的類、方法或函數(shù)以及包中的模塊的引用。 如果傳給 pydoc 的參數(shù)像是一個(gè)路徑（即包含所在操作系統(tǒng)的路徑分隔符，例如 Unix 的正斜杠），并且其指向一個(gè)現(xiàn)有的 Python 源文件，則會(huì)為該文件生成文檔內(nèi)容。

當(dāng)打印輸出到控制臺(tái)時(shí)，pydoc 會(huì)嘗試對輸出進(jìn)行分頁以方便閱讀。 如果設(shè)置了 PAGER 環(huán)境變量，pydoc 將使用該變量值作為分頁程序。

在參數(shù)前指定 -w 旗標(biāo)將把 HTML 文檔寫入到當(dāng)前目錄下的一個(gè)文件中，而不是在控制臺(tái)中顯示文本。

在參數(shù)前指定 -k 旗標(biāo)將在全部可用模塊的提要行中搜索參數(shù)所給定的關(guān)鍵字，具體方式同樣類似于 Unix man 命令。 模塊的提要行就是其文檔字符串的第一行。

你還可以使用 pydoc 在本機(jī)上啟動(dòng)一個(gè) HTTP 服務(wù)器并向來訪的 Web 瀏覽器展示文檔。 pydoc -p 1234 將在 1234 端口上啟動(dòng) HTTP 服務(wù)器，允許在你使用 Web 瀏覽器通過 http://localhost:1234/ 來瀏覽文檔內(nèi)容。 指定 0 作為端口號將任意選擇一個(gè)未使用的端口。

pydoc -n <hostname> 將啟動(dòng)在給定主機(jī)名上執(zhí)行監(jiān)聽的服務(wù)。 默認(rèn)主機(jī)名為 'localhost' 但如果你希望能從其他機(jī)器搜索該服務(wù)器，你可能會(huì)想要改變服務(wù)器所響應(yīng)的主機(jī)名。 在開發(fā)階段此特性會(huì)特別有用，因?yàn)檫@樣你將能在一個(gè)容器中運(yùn)行 pydoc。

pydoc -b 將啟動(dòng)服務(wù)并額外打開一個(gè) Web 瀏覽器訪問模塊索引頁。 所發(fā)布的每個(gè)頁面頂端都帶有導(dǎo)航欄，你可以點(diǎn)擊 Get 獲取特定條目的幫助，點(diǎn)擊 Search 在所有模塊的提要行中搜索特定關(guān)鍵詞，或是點(diǎn)擊 Module index, Topics 和 Keywords 前往相應(yīng)的頁面。

當(dāng) pydoc 生成文檔內(nèi)容時(shí)，它會(huì)使用當(dāng)前環(huán)境和路徑來定位模塊。 因此，發(fā)起調(diào)用 pydoc spam 得到的文檔版本會(huì)與你啟動(dòng) Python 解釋器并輸入 import spam 時(shí)得到的模塊版本完全相同。

核心模塊的模塊文檔位置對應(yīng)于 https://docs.python.org/X.Y/library/ 其中 X 和 Y 是 Python 解釋器的主要版本號和小版本號。 這可通過設(shè)置 PYTHONDOCS 環(huán)境變量來重載為指向不同的 URL 或包含 Library Reference Manual 頁面的本地目錄。