Python inspect 模块的使用方法，实用

用户11081884

发布于 2026-07-20 19:24:16

360

文章被收录于专栏：用户11081884的专栏用户11081884的专栏

Python的inspect模块是一个强大的内省工具，它允许开发者在运行时检查和分析Python对象的结构和属性。这个模块对于调试、文档生成、框架开发等场景都具有重要价值。

功能

1. 类型检查功能

inspect 模块提供了一系列函数来检查对象的类型：

inspect.isfunction(obj) : 判断是否为函数
inspect.ismethod(obj) : 判断是否为方法
inspect.isclass(obj) : 判断是否为类
inspect.ismodule(obj) : 判断是否为模块

2. 信息获取功能

inspect.signature(callable) : 获取可调用对象的参数签名
inspect.getdoc(obj) : 获取对象的文档字符串
inspect.getsource(obj) : 获取对象的源代码
inspect.getmro(cls) : 获取类的继承顺序

3. 成员信息获取

inspect.getmembers(obj, predicate=None) 可以获取对象的所有成员，支持通过谓词函数进行过滤。

使用场景

1. 调试和开发工具

在开发过程中，可以使用 inspect 模块来检查函数参数、查看对象结构，帮助理解代码执行流程。

2. 文档生成

自动提取函数签名和文档字符串，用于生成API文档。

3. 框架开发

在框架开发中，常用于自动注册处理器、验证参数类型、实现插件系统等。

4. 测试和验证

用于编写测试用例时检查函数的行为和属性。

代码示例

示例1：检查函数信息

import inspect

def calculate_area(length: float, width: float, unit: str = "cm") -> str:
    """计算矩形面积
    
    Args:
        length: 长度
        width: 宽度
        unit: 单位，默认为厘米
        
    Returns:
        格式化后的面积字符串
    """
    area = length * width
    return f"面积: {area} {unit}²"

# 获取函数签名
sig = inspect.signature(calculate_area)
print(f"函数参数: {sig}")

# 检查是否为函数
print(f"是否为函数: {inspect.isfunction(calculate_area)}")

# 获取文档字符串
doc = inspect.getdoc(calculate_area)
print(f"文档说明:\n{doc}")

示例2：类结构分析

import inspect

class Vehicle:
    """交通工具基类"""
    def __init__(self, brand: str):
        self.brand = brand
    
    def start_engine(self):
        return "引擎启动"

class Car(Vehicle):
    """汽车类"""
    def __init__(self, brand: str, doors: int = 4):
        super().__init__(brand)
        self.doors = doors
    
    def honk(self):
        return "滴滴！"

# 检查继承关系
print("Car类的继承顺序:")
for cls in inspect.getmro(Car):
    print(f"  {cls.__name__}")

# 获取类成员
print("\nCar类的成员:")
for name, value in inspect.getmembers(Car):
    if not name.startswith('_'):
        print(f"  {name}: {type(value)}")

示例3：动态参数验证

import inspect
from typing import Union

def validate_arguments(func):
    """参数验证装饰器"""
    def wrapper(*args, **kwargs):
        sig = inspect.signature(func)
        bound_args = sig.bind(*args, **kwargs)
        
        for param_name, value in bound_args.arguments.items():
            param = sig.parameters[param_name]
            if param.annotation != inspect.Parameter.empty:
                if not isinstance(value, param.annotation):
                    raise TypeError(
                        f"参数'{param_name}'需要{param.annotation.__name__}类型, "
                        f"但收到{type(value).__name__}"
                    )
        return func(*args, **kwargs)
    return wrapper

@validate_arguments
def process_data(data: list, threshold: Union[int, float]) -> bool:
    """处理数据"""
    return len(data) > threshold

# 测试验证功能
try:
    result = process_data([1, 2, 3], 2.5)
    print(f"验证通过: {result}")
except TypeError as e:
    print(f"验证失败: {e}")

示例4：模块内函数扫描

import inspect
import math

def analyze_module(module):
    """分析模块中的函数"""
    print(f"模块 {module.__name__} 分析结果:")
    
    functions = []
    for name, obj in inspect.getmembers(module):
        if inspect.isfunction(obj):
            functions.append((name, obj))
    
    print(f"发现 {len(functions)} 个函数:")
    for name, func in functions[:5]:  # 只显示前5个
        sig = inspect.signature(func)
        print(f"  {name}{sig}")

# 分析math模块
analyze_module(math)

inspect 模块为Python开发者提供了强大的内省能力，是进行元编程、框架开发和高级调试的重要工具。通过合理使用这个模块，可以显著提升开发效率和代码质量。

1、性能考虑：在生产环境中谨慎使用，避免在性能敏感的场景过度使用。

2、异常处理：使用 getsource() 等函数时要注意处理内置函数的情况。

3、缓存机制：对频繁使用的检查结果考虑使用缓存。

4、适度使用：在合适的场景选择使用，避免过度依赖内省功能。

“无他，惟手熟尔”！有需要的用起来！

如果你觉得这篇文章有用，欢迎点赞、转发、收藏、留言、推荐❤！

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2026-01-14，如有侵权请联系 cloudcommunity@tencent.com 删除

开发