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

问题描述

我有一个包含一些定义的类和函数的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执行此操作，但这不是一个选项，因为我正在扫描的文件来自不受信任的来源。

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

---

解决方案

您可以使用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("	Parameter 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