如何在 VS Code 中以调试模式自动重新加载运行 FastAPI 项目？

Question

从 FastAPI python 开始。

这就是我连接服务器的方式

class Server:
    def __init__(self):
        self.app = FastAPI()

    def runServer(self, host: str, port: int,is_dev:bool):
        uvicorn.run(self.app, host=host, port=port,debug=is_dev)


if __name__ == "__main__":
    server = Server()
    # read the environment variables
    host: str = os.environ['host']
    port: int = int(os.environ['port'])
    is_dev: bool = bool(os.environ['dev'])

    server.runServer(host, port, is_dev)

这会启动服务器，但如果我进行任何更改，则不会以自动重新加载模式运行。

即使我尝试过

uvicorn.run(self.app, host=host, port=port, reload=is_dev)

重新加载我猜不是一个选项，从而导致服务器崩溃。

我尝试在 launch.json 中传递

--reload

args，但仍然不起作用

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: FastAPI",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/main.py",
            "jinja": true,
            "args": ["--reload"],
            "env": {
                "host": "127.0.0.1",
                "port": "5555",
                "dev": "true"
            }
        }
    ]
}

有什么想法吗？我错过了什么吗？

Answer 1

仅当

uvicorn

 参数是格式为 

app

 且 

<module>:<app_instance>

 或 

reload

 参数为 true 的字符串时，

debug

才会以重新加载模式启动。像这样：

if __name__ == "__main__":
    uvicorn.run("example:app", host="127.0.0.1", port=5000, reload=True)

摘自文档：

请注意，可以传递应用程序实例本身，而不是应用程序导入字符串。

uvicorn.run(app, host="127.0.0.1", port=5000, log_level="info")

但是，此样式仅在您不使用多重处理 (

workers=NUM

) 或重新加载 (

reload=True

) 时才有效，因此我们建议使用导入字符串样式。

Answer 2

如果您的文件名为 handler.py，则字符串应为“handler:app”

Answer 3

fastapi run --reload

在某些情况下有效（来源）。