2016-02-02 49 views
-3

在Python中獲取關於特定函數的文檔的最佳方式是什麼?我試圖下載股票價格數據,以便我可以在Spyder IDE中查看它。Python中特定函數的文檔

我感興趣的功能是:

ystockquote.get_historical_prices 

我怎麼知道該功能有多少個輸入需要,它接受的類型的輸入,例如日期格式?

+2

你是否嘗試過使用Python的幫助功能,你需要幫助的功能?您可以在交互模式下使用幫助方法,或者如果您在IDE中運行,則可以打印出結果。 –

+0

對不起,我是新的。我如何使用Python的幫助功能? – jessica

+2

這是一種方法。您只需提供幫助參數,如函數:help(ystockquote.get_historical_prices)。你也可以嘗試谷歌搜索:https://pypi.python.org/pypi/ystockquote –

回答

0

就找到文檔

我懷疑這個問題是超downvoted因爲明顯的答案是look at the documentation。這取決於你的功能來自哪裏,但谷歌搜索通常是一個很好的找到它的方法(我在幾秒鐘內發現類here)。

這也是非常trivialy只檢查源代碼

爲了導入功能,你需要知道的源文件,它來自的;打開該文件:在python中,docstrings are what generate the documentation,可以在函數聲明下的三引號中找到。參數可以從函數簽名中推斷出來,但是因爲python是動態類型的,所以任何類型的「要求」都只是建議。一些好的記錄員也會提供最佳的類型。

雖然「我如何谷歌文檔」不是一個合適的問題,如何動態推斷文檔是更合理的問題。答案是

  1. help功能,內置在here
  2. 文件__doc__任何Python對象的訪問,作爲一個字符串
  3. 使用inspection

的問題是更如果你正在使用python擴展,比如來自外部軟件包,這是合理的。如果你特別詢問的軟件包有這些內容,我不會這樣做,但如果作者沒有在模塊中定義文檔,他們可能會非常棘手。問題是,在這些情況下,的打字可以嚴格強制。在這種情況下,沒有很好的方法來獲得tpye要求,如inspection will fail。但是,如果你可以獲得源代碼,(可能通過谷歌搜索),this is where the documentation would be provided