获取python文件的doc字符串

Question

如果我只有文件名，有没有办法获取 python 文件的文档字符串？例如，我有一个名为 a.py 的 python 文件。我知道它有一个文档字符串（之前已强制执行），但不知道其内部结构，即它是否有任何类或主要等？我希望我不会忘记一些很明显的事情 如果我知道它有一个主要功能，我可以通过使用 import 的方式来完成它，

     filename = 'a.py'
     foo = __import__(filename)
     filedescription = inspect.getdoc(foo.main())

我不能只这样做：

     filename.__doc__    #it does not work

Answer 1

你应该做...

foo = __import__('a')
mydocstring = foo.__doc__

或者更简单...

import a
mydocstring = a.__doc__

Answer 2

import ast

filepath = "/tmp/test.py"

file_contents = ""
with open(filepath) as fd:
    file_contents = fd.read()
module = ast.parse(file_contents)
docstring = ast.get_docstring(module)
if docstring is None:
    docstring = ""

print(docstring)

Answer 3

如果您需要您已经所在的模块的文档字符串：

import sys
sys.modules[__name__].__doc__