如何抓python函数

要抓取Python函数，可以使用inspect模块、ast模块、以及编写自定义装饰器。其中，inspect模块用于检查函数的属性和源代码，ast模块可以解析Python源代码并提取函数定义，自定义装饰器则能动态捕获函数执行时的信息。inspect模块提供了一系列工具来获取函数的元数据，如函数名、参数、文档字符串等；ast模块能够解析Python代码字符串，生成抽象语法树，从而提取函数节点；自定义装饰器可以在函数被调用时抓取其输入输出。

为了详细说明如何使用inspect模块，我们可以从以下几个方面展开：首先，通过inspect.getmembers()函数可以列出模块中所有的函数。这个函数返回一个包含所有对象名称和对象的元组列表，可以通过过滤来获取所有函数。其次，inspect.getsource()可以用于获取函数的源代码，这对于理解函数的实现细节非常有用。此外，inspect.signature()提供了获取函数签名的能力，可以用于获得函数的参数信息。这些工具组合使用，可以帮助我们全面地抓取Python函数。

一、使用`inspect`模块抓取Python函数

Python的inspect模块提供了丰富的工具来动态获取对象的各种信息，包括模块、类、方法、函数、回溯、帧对象和代码对象等。它是分析Python程序的强大工具。

1. `inspect.getmembers()`

inspect.getmembers()函数是一个非常强大的函数，它可以列出对象的所有成员。对于模块来说，它能够列出模块中的所有对象，包括函数、类、变量等。通过过滤这些对象，我们可以提取出所有的函数。

import inspect
import my_module  # 假设你要分析的模块名为 my_module
获取模块中所有的函数
functions_list = [o for o in inspect.getmembers(my_module) if inspect.isfunction(o[1])]
for name, func in functions_list:
    print(f"Function name: {name}, Function object: {func}")

2. `inspect.getsource()`

要查看函数的源代码，inspect.getsource()是一个方便的工具。它接受一个函数对象并返回其源代码字符串。

import inspect
def sample_function(x, y):
    """This is a sample function"""
    return x + y
获取函数的源代码
source_code = inspect.getsource(sample_function)
print(source_code)

3. `inspect.signature()`

inspect.signature()用于获取函数的签名信息，它返回一个Signature对象，这个对象包含所有参数的信息。通过这个对象，我们可以查看函数的参数名称、默认值以及注解。

import inspect
def another_function(a, b=10):
    return a * b
获取函数的签名
sig = inspect.signature(another_function)
print(sig)
查看每个参数的信息
for param in sig.parameters.values():
    print(f"Name: {param.name}, Default: {param.default}, Annotation: {param.annotation}")

二、使用`ast`模块解析Python函数

Python的ast（抽象语法树）模块可以用来解析Python代码，生成抽象语法树，并从中提取各种信息。这对于静态分析代码非常有用。

1. 解析代码并提取函数定义

首先，我们可以使用ast.parse()函数来解析Python代码字符串，生成一个抽象语法树。

import ast
code = """
def example_function(x, y):
    return x + y
"""
解析代码
parsed_code = ast.parse(code)
提取函数定义
for node in ast.walk(parsed_code):
    if isinstance(node, ast.FunctionDef):
        print(f"Function name: {node.name}")

2. 获取函数的参数信息

在函数节点中，我们可以进一步提取函数的参数信息。这可以通过访问args属性来实现。

import ast
code = """
def example_function(x, y=5):
    return x + y
"""
解析代码
parsed_code = ast.parse(code)
提取函数定义和参数信息
for node in ast.walk(parsed_code):
    if isinstance(node, ast.FunctionDef):
        print(f"Function name: {node.name}")
        for arg in node.args.args:
            print(f"Argument name: {arg.arg}")

三、使用自定义装饰器抓取函数的输入输出

装饰器是Python中用于修改函数行为的强大工具。通过自定义装饰器，我们可以在函数被调用前后执行特定的代码，从而抓取函数的输入输出。

1. 创建一个简单的装饰器

我们可以编写一个简单的装饰器，用于记录函数的输入参数和返回值。

def trace_function(func):
    def wrapper(*args, kwargs):
        print(f"Calling function: {func.__name__}")
        print(f"Arguments: {args}, Keyword arguments: {kwargs}")
        result = func(*args, kwargs)
        print(f"Return value: {result}")
        return result
    return wrapper
@trace_function
def add(a, b):
    return a + b
调用函数
add(3, 4)

2. 使用装饰器记录执行时间

我们还可以利用装饰器来记录函数的执行时间，这对于性能分析非常有帮助。

import time
def timing_decorator(func):
    def wrapper(*args, kwargs):
        start_time = time.time()
        result = func(*args, kwargs)
        end_time = time.time()
        print(f"Function {func.__name__} took {end_time - start_time:.4f} seconds to execute")
        return result
    return wrapper
@timing_decorator
def compute_square(n):
    return n * n
调用函数
compute_square(10)

四、结合使用多种方法实现全面的函数抓取

在实际应用中，我们可以结合使用上述几种方法，以实现对Python函数的全面抓取。这种组合方法可以帮助我们在不同的应用场景中，灵活地获取函数的各种信息。

1. 使用`inspect`和`ast`模块联合分析

通过结合inspect和ast模块，我们可以同时获取函数的动态信息（如签名、源代码）和静态信息（如函数定义、参数）。

import inspect
import ast
def my_function(a, b):
    return a + b
使用 inspect 获取动态信息
signature = inspect.signature(my_function)
source_code = inspect.getsource(my_function)
print(f"Signature: {signature}")
print(f"Source code:\n{source_code}")
使用 ast 解析源代码
parsed_tree = ast.parse(source_code)
for node in ast.walk(parsed_tree):
    if isinstance(node, ast.FunctionDef):
        print(f"Function name: {node.name}")

2. 使用装饰器增强函数的可观察性

装饰器可以帮助我们在函数执行时获取更多的动态信息，如参数、返回值、执行时间等。这种动态抓取方式非常适合运行时分析。

def debug_decorator(func):
    def wrapper(*args, kwargs):
        print(f"Function {func.__name__} is called with args: {args} and kwargs: {kwargs}")
        result = func(*args, kwargs)
        print(f"Function {func.__name__} returned: {result}")
        return result
    return wrapper
@debug_decorator
def multiply(x, y):
    return x * y
调用函数
multiply(2, 3)