README
🚀 VS Code开发环境
本仓库包含一个配置完善的VS Code开发环境,具备自动格式化、代码检查和类型检查功能。
🚀 快速开始
本环境配置为使用 uv 进行Python包管理:
# 安装依赖
uv sync
# 若使用Codespaces,postCreate.sh脚本会自动完成此操作
✨ 主要特性
保存时自动执行
- 格式化:保存时运行Ruff格式化工具
- 代码检查:Ruff代码检查器检查代码风格
- 导入管理:Ruff整理导入语句
- 类型检查:Pylance提供实时类型检查(严格模式)
可用任务
打开VS Code命令面板(Cmd+Shift+P / Ctrl+Shift+P)并搜索“Tasks: Run Task”:
- 安装依赖(uv) — 安装所有开发依赖
- 使用Ruff格式化 — 格式化整个代码库
- 使用Ruff进行代码检查 — 检查代码检查问题
- 使用mypy进行类型检查 — 在源代码上运行mypy
- 全面检查 — 运行格式化检查 + 代码检查 + 类型检查
- 运行测试 — 运行pytest测试套件
- 运行带覆盖率的测试 — 生成覆盖率报告
- 运行MCP服务器 — 启动MCP服务器
调试配置
.vscode/launch.json 包含以下调试配置:
- Python: MCP服务器 — 调试MCP服务器
- Python: Pytest — 调试当前测试文件
- Python: Pytest(全部) — 调试所有测试
要开始调试,按
F5或点击侧边栏中的调试图标。
扩展
推荐的扩展列在 .vscode/extensions.json 中,打开工作区时会给出提示。
关键扩展:
- Python - 官方Python支持
- Pylance - 高级类型检查和语言特性
- Ruff - 快速Python代码检查器和格式化工具
- Debugpy - Python调试器
配置
设置在 .vscode/settings.json 中定义,仅适用于此工作区:
| 属性 | 详情 |
|------|------|
| 目标Python版本 | 3.12 |
| 行长度 | 100个字符 |
| 类型检查 | 严格模式 |
| 格式化工具 | Ruff |
| 代码检查器 | 集成isort的Ruff |
📦 Codespaces支持
在GitHub Codespaces中打开此仓库时,环境会通过 .devcontainer/devcontainer.json 自动配置,并且 postCreate.sh 脚本会运行:
#!/bin/bash
set -e
echo "Installing dependencies with uv..."
uv sync
echo "✓ Ready to develop!"
💻 便携使用
此配置具有完全的可移植性,可在以下环境中使用:
- ✅ 本地安装
uv的环境 - ✅ Codespaces(自动配置)
- ✅ 包含Python 3.12+的Docker容器
- ✅ 任何标准VS Code安装环境 所有路径均相对于工作区,配置使用标准VS Code设置。
Scan to join WeChat group