我怎么知道我可以传递给python函数的参数以及正确的值是什么?

时间:2018-01-19 02:30:05

标签: python arguments

例如,当我使用matplotlib作为plt时,可能的语句如下所示:

plt.plot(X,Y,颜色= '蓝色')

那么我怎样才能得到像'color'这样的参数可以传递给'plot'函数,以及该参数的正确值是什么?

特别是当我使用一些模块时。

感谢您的回答。

1 个答案:

答案 0 :(得分:0)

我对这篇文章遭到贬低感到有些失望,因为我认为这是一个非常合理的问题。特别值得一提的是,我感谢你不是答案是什么,而是 你可以在将来为自己找到它。

探索本地Python文档

Python拥有非常强大的内置文档系统以及非常活跃和支持的社区。在任何时候,您都可以使用help函数来检查您想要了解更多信息的特定对象 - 这将提取该对象的文档。在您的示例中,您可以执行以下操作:

help(plt.plot)

提取matplotlib.pyplot.plot功能的文档。在正在运行的Python进程之外,您可以使用pydoc命令行工具来阅读和浏览相同的文档。类似的东西:

$ pydoc matplotlib.pyplot.plot

在shell中运行它将显示与help命令示例相同的文档。

编写文档

作为Python生态系统的优秀公民,您自然希望记录自己的代码。这很简单,只需在函数,类或模块的顶部添加docstring即可。文档字符串用三重引号"""表示,如下例所示:

"""This module contains some example classes and functions"""

class MyClass(object):
    """MyClass does some things"""
    pass

def my_function(a):
    """Calculates the sum"""
    return(a)

人们更喜欢many different文档样式,因此您选择的内容取决于您。虽然我会推荐official docstring standards outlined in PEP 257

查找在线资源

利用在线文档和资源通常也很有用。 official Python documentation包括标准库的所有内置文档,以及不熟悉Python的开发人员的教程!

由于您自己似乎对这个生态系统比较陌生,所以您可以找到更多有用的资源: