时间戳

首页 > 解决方案 > 如何使用 ast 列出函数的参数？

python - 如何使用 ast 列出函数的参数？

问题描述

我正在使用 ast 模块来解析 Python 模块中的文档字符串，以将我们的文档转换为读取文档格式。我正在使用以下内容将函数名称和文档字符串放入字典列表中，我的其余代码可以很好地使用这些字典。我也在寻找一些东西来获取函数的参数：

good_file = (file for file in os.listdir() if file[-3:] == '.py' and file != '__init__.py')

functions = []

for file in good_file:
     with open(file, 'r') as f:
         module = ast.parse(f.read())

     for node in module.body:
         if isinstance(node, ast.FunctionDef):
         entry = {"docs": ast.get_docstring(node), "fn_name": node.name, "params": ???}

         functions.append(entry)

我正在寻找可以用来将函数的参数填充到字典中的内容。谢谢！

标签： pythonabstract-syntax-tree

解决方案

文档的Abstract Grammar部分ast告诉您在哪里可以找到FunctionDef节点中的参数定义：

stmt = FunctionDef(identifier name, arguments args,
                   stmt* body, expr* decorator_list, expr? returns)

参数中是一系列type name条目；名称成为节点上的属性。文档中进一步介绍了这些类型（顶部列出了几个“内置”类型，反映为 Python 字符串和整数）。后面的类型*是序列（列表），问号表示它们可以设置为None。

所以每个FunctionDef节点都有、name、args和body属性。该属性是一个新节点，类型为，也记录在案：decorator_listreturnsargsarguments

arguments = (arg* args, arg? vararg, arg* kwonlyargs, expr* kw_defaults,
             arg? kwarg, expr* defaults)

参数列表也是如此FunctionDef.args.args，每个参数都是一个arg对象，等等。

arg记录为

arg = (identifier arg, expr? annotation)
       attributes (int lineno, int col_offset)

whereidentifier是一个内置类型，所以这里只是一个字符串。

您可能想查看ast.dump()函数，它可以让您快速了解 AST 节点：

>>> source = """def foo(bar, baz=None, *args, **kwargs): pass"""
>>> module = ast.parse(source)
>>> ast.dump(module)
"Module(body=[FunctionDef(name='foo', args=arguments(args=[arg(arg='bar', annotation=None), arg(arg='baz', annotation=None)], vararg=arg(arg='args', annotation=None), kwonlyargs=[], kw_defaults=[], kwarg=arg(arg='kwargs', annotation=None), defaults=[NameConstant(value=None)]), body=[Pass()], decorator_list=[], returns=None)])"

然后，您可以从那里探索并进一步“转储”信息以获取您需要的实际数据：

>>> function = module.body[0]
>>> ast.dump(function.args)
"arguments(args=[arg(arg='bar', annotation=None), arg(arg='baz', annotation=None)], vararg=arg(arg='args', annotation=None), kwonlyargs=[], kw_defaults=[], kwarg=arg(arg='kwargs', annotation=None), defaults=[NameConstant(value=None)])"
>>> function.args.args
[<_ast.arg object at 0x109852fd0>, <_ast.arg object at 0x109852ef0>]
>>> [a.arg for a in function.args.args]
['bar', 'baz']

args默认值附加到orkw_args序列中的姓氏（ defaultsfor args，kw_defaultsfor kwonlyargs）；附加到args或中的最后 N 个名称的 N 个默认值列表kwosnlyargs。任何包罗万象的名称（*args在**kwargs我的示例中）都单独列出。

推荐阅读