如何阅读Python函数文档

时间:2016-10-29 20:54:23

标签: python python-2.7

我在理解Python中的一些函数描述时遇到了问题。 我理解像os.putenv(varname, value)这样的函数,但我不知道如何使用它:os.getenv(varname[, value])。如何将参数传递给该函数,这些方括号是什么意思?

2 个答案:

答案 0 :(得分:0)

方括号通常表示该值是可选的。这里,varname表示您想要获取的环境变量,value是一个可选值,如果环境变量不存在,则返回该值。

答案 1 :(得分:0)

方括号表示参数是可选。阅读the description

  

返回环境变量 varname 的值(如果存在),或(如果不存在)。 value 默认为None

所以你可以这样称呼它:

os.getenv('NONEXISTANTVAR')

或者像这样:

os.getenv('NONEXISTANTVAR', u'my default')

这首先相当于os.getenv('NONEXISTANTVAR', None)。在getenv的特定情况下,如果环境变量不存在,则返回第二个参数。

通常情况下,文档会告诉您默认值,如果您没有提供默认值,可以在说明中明确说明,也可以直接在签名中放置=somevalue。如果它没有表明具体的值,那么它至少会描述行为的差异。

unicode为我们提供了签名中=的示例:

  

unicode(对象='&#39)

请注意,在Python中,参数是可选的唯一方法是使其具有默认值。