Python中特定函数的文档

Question

在Python中获取有关特定函数的文档的最佳方法是什么？我正在尝试下载股票价格数据，以便我可以在我的Spyder IDE中查看它。

我感兴趣的功能是：

ystockquote.get_historical_prices

我如何知道该函数需要多少输入，它接受的输入类型以及日期格式？

Answer 1

只是找到文档

我怀疑这个问题是超级投票的，因为明显的答案是look at the documentation。这取决于你的功能来自哪里，但谷歌搜索通常是找到它的好方法（我在几秒钟的谷歌搜索中找到了班级here。）

检查源代码

也非常琐碎

要导入函数，您需要知道源文件的来源;打开该文件：在python中，docstrings are what generate the documentation，可以在函数声明下面的三引号中找到。参数可以从函数签名中推断出来，但因为python是动态类型的，所以任何类型的“需求”都只是建议。一些优秀的文档也会提供最佳类型。

虽然“我如何google for documentation”不是一个合适的问题，但如何动态推断文档的问题更合理。答案是

1. help功能，内置于here
2. 任何python对象都可以访问的文件__doc__，作为字符串
3. 使用inspection

如果你正在使用python扩展，那么问题就更合理了，比如来自外部包。如果您明确询问的包中有任何一个，我不会这样做，但如果作者没有在模块中定义文档字符串，那么它们可能很难处理。问题是在这些情况下，输入可以严格强制。在这种情况下，没有很好的方法来获得tpye要求，如inspection will fail。但是，如果您可以获得源代码（可能通过谷歌搜索），this is where the documentation would be provided