查找文檔

Question

如果您運行下面的代碼：

from flask import Flask 
import unittest 

dir(Flask(__name__).test_client()) 

以下是輸出端子：

有許多名稱返回我無法找到文檔（所有不包含雙下劃線的名稱）。

我發現間接引用後here（如果你搜索'self.app.post'你會看到它引用）。注意：此鏈接描述使用.post與以下關鍵字：data和follow_redirects。它沒有提到你也可以使用關鍵字content_type和headers。也許這些關鍵字選項對我而言並不直觀明顯的唯一原因是因爲我對此很陌生...

有沒有人知道這些名稱的文檔駐留在哪裏？ （我無法在flask/python/unittest文檔中的任何地方找到它 - 也許我在錯誤的地方找到它？）

編輯：在答案的幫助下，我找到了this文檔。

Answer 1

您可以隨時檢查方法的文檔字符串 - 開發人員在編寫代碼時留下的註釋。您可以檢查任何需要的對象或方法。例如：

Flask.__doc__ 
unittest.__doc__ 
dir.__doc__ 
dir.__doc__.__doc__ 

您還可以查詢

Flask(__name__).test_client().post.__doc__ 
Flask(__name__).test_client().preserve_context.__doc__ 

但是你會發現，並不是所有的方法將被記錄在案。例如：

Flask(__name__).test_client().open.__doc__ 

有關詳情，您還可以看到http://legacy.python.org/dev/peps/pep-0257/

Answer 2

對於任何Python模塊，類方法（所有這些在Python是object確實），您可以查看doc通過：

>>> a_module.__doc__ 
>>> a_class.__doc__ 
>>> a_method.__doc__ 

要查看更詳細的文檔，可以使用help命令：

>>> help(a_method)