一些项目工具的使用

uv

uv 是一个 Python 项目的依赖管理工具，它的作用是管理项目的依赖关系，确保项目在不同环境中运行时依赖的版本一致。

安装 uv

uv 可以通过 pip 安装，命令如下：

pip install uv

设置环境变量

uv 安装完成后，需要将其添加到环境变量中，以便在任何目录下都可以使用 uv 命令。

• Windows

  将 uv 所在目录添加到环境变量 PATH 中。

  假设 uv 安装在 C:\Users\username\AppData\Local\Programs\Python\Python311\Scripts 目录下，将该目录添加到环境变量 PATH 中。

  打开环境变量设置窗口，将 C:\Users\username\AppData\Local\Programs\Python\Python311\Scripts 添加到 PATH 中。

命令行设置会比较快捷

set PATH=%PATH%;C:\Users\username\AppData\Local\Programs\Python\Python311\Scripts

创建虚拟环境

uv 可以创建虚拟环境，用于隔离项目的依赖关系。

• 创建虚拟环境

  运行以下命令来创建一个名为 myenv 的虚拟环境：

  uv venv myenv

  该命令会在当前目录下创建一个名为 .venv 的目录，其中包含一个独立的 Python 环境。

• 激活虚拟环境

  激活虚拟环境后，项目中的依赖包将安装在该环境中，而不会影响全局 Python 环境。

  在 Windows 中，运行以下命令来激活虚拟环境：

  uv venv myenv -p 3.13 # 指定环境名字和python版本
  uv venv -p python@3.13 # 指定python版本
  source .venv/bin/activate # 激活虚拟环境

uv其他常用指令

uv add # 添加项目依赖 uv sync # 同步项目依赖 uv install # 安装项目依赖 uv run # 运行项目 uv pip freeze > requirements.txt # 导出项目依赖

uv支持前向兼容，即大部分的pip指令都可以在uv中使用

pyproject.toml

pyproject.toml 是一个项目的配置文件，用于管理项目的依赖关系、构建工具、元数据等。

这个文件由多个表组成，每个表都有不同的作用。

• [build-system] : 定义项目的构建系统，告诉打包工具如何构建项目（如使用 uv 或 setuptools）
• [project] : 项目的元数据（名称、版本、描述、作者等）
• [tool.*] : 各种第三方工具的配置（如 uv、black、isort 等）

ruff

ruff 是一个 Python 代码格式化工具，它的作用是自动格式化 Python 代码，使代码符合 PEP 8 风格。

常用操作

ruff format . # 格式化代码
ruff format . --check # 检查代码是否符合格式化要求
ruff check . # 检查代码并自动修复问题
ruff check . --fix # 检查代码. 加--fix可以自动修复一些问题
ruff check . --watch # 监听代码变化，实时检查代码问题
ruff rule <RULE_CODE> # 查看指定规则的详细信息
ruff cache clean # 清除ruff缓存
ruff format . && ruff check . --fix # 格式化代码并自动修复问题

pyright

pyright 是一个 Python 静态类型检查工具，它的作用是检查 Python 代码中的类型错误。

rich

rich 是一个 Python 库，用于在终端中显示富文本（如颜色、样式、表格等），美化堆栈报错。

安装 rich

rich 可以通过 pip 安装，命令如下：

uv pip install rich