FastAPI 如何在VS Code中以调试模式运行FastAPI项目并自动重载
在本文中,我们将介绍如何在VS Code中以调试模式运行FastAPI项目,并自动重载项目的更改。
阅读更多:FastAPI 教程
准备工作
在开始设置之前,确保您已经完成了以下准备工作:
- 安装Python和VS Code:在您的计算机上安装Python和VS Code开发环境。
-
安装FastAPI和相关库:使用pip或conda安装FastAPI和相关依赖库。
-
创建FastAPI项目:创建一个FastAPI项目。您可以使用命令行或VS Code的集成终端创建项目。
配置VS Code
-
打开VS Code并导航到项目文件夹。
-
创建
.vscode
文件夹:在项目根目录下创建一个名为.vscode
的文件夹。 -
创建
launch.json
文件:在.vscode
文件夹中创建一个名为launch.json
的文件。 -
配置
launch.json
文件:将以下代码添加到launch.json
文件中:
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: FastAPI",
"type": "python",
"request": "launch",
"module": "uvicorn",
"args": ["app.main:app", "--reload"],
"cwd": "${workspaceFolder}",
"console": "integratedTerminal"
}
]
}
在此配置文件中,我们指定了要运行的Python模块以及要传递给模块的参数。参数--reload
将触发FastAPI项目在每次更改保存后重新加载。
- 保存并关闭
launch.json
文件。
启动FastAPI项目
现在,您可以使用VS Code的调试功能启动FastAPI项目。按照以下步骤执行:
- 在VS Code的侧边栏中点击“调试”图标(或按下F5键)。
-
点击调试面板左上方的“启动”按钮。这将启动FastAPI项目的调试模式。
-
在调试控制台中,您将看到如下输出:
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [1234]
INFO: Started server process [5678]
INFO: Waiting for application startup.
INFO: Application startup complete.
这表示您的FastAPI项目已经在调试模式下成功启动,并且将自动重载项目的更改。
- 现在,打开浏览器并访问
http://127.0.0.1:8000
,即可查看您的FastAPI应用程序。
调试FastAPI项目
启动FastAPI项目的调试模式后,您可以使用VS Code的调试功能对代码进行调试。以下是一些常用的调试功能和示例:
- 设置断点:在您想要中断程序执行的代码行上单击左侧边栏。当程序执行到达该行时,它将停止并暂停。
-
单步执行:单击调试控制台顶部的“单步执行”按钮(或按下F10键)将逐行执行您的代码。
-
查看变量值:在调试控制台中,您可以输入变量名称并按回车键,以查看该变量的当前值。
-
检查堆栈跟踪:在调试控制台中,通过输入
where
命令并按回车键,您将获得当前堆栈跟踪。这对于分析程序执行流程很有帮助。
总结
通过在VS Code中设置调试配置,我们能够以调试模式运行FastAPI项目并自动重载更改,使我们可以更轻松地开发和调试我们的应用程序。使用VS Code的调试功能,我们可以设置断点、单步执行代码、查看变量值和堆栈跟踪,以支持更高效的开发过程。
希望本文能够帮助您成功在VS Code中调试和运行FastAPI项目。祝您开发愉快!