pydoc --- 文檔生成器和在線幫助系統?

The pydoc module automatically generates documentation from Python

modules. The documentation can be presented as pages of text on the console,

served to a Web browser, or saved to HTML files.

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

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

pydoc sys

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

注解

為了找到對象及其文檔內容，pydoc 會導入文檔所在的模塊。 因此，任何模塊層級的代碼都將被執行。 請使用 if __name__ == '__main__': 語句來確保一個文件的特定代碼僅在作為腳本被發起調用時執行而不是在被導入時執行。

當打印輸出到控制臺時，pydoc 會嘗試對輸出進行分頁以方便閱讀。 如果設置了 PAGER 環境變量，pydoc 將使用該變量值作為分頁程序。

在參數前指定 -w 旗標將把 HTML 文檔寫入到當前目錄下的一個文件中，而不是在控制臺中顯示文本。

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

你還可以使用 pydoc 在本機上啟動一個 HTTP 服務，這將向來訪的 Web 瀏覽器提供文檔服務。 pydoc -p 1234 將在 1234 端口上啟動 HTTP 服務，允許你在你喜歡的 Web 服務器中通過 http://localhost:1234/ 瀏覽文檔內容。 指定 0 作為端口號將會任意選擇一個未使用的端口。

pydoc -n 將啟動在給定主機名上執行監聽的服務。 默認主機名為 'localhost' 但如果你希望能從其他機器搜索該服務器，你可能會想要改變服務器所響應的主機名。 在開發階段此特性會特別有用，因為這樣你將能在一個容器中運行 pydoc。

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

當 pydoc 生成文檔內容時，它會使用當前環境和路徑來定位模塊。 因此，發起調用 pydoc spam 得到的文檔版本會與你啟動 Python 解釋器并輸入 import spam 時得到的模塊版本完全相同。

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

在 3.2 版更改:添加 -b 選項。

在 3.3 版更改:命令行選項 -g 已經移除。

在 3.7 版更改:添加 -n 選項。

總結

以上是生活随笔為你收集整理的python文档生成工具_pydoc --- 文档生成器和在线帮助系统 — Python 3.9.1rc1 文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。