starlette 调试应用程序主要依赖其内置的 debug 模式,该模式在捕获异常时会自动生成并展示详细的错误页面。要启用此功能,只需在创建 starlette 实例时将 debug=true 参数传入,这样当应用抛出未处理的异常时,浏览器会显示包含完整堆栈跟踪、局部变量和源码片段的交互式调试界面。

如何配置开发环境以启用详细报错信息
在开发环境中,通过设置环境变量或直接修改代码来开启调试模式是获取详细报错信息的关键步骤。默认情况下,Starlette 处于生产模式,此时若发生异常,用户只能看到通用的 "Internal Server Error" 响应,无法得知具体原因。通过在初始化时显式指定 debug=True,框架会拦截异常并将其格式化为 HTML 页面返回给客户端,这对于排查路由匹配失败或业务逻辑错误至关重要。

from starlette.applications import Starlette
from starlette.responses import PlainTextResponse
import os
def homepage(request):
# 故意制造一个除零错误用于演示
return PlainTextResponse(str(1 / 0))
app = Starlette(debug=True)
app.add_route("/", homepage)
if __name__ == "__main__":
import uvicorn
# 确保在开发服务器中也保持 debug 状态
uvicorn.run(app, host="127.0.0.1", port=8000)
运行上述代码并访问根路径后,浏览器将不再显示空白错误页,而是渲染出包含 Traceback 信息的 HTML 内容。开发者可以直接在页面上查看出错行的源代码上下文以及当前作用域内的变量值,从而快速定位问题根源。这种机制无需引入第三方调试工具即可实现即时反馈。
如何处理中间件与异常之间的交互关系
Starlette 的异常处理流程受到中间件顺序的显著影响,理解这一机制对于正确捕获和调试错误非常重要。当请求进入应用时,它会依次经过注册的中间件链,任何一层中间件都可能抛出异常或被异常中断。如果某个中间件没有正确处理异常,它可能会将异常传递给下一个中间件或最终的应用程序入口。在调试模式下,即使异常被中间件捕获,只要它最终未被处理而传播到顶层,Starlette 依然会尝试生成错误页面。然而,如果中间件自行吞没了异常或返回了响应,则不会触发标准的错误展示流程。
Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response
class CustomDebugMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
try:
response = await call_next(request)
return response
except Exception as e:
# 这里可以记录日志,但如果直接返回响应,
# 后续的 debug 页面生成将被阻止
print(f"Caught exception: {e}")
raise # 重新抛出以便 Starlette 处理
app.add_middleware(CustomDebugMiddleware)
在上述代码中,自定义中间件捕获了异常后选择重新抛出(raise),这确保了异常能够继续向上传播至 Starlette 的核心异常处理器。如果在此处直接返回一个自定义的 Response,则调试页面将不会出现。因此,在开发阶段,建议中间件仅记录日志而不拦截异常,或者确保异常能被正确传递,以便利用框架自带的调试功能进行全方位的问题诊断。
调试模式下局部变量是如何暴露的
在启用了 debug=True 的情况下,Starlette 生成的错误页面不仅包含堆栈跟踪,还会自动提取并展示引发异常时的局部变量值。这一特性极大地简化了数据流追踪的过程,开发者无需手动添加打印语句即可检查函数调用时的参数状态、对象属性或计算中间结果。这些变量信息直接嵌入在 HTML 响应中,使得调试过程完全基于 Web 界面完成,无需切换至终端或 IDE。










