如何访问Python包的文档字符串?

时间:2014-08-21 21:59:09

标签: python

假设我有一个包omegaproject我正在从脚本test.py导入:

test.py
omegaproject/
  __init__.py
  omega.py

__init__.py中说出我放了"""Hello there"""而没有别的。

现在,假设test.py包含:

import omegaproject 

print(omegaproject.__doc__)

不应该运行test.py导致Python显示'Hello there'?相反,它什么也没显示。

换句话说,我在哪里指定包的文档字符串?

1 个答案:

答案 0 :(得分:1)

我们称之为“技巧问题”:)

正如Martijn指出的那样,事实上文档字符串确实出现了。

问题在于这一系列事件:

  1. 我原来__init__.py为空。
  2. 然后我跑了test.py,没有打印任何内容。
  3. 然后我修改了__init__.py以获得文档字符串阅读"""Hello there"""
  4. 然后在交互式shell上 我跑了:import omegaproject后跟omegaproject.__doc__
  5. omegaproject已导入!所以第二次导入没有做任何事情,文档字符串没有得到更新,因此文档字符串仍然显示为空白。