使用 uv 与 FastAPI
FastAPI 是一个现代的、高性能的 Python Web 框架。您可以使用 uv 来管理您的 FastAPI 项目,包括安装依赖项、管理环境、运行 FastAPI 应用程序等等。
注意
您可以在 uv-fastapi-example 仓库中查看本指南的源代码。
迁移现有的 FastAPI 项目
例如,考虑 FastAPI 文档中定义的示例应用程序,其结构如下
project
└── app
├── __init__.py
├── main.py
├── dependencies.py
├── routers
│ ├── __init__.py
│ ├── items.py
│ └── users.py
└── internal
├── __init__.py
└── admin.py
要将 uv 与此应用程序一起使用,请在 project
目录中运行
这将创建一个具有应用程序布局的项目和一个 pyproject.toml
文件。
然后,添加对 FastAPI 的依赖
您现在应该具有以下结构
project
├── pyproject.toml
└── app
├── __init__.py
├── main.py
├── dependencies.py
├── routers
│ ├── __init__.py
│ ├── items.py
│ └── users.py
└── internal
├── __init__.py
└── admin.py
并且 pyproject.toml
文件的内容应如下所示
pyproject.toml
[project]
name = "uv-fastapi-example"
version = "0.1.0"
description = "FastAPI project"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"fastapi[standard]",
]
从那里,您可以使用以下命令运行 FastAPI 应用程序
uv run
将自动解析和锁定项目依赖项(即,创建一个 uv.lock
文件在 pyproject.toml
文件旁边),创建一个虚拟环境,并在该环境中运行命令。
通过在 Web 浏览器中打开 http://127.0.0.1:8000/?token=jessica 来测试该应用程序。
部署
要使用 Docker 部署 FastAPI 应用程序,您可以使用以下 Dockerfile
Dockerfile
FROM python:3.12-slim
# Install uv.
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
# Copy the application into the container.
COPY . /app
# Install the application dependencies.
WORKDIR /app
RUN uv sync --frozen --no-cache
# Run the application.
CMD ["/app/.venv/bin/fastapi", "run", "app/main.py", "--port", "80", "--host", "0.0.0.0"]
使用以下命令构建 Docker 镜像
使用以下命令在本地运行 Docker 容器
在浏览器中导航到 http://127.0.0.1:8000/?token=jessica 以验证应用程序是否正在正确运行。
提示
有关将 uv 与 Docker 一起使用的更多信息,请参见Docker 指南。