python:__ doc__ doc trings显示为none

时间:2011-08-31 05:44:55

标签: python docstring

我使用python编写了一个相对简单的脚本,并为所有方法编写了doc字符串,如下所示:

def processData(rawData):
    """Proccessing raw data from weather station using Regex to get final sensor readings.

    Args:
        rawData: A string contains all the sensor readings. This string will be processed
                 using regex to remove garbage.

    Returns:
        finalList: A list of final sensor readings."""

但是,当我尝试通过解释器打印doc字符串时,doc字符串打印为“None”

>>> import ws100_weather_data as weather
>>> print weather.__doc__
None

但帮助(天气)显示所有文档字符串以及其他信息。我在这做错了吗?如果是的话,访问doc字符串的正确方法是什么?

谢谢。

2 个答案:

答案 0 :(得分:4)

不同的对象有不同的doc字符串。函数的docstring为processData.__doc__,对于模块weather.__doc__,您没有定义。将其定义为文件顶部全局范围内的裸字符串(未分配)。

答案 1 :(得分:1)

您正在向我们展示一种方法的文档字符串。大概你没有该课程的文档字符串。