替代python文档

时间:2014-07-05 07:50:03

标签: python

当我需要的时候,我一直在检查docs.python,这是正确使用的网站吗?我来自java,而docs.python看起来更像是一个教程网站,而不是一个文档站点。

例如,当我在java api参考中查找一个类时,一目了然我知道它的所有返回类型,方法名称和参数,非常简单,非常有效的网站。使用docs.python我必须阅读所有方法描述,如果我想找到一个返回X的方法...他们没有所有方法的简短列表,没有描述,方法描述甚至不告诉你什么是例外被提出......必须有一个更好的网站。

我一直在玩python,我喜欢它不那么膨胀的方式,更多的伎俩,但是无法快速查看的东西正在杀死我,阅读完整页面的大多数无用的信息正在插入我的思路。

EDIT Downvoters,我真的想在这里使用这种语言,所以...如果你认为我做错了并且有任何建议......也许可以解释你是如何滚动的,因为我用谷歌搜索,狂欢,yandex'd duckduckgo'd发现没有好的建议,你不能使用docs.python ...确定我可以使用dir()help()和doc.python的组合,但这超出了一个笑话。

EDIT 好的,我还有很多需要学习的地方,也许当我学习python的时候会更好一些,我会理解为什么文档就像它们一样,我想我应该感到高兴,即使是文档:P

感谢输入人员

3 个答案:

答案 0 :(得分:4)

docs.python.org是Python语言和库的权威参考。

但是,如果您只想要模块或类中的方法列表,则可以使用内置的dir()help()函数:

>>> import string

>>> dir(string)
['Formatter', 'Template', '_TemplateMetaclass', '__builtins__', '__doc__', '__file__',
'__name__', '__package__', '_float', '_idmap', '_idmapL', '_int', '_long',
'_multimap', '_re', 'ascii_letters', 'ascii_lowercase', 'ascii_uppercase', 'atof',
'atof_error', 'atoi', 'atoi_error', 'atol', 'atol_error', 'capitalize', 'capwords',
'center', 'count', 'digits', 'expandtabs', 'find', 'hexdigits', 'index',
'index_error', 'join', 'joinfields', 'letters', 'ljust', 'lower', 'lowercase',
'lstrip', 'maketrans', 'octdigits', 'printable', 'punctuation', 'replace', 'rfind',
'rindex', 'rjust', 'rsplit', 'rstrip', 'split', 'splitfields', 'strip', 'swapcase',
'translate', 'upper', 'uppercase', 'whitespace', 'zfill']

>>> help(string.upper)
Help on function upper in module string:

upper(s)
    upper(s) -> string

    Return a copy of the string s converted to uppercase.

答案 1 :(得分:2)

你可以使用内省。以下是最重要的(无论如何):

  • dir(object)返回对象的所有方法和属性。

  • module.__doc__应该返回模块的文档字符串

  • type(object)返回对象类型

  • help(object)也可能有用

答案 2 :(得分:1)

使用IPython进行开发时,由于tab-completion和用于调用foo?以显示函数/方法/对象/的简便help(foo)简写,内省变得更加容易。 .docstring即时。典型的会话可能看起来有点像:

In [1]: import pandas as pd

In [2]: pd.Da<Tab>
pd.DataFrame     pd.DateOffset    pd.DateRange     pd.DatetimeIndex
In [3]: pd.DataFrame?
Type:       type
String Form:<class 'pandas.core.frame.DataFrame'>
File:       c:\python27\lib\site-packages\pandas\core\frame.py
Docstring:
Two-dimensional size-mutable, potentially heterogeneous tabular data
[...]