Skip to main content
 首页 » 编程设计

python之获取任意脚本文件的Python docstring

2025年02月15日9lyj

我正在编写一个需要调用脚本文档字符串的模块。到目前为止,我已经设法使用

获取了调用脚本的文件名
import inspect 
filename = inspect.stack()[1].filename 

可以使用 __doc__ 在调用脚本中找到文档字符串。然而,从被调用的脚本中获取文档字符串似乎并不简单。当然我可以写一个函数,但这势必会忽略一些不常见的情况。我有办法实际解析调用脚本以找到它的文档字符串(不执行它的代码)吗?

请您参考如下方法:

根据 chaos 关于使用 ast 的建议,我编写了以下内容,看起来效果很好。

import ast 
 
with open(fname, 'r') as f: 
    tree = ast.parse(f.read()) 
docstring = ast.get_docstring(tree)