使用 Python 中的 pydoc 模組生成文件

簡介

pydoc 模組會自動從 Python 模組生成文件。文件可以儲存為控制檯上的文字頁面，顯示在 Web 瀏覽器上，甚至可以儲存為 HTML 檔案。

在本文中，您將學習在各種情況下檢視這些文件的方法，甚至瞭解有助於您為 Python 指令碼建立自己的文件的文件字串。

現在您已經瞭解了 pydoc 的用途，讓我們開始吧。

pydoc 模組與 Python 一起打包，這意味著您無需單獨下載和安裝它。

要訪問 pydoc，您必須首先匯入它。

import pydoc

您可以使用 pydoc 的 help 函式訪問 pydoc 中的互動式 Shell。

為此，啟動您的終端並進入 Python 互動式 Shell。

現在，匯入 pydoc，然後使用 pydoc.help() 命令啟動互動式 Shell。

>>>import pydoc
>>>pydoc.help()

現在，您可以輸入模組、資料型別、函式、類等名稱，以直接從互動式指令碼獲取其文件。

如果您想從瀏覽器檢視文件，可以使用 pydoc 很容易地做到這一點。

這次，您無需透過 Python Shell 執行命令。相反，您可以為它提供引數並直接啟動它。

為此，啟動您的終端並鍵入以下命令。

python −m pydoc −b

這應該會在瀏覽器上生成您本地系統上所有 Python 模組、函式和物件的文件。

您甚至可以透過這種方式搜尋和檢索特定關鍵字。

C:\Users\vijay>python −m pydoc −b
Server ready at https://:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

def documentation():
   '''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)

Documentation using docstrings
Help on function documentation in module __main__:

documentation()
Documentation using docstrings

您現在知道如何使用 pydoc 函式離線檢視和閱讀各種 Python 關鍵字、函式、模組和方法的文件。

您還學習瞭如何使用文件字串生成和建立自己的文件。

在大型專案中工作時，維護良好的文件至關重要，以便了解您在何處做什麼，並在將來避免混淆。它還有助於防止各種未知或執行時錯誤。

S Vijay Balaji

更新於：2021 年 2 月 11 日

7K+ 次瀏覽

透過完成課程獲得認證

開始