python: __doc__ 文档字符串显示为 None

Question

我写了一个比较简单的脚本，使用的是Python，并且为所有的方法都写了文档字符串，内容如下：

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."""

但是，当我试图通过解释器打印这些文档字符串时，结果却显示为“None”。

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

不过，使用help(weather)命令可以显示所有的文档字符串和其他信息。那么我是不是做错了什么？如果是的话，正确的访问文档字符串的方法是什么呢？

谢谢。

Answer 1

你给我们看的是一个方法的文档字符串。可以推测你可能没有这个类的文档字符串。

Answer 2

不同的对象有不同的文档字符串。你函数的文档字符串可以通过 processData.__doc__ 来查看，而模块的文档字符串则是 weather.__doc__，不过你还没有定义这个。你需要在文件的最上面，以一个简单的字符串形式（不赋值）来定义它。