如何在不导入的情况下从 python 文件中获取类和函数的列表

Question

我有一个 python 文件，其中定义了一些类和函数：

class A(object):
    def __init__(self, an_arg, a_default_arg=None):
        pass

def doStuff(an_other_arg, an_other_default_arg=None):
    pass

我想得到这个文件中所有类和函数的列表。 （他们的名字和参数定义就够了）

现在，我知道您可以使用__import__(module_descriptor)和inspect来执行此操作，但这不是一个选项，因为我正在扫描的文件来自不受信任的来源。

我的第一反应是尝试创建一个安全的环境来导入它们，但根据其他 stackoverflow 问题，这似乎是不可能的。

Answer 1

您可以使用ast模块来解析源文件，而无需实际执行任何代码。 然后您可以遍历节点树以获取函数和类名称/参数。

import ast

def show_info(functionNode):
    print("Function name:", functionNode.name)
    print("Args:")
    for arg in functionNode.args.args:
        #import pdb; pdb.set_trace()
        print("\tParameter name:", arg.arg)


filename = "untrusted.py"
with open(filename) as file:
    node = ast.parse(file.read())

functions = [n for n in node.body if isinstance(n, ast.FunctionDef)]
classes = [n for n in node.body if isinstance(n, ast.ClassDef)]

for function in functions:
    show_info(function)

for class_ in classes:
    print("Class name:", class_.name)
    methods = [n for n in class_.body if isinstance(n, ast.FunctionDef)]
    for method in methods:
        show_info(method)

结果：

Function name: doStuff
Args:
        Parameter name: an_other_arg
        Parameter name: an_other_default_arg
Class name: A
Function name: __init__
Args:
        Parameter name: self
        Parameter name: an_arg
        Parameter name: a_default_arg

Answer 2

除了实际执行文件之外，没有什么可以为您提供对这个问题的 100% 准确答案。 Python 中有太多方法可以动态影响命名空间：从别处导入名称、有条件地执行定义、通过修改__dict__直接操作命名空间等。

如果您只能接受静态定义，那么 Python 的内置ast （抽象语法树）模块可能是最简单的解决方案。 您可以安全地将文件编译为 AST，然后在其顶层查找def和class语句。 （在类的情况下，您将在类主体中寻找def __init__ 。不要忘记类没有自己的__init__ ，而只是从超类继承一个的可能性！）

Answer 3

接受的解决方案是不完整的。 考虑以下文件：

def regular_function():
    def nested_function():
        pass

async def async_function():
    pass

接受的解决方案只会打印：

Function name: regular_function
Args:

要获取所有功能，我们需要进行两个更改：

1. 遍历整个 AST，而不仅仅是顶级节点
2. 处理async函数和常规函数

这是更正后的代码，用于查找函数：

import ast

from pathlib import Path

parsed_ast = ast.parse(Path(__file__).read_text())

functions = [
    node
    for node in ast.walk(parsed_ast)
    if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))
]

for function in functions:
    print(f"Function name: {function.name}")
    print(f"Args: {', '.join([arg.arg for arg in function.args.args])}")

请注意，这违反了 AST walk 的用途。 对于更复杂的事情，请考虑使用NodeVisitor