Python的inspect模块

原创于 2025-03-28 15:23:50 发布

· 1k 阅读

29 ·

版权

文章标签：

#python #服务器

python基础专栏收录该内容

22 篇文章

订阅专栏

在Python编程中，**inspect**模块是一个强大的工具包，它提供了一系列函数来获取对象的信息，主要用于获取对象的源代码、参数信息、类继承关系、方法属性等。这对于调试、自动化文档生成、代码分析等场景都非常有用。本文将详细介绍inspect模块的功能，并结合示例代码来说明其使用方法。

一、为什么使用inspect模块？

在编写大型程序或框架时，我们经常需要了解某个对象的内部结构，比如：

获取函数的参数列表及默认值。
获取类的方法和属性。
获取对象的源代码。
检查对象的类型和继承关系。

inspect模块使得这些操作变得简单而直观，通过提供一系列的函数接口，帮助开发者更加深入地了解和操作Python对象。

二、inspect模块的主要功能

inspect模块的功能主要集中在以下几个方面：

获取对象信息：检查对象的类型、属性、方法等。
获取源代码：获取对象（如函数、类）的源代码。
获取参数信息：获取函数或方法的参数列表、默认值等。
检查类和函数的继承关系：获取类的继承树、函数的闭包等信息。

三、inspect模块的常用函数和使用示例

1. 检查对象类型

inspect模块提供了一系列的isXXX()函数，用于检查对象的类型。

inspect.isfunction(object)：判断对象是否是函数。
inspect.ismethod(object)：判断对象是否是方法。
inspect.isclass(object)：判断对象是否是类。
inspect.ismodule(object)：判断对象是否是模块。

示例：

import inspect

def func():
    pass

class MyClass:
    def method(self):
        pass

print(inspect.isfunction(func))          # True
print(inspect.isclass(MyClass))          # True
print(inspect.ismethod(MyClass.method))  # False，在类中定义的方法其实是函数
instance = MyClass()
print(inspect.ismethod(instance.method)) # True，绑定到实例的方法是方法

2. 获取对象的源代码

inspect.getsource(object)：获取对象的源代码字符串。

示例：

import inspect

def greet(name):
    print(f"Hello, {name}!")

source_code = inspect.getsource(greet)
print(source_code)

输出：

def greet(name):
    print(f"Hello, {name}!")

3. 获取函数或方法的参数信息

inspect.signature(callable)：获取可调用对象的参数签名。

示例：

import inspect

def func(a, b=2, *args, **kwargs):
    pass

sig = inspect.signature(func)
print(sig)          # (a, b=2, *args, **kwargs)
print(sig.parameters)

输出：

(a, b=2, *args, **kwargs)
OrderedDict([('a', <Parameter "a">), ('b', <Parameter "b=2">), ('args', <Parameter "*args">), ('kwargs', <Parameter "**kwargs">)])

可以进一步获取参数的详细信息：

for name, param in sig.parameters.items():
    print(f"Name: {name}")
    print(f"  Default: {param.default}")
    print(f"  Kind: {param.kind}")

参数类型（Parameter.kind）枚举值：

POSITIONAL_ONLY：仅限位置参数。
POSITIONAL_OR_KEYWORD：可以是位置参数也可以是关键词参数。
VAR_POSITIONAL：可变位置参数，如*args。
KEYWORD_ONLY：仅限关键词参数。
VAR_KEYWORD：可变关键词参数，如**kwargs。

4. 获取类的继承关系

inspect.getmro(cls)：获取类的继承顺序（方法解析顺序，返回一个元组）。

示例：

import inspect

class A:
    pass

class B(A):
    pass

class C(B):
    pass

print(inspect.getmro(C))

输出：

(<class '__main__.C'>, <class '__main__.B'>, <class '__main__.A'>, <class 'object'>)

5. 获取对象的属性和方法

inspect.getmembers(object, predicate=None)：返回对象的成员列表，成员名和成员值组成的二元组列表。

示例：

import inspect

class MyClass:
    class_var = "Class Variable"

    def __init__(self, value):
        self.instance_var = value

    def method(self):
        pass

instance = MyClass(10)

# 获取所有成员
members = inspect.getmembers(instance)
for name, value in members:
    print(f"{name}: {value}")

可以使用predicate参数过滤成员，例如只获取方法：

# 获取所有方法
methods = inspect.getmembers(instance, predicate=inspect.ismethod)
for name, method in methods:
    print(f"{name}: {method}")

6. 获取调用堆栈信息

inspect.stack()：获取当前的调用堆栈列表。
inspect.currentframe()：获取当前的堆栈帧。

示例：

import inspect

def function_a():
    function_b()

def function_b():
    stack = inspect.stack()
    for frame_info in stack:
        print(f"Function: {frame_info.function}, Line: {frame_info.lineno}")

function_a()

输出：

Function: function_b, Line: 5
Function: function_a, Line: 2
Function: <module>, Line: 10
...

7. 获取闭包（Closure）信息

inspect.getclosurevars(func)：获取函数的闭包变量。

示例：

import inspect

def outer():
    x = 10
    def inner():
        return x + 1
    return inner

closure_func = outer()
closure_vars = inspect.getclosurevars(closure_func)
print(closure_vars.nonlocals)  # {'x': 10}

四、实际应用场景

1. 自动生成文档

通过inspect模块，可以自动提取代码的文档字符串、参数信息等，生成API文档。

示例：

def documented_function(param1, param2):
    """This function does something important.

    Parameters:
    param1 (int): The first parameter.
    param2 (str): The second parameter.
    """
    pass

import inspect

def generate_documentation(func):
    doc = inspect.getdoc(func)
    sig = inspect.signature(func)
    print(f"Function: {func.__name__}{sig}\n")
    print(doc)

generate_documentation(documented_function)

2. 调试和日志

在异常处理时，利用inspect可以获取更详细的堆栈信息，帮助定位问题。

3. 元编程和装饰器

编写装饰器时，可以使用inspect获取被装饰函数的信息，以实现更通用的功能。

示例：

import functools
import inspect

def log_call(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        sig = inspect.signature(func)
        bound = sig.bind(*args, **kwargs)
        print(f"Calling {func.__name__}{bound.arguments}")
        return func(*args, **kwargs)
    return wrapper

@log_call
def add(a, b):
    return a + b

add(5, 7)