Python function-debugger 完整使用指南function-debugger是Python 专用函数级调试工具包核心作用是无需复杂断点、无需IDE直接在代码中精准调试函数自动追踪函数入参、返回值、执行耗时、异常信息、调用栈支持日志输出、条件调试、递归调试等轻量无侵入适合脚本、服务、算法等所有 Python 函数调试场景。一、核心功能自动追踪函数入参/关键字参数、返回值、执行时长、内存占用异常捕获精准定位函数内报错、异常类型、堆栈信息条件调试满足指定条件才触发调试避免冗余日志递归调试完美支持递归函数的层级调用追踪自定义输出控制台打印/文件日志/格式化输出无侵入调试仅用装饰器不修改原函数逻辑性能监控函数执行耗时、调用次数统计多场景兼容支持同步/异步函数、类方法、静态方法二、安装方法1. 标准安装pip# 最新稳定版pipinstallfunction-debugger# 指定版本安装pipinstallfunction-debugger1.0.0# 升级到最新版pipinstall--upgradefunction-debugger2. 离线/源码安装# 克隆仓库gitclone https://github.com/function-debugger/function-debugger.gitcdfunction-debugger# 安装python setup.pyinstall3. 验证安装importfunction_debuggerprint(function_debugger.__version__)# 输出版本号即安装成功三、核心语法与参数详解function-debugger核心是装饰器debug_function所有功能通过装饰器参数控制。1. 基础语法# 导入核心装饰器fromfunction_debuggerimportdebug_function# 装饰器修饰函数无参数/全默认配置debug_functiondef目标函数(参数):函数逻辑2. 完整参数列表含默认值debug_function(# 1. 基础输出控制log_argsTrue,# 是否打印函数入参log_returnTrue,# 是否打印返回值log_timeTrue,# 是否打印执行耗时log_memoryFalse,# 是否打印内存占用log_stackFalse,# 是否打印调用栈log_exceptionTrue,# 是否捕获并打印异常# 2. 条件调试conditionNone,# 触发调试的条件函数/布尔表达式only_on_errorFalse,# 仅函数报错时才输出调试信息# 3. 格式与输出indent4,# 递归调用缩进空格数prefix[DEBUG],# 日志前缀标识outputconsole,# 输出方式console/filelog_filedebug.log,# 日志文件路径outputfile时生效# 4. 高级功能max_depthNone,# 递归调试最大深度async_modeFalse# 异步函数调试开关)3. 关键参数说明参数名类型作用常用场景condition函数/布尔自定义触发条件仅调试特定入参的函数only_on_errorbool仅报错时调试生产环境排查偶发异常outputstr输出渠道本地用console服务器用filemax_depthint递归最大层级避免无限递归打印泛滥async_modebool异步函数支持调试FastAPI/异步爬虫四、8个实际应用案例可直接运行案例1基础函数调试默认配置场景调试简单计算函数查看入参、返回值、耗时fromfunction_debuggerimportdebug_function# 默认全量调试debug_functiondefadd(a,b):returnab# 调用函数add(3,5)输出结果[DEBUG] Calling function add(args(3, 5), kwargs{}) [DEBUG] Function add executed in 0.0001s [DEBUG] Function add returned: 8案例2仅异常时调试生产环境专用场景不打印正常日志仅函数报错时输出详情fromfunction_debuggerimportdebug_functiondebug_function(only_on_errorTrue)defdivide(a,b):returna/b# 正常调用无输出divide(10,2)# 报错调用自动打印异常详情divide(10,0)输出结果[DEBUG] Calling function divide(args(10, 0), kwargs{}) [DEBUG] Function divide raised ZeroDivisionError: division by zero [DEBUG] Exception stack trace (most recent call last):案例3条件调试仅特定参数触发场景仅当参数满足条件时才调试避免冗余日志fromfunction_debuggerimportdebug_function# 条件a10 才触发调试debug_function(conditionlambdaa,b:a10)defmultiply(a,b):returna*b multiply(5,3)# 不触发调试multiply(15,4)# 触发调试案例4递归函数调试层级追踪场景调试斐波那契递归函数查看调用层级fromfunction_debuggerimportdebug_functiondebug_function(max_depth5,indent4)deffib(n):ifn1:returnnreturnfib(n-1)fib(n-2)fib(4)输出结果层级缩进展示递归调用清晰直观案例5日志输出到文件服务器调试场景后台服务无控制台将调试日志写入文件fromfunction_debuggerimportdebug_functiondebug_function(outputfile,log_filefunc_debug.log)defuser_info(name,age):returnf姓名{name}年龄{age}user_info(张三,25)效果调试信息自动写入func_debug.log不污染控制台案例6类方法/静态方法调试场景调试面向对象代码中的方法fromfunction_debuggerimportdebug_functionclassCalculator:# 实例方法调试debug_functiondefadd(self,a,b):returnab# 静态方法调试staticmethoddebug_functiondefsubtract(a,b):returna-b calcCalculator()calc.add(2,8)Calculator.subtract(10,3)案例7异步函数调试async/await场景调试异步爬虫、FastAPI接口等异步函数importasynciofromfunction_debuggerimportdebug_functiondebug_function(async_modeTrue)asyncdefasync_task(seconds):awaitasyncio.sleep(seconds)returnf等待{seconds}秒完成# 运行异步函数asyncio.run(async_task(1))案例8性能监控耗时内存调用次数场景优化函数性能监控执行耗时和内存fromfunction_debuggerimportdebug_functiondebug_function(log_timeTrue,log_memoryTrue)defheavy_calc(n):total0foriinrange(n):totali**2returntotal heavy_calc(1000000)输出包含执行耗时、内存占用精准定位性能瓶颈五、常见错误与解决方案错误1导入失败ModuleNotFoundError: No module named function_debugger原因未安装包 / 安装环境与运行环境不一致解决方案确认pip安装pip install function-debugger用对应Python版本安装python3 -m pip install function-debugger检查虚拟环境是否激活错误2异步函数不输出日志原因未开启async_modeTrue解决方案装饰器添加参数debug_function(async_modeTrue)错误3递归函数打印泛滥无限输出原因未限制递归最大深度解决方案添加max_depth5限制层级错误4日志文件不生成原因路径无权限 /output参数错误解决方案确认参数outputfile, log_file路径/debug.log检查文件夹写入权限使用绝对路径错误5条件调试不触发原因condition函数参数与原函数不匹配解决方案lambda参数必须和原函数入参完全一致# 错误参数不匹配debug_function(conditionlambdax:x10)deffunc(a,b):pass# 正确匹配原函数参数debug_function(conditionlambdaa,b:a10)deffunc(a,b):pass错误6类方法调试报错self参数异常原因装饰器顺序错误解决方案debug_function放在staticmethod/classmethod下方# 正确顺序staticmethoddebug_functiondeffunc():pass六、使用注意事项生产环境慎用全量调试生产环境建议用only_on_errorTrue避免日志泛滥影响性能敏感信息过滤调试函数包含密码、密钥时关闭log_argsTrue防止泄露递归深度控制深度递归函数必须设置max_depth避免控制台刷屏性能影响开启log_memoryTrue会轻微增加性能开销性能敏感场景关闭异步兼容所有异步函数必须加async_modeTrue否则无法捕获日志装饰器顺序类方法中debug_function必须在方法装饰器如staticmethod下方日志隔离多函数调试时用不同prefix区分方便定位版本兼容支持 Python 3.7低版本Python需升级环境总结function-debugger是轻量函数级调试工具通过装饰器实现无侵入调试支持入参、返回值、异常、性能全维度追踪核心语法debug_function(参数)关键参数支持条件调试、文件输出、异步/递归兼容8大案例覆盖基础、异常、递归、类、异步、性能等全场景调试需求常见错误集中在环境、参数、装饰器顺序按对应方案可快速解决生产环境优先使用仅异常调试本地开发使用全量调试兼顾实用性与性能《动手学PyTorch建模与应用:从深度学习到大模型》是一本从零基础上手深度学习和大模型的PyTorch实战指南。全书共11章前6章涵盖深度学习基础包括张量运算、神经网络原理、数据预处理及卷积神经网络等后5章进阶探讨图像、文本、音频建模技术并结合Transformer架构解析大语言模型的开发实践。书中通过房价预测、图像分类等案例讲解模型构建方法每章附有动手练习题帮助读者巩固实战能力。内容兼顾数学原理与工程实现适配PyTorch框架最新技术发展趋势。
