【cursor】通用开发环境配置指南(AI辅助开发最佳实践)
通用开发环境配置指南(AI辅助开发最佳实践)
本文档总结了在Windows系统上使用AI进行Python项目开发时的环境配置经验和命令模板,可作为AI提示词直接使用。
📋 目录
- 环境信息模板
- Shell环境选择
- Python虚拟环境配置
- 路径处理最佳实践
- 常用命令模板
- 常见问题解决方案
- AI提示词模板
🔧 环境信息模板
在与AI开始项目开发前,提供以下环境信息:
### 开发环境配置**操作系统**: Windows 10/11
**Shell环境**: Git Bash (推荐) 或 PowerShell
**Python管理器**: Miniconda
**虚拟环境名称**: ai_code (或您的环境名)
**Python版本**: 3.8+ (查看命令: python --version)**关键路径**:
- Miniconda安装路径: `D:\ruanjian\miniconda`
- 虚拟环境路径: `D:\ruanjian\miniconda\envs\ai_code`
- Python执行器: `D:\ruanjian\miniconda\envs\ai_code\python.exe`
- 项目根目录: `D:\document\...\项目名` (请替换为实际路径)**路径规则**:
- 优先使用正斜杠 `/` 而不是反斜杠 `\`
- 中文路径使用绝对路径,避免shell编码问题
- 命令行中使用双引号包裹包含空格或中文的路径
🐚 Shell环境选择
Git Bash (✅ 推荐)
优势:
- ✅ 支持Linux风格命令 (
ls
,cat
,grep
,find
等) - ✅ 路径处理更灵活,支持
/
分隔符 - ✅ 更好的脚本兼容性
- ✅ 中文路径处理相对友好
基本命令:
# 切换目录
cd /d/document/项目目录# 列出文件
ls -la# 查看文件内容
cat filename.py# 查找文件
find . -name "*.py"# 运行Python脚本
python script.py# 后台运行
python script.py &
PowerShell (⚠️ 注意事项)
问题:
- ❌
&&
连接符不可用(需用;
或换行) - ❌ Linux风格命令需要替换(
ls
→Get-ChildItem
) - ❌ 中文路径编码问题更严重
常用命令对照表:
Linux/Bash | PowerShell | 说明 |
---|---|---|
ls -la | Get-ChildItem -Force | 列出所有文件 |
cat file.txt | Get-Content file.txt | 查看文件内容 |
rm file.txt | Remove-Item file.txt | 删除文件 |
mkdir dir | New-Item -ItemType Directory dir | 创建目录 |
cd dir | Set-Location dir | 切换目录 |
cmd1 && cmd2 | cmd1; cmd2 | 命令连接 |
建议: 在AI开发场景中,明确告知使用Git Bash环境,避免命令兼容性问题。
🐍 Python虚拟环境配置
方法一:使用绝对路径Python执行器 (✅ 推荐)
优势:
- ✅ 不需要激活环境
- ✅ 明确指定Python版本
- ✅ 避免环境混乱
- ✅ 适合脚本自动化
命令模板:
# 通用模板
/path/to/miniconda/envs/环境名/python.exe script.py# 实际示例
D:\ruanjian\miniconda\envs\ai_code\python.exe main.py# Git Bash中使用正斜杠
/d/ruanjian/miniconda/envs/ai_code/python.exe main.py# 带参数执行
/d/ruanjian/miniconda/envs/ai_code/python.exe script.py --arg1 value1# 执行模块
/d/ruanjian/miniconda/envs/ai_code/python.exe -m pip install package_name# 内联Python命令
/d/ruanjian/miniconda/envs/ai_code/python.exe -c "import sys; print(sys.version)"
方法二:激活虚拟环境后执行
Git Bash:
# 激活环境
source /d/ruanjian/miniconda/envs/ai_code/bin/activate# 或使用conda
conda activate ai_code# 执行脚本
python script.py# 退出环境
conda deactivate
PowerShell:
# 激活环境
& D:\ruanjian\miniconda\Scripts\activate.ps1 ai_code# 执行脚本
python script.py# 退出环境
conda deactivate
虚拟环境管理命令
# 列出所有环境
conda env list# 查看当前环境
conda info --envs# 创建新环境
conda create -n 环境名 python=3.9# 删除环境
conda remove -n 环境名 --all# 导出环境配置
conda env export > environment.yml# 从配置创建环境
conda env create -f environment.yml
📂 路径处理最佳实践
路径格式规范
✅ 推荐做法:
# Python中使用正斜杠或pathlib
file_path = "D:/document/项目/文件.py"# 或使用pathlib(最佳)
from pathlib import Path
file_path = Path("D:/document/项目/文件.py")# Git Bash中使用正斜杠
cd /d/document/项目# 包含空格或中文的路径用双引号
cd "/d/document/我的项目"
❌ 避免做法:
# 避免使用反斜杠(需转义)
file_path = "D:\\document\\项目\\文件.py" # 容易出错# 避免混用斜杠
file_path = "D:/document\项目/文件.py" # 不一致
中文路径处理
问题: Windows PowerShell对中文路径编码支持不佳
解决方案:
- 使用绝对路径 (推荐):
# 直接使用完整绝对路径
/d/ruanjian/miniconda/envs/ai_code/python.exe "/d/document/我的项目/main.py"
- 转换为英文路径:
# 方案1: 在项目外层创建英文目录
# 方案2: 使用符号链接(mklink)
- Python内部处理:
# 在Python脚本内部处理中文路径
import os
import sys# 设置环境编码
os.environ['PYTHONIOENCODING'] = 'utf-8'# 使用pathlib处理路径
from pathlib import Path
base_dir = Path(__file__).parent
🔨 常用命令模板
1. 项目初始化
# 创建项目目录
mkdir 项目名
cd 项目名# 创建虚拟环境
conda create -n 项目名_env python=3.9 -y# 激活环境
conda activate 项目名_env# 创建requirements.txt
cat > requirements.txt << EOF
fastapi==0.104.1
uvicorn[standard]==0.24.0
pydantic==1.10.15
requests==2.31.0
EOF# 安装依赖
pip install -r requirements.txt# 创建基本目录结构
mkdir -p {src,tests,docs,data,static}
2. Git操作
# 初始化仓库
git init# 创建.gitignore
cat > .gitignore << EOF
__pycache__/
*.pyc
.env
venv/
.vscode/
*.log
EOF# 首次提交
git add .
git commit -m "Initial commit"# 查看状态
git status# 查看历史
git log --oneline --graph
3. 依赖管理
# 安装单个包
pip install package_name# 安装指定版本
pip install package_name==1.0.0# 安装requirements.txt
pip install -r requirements.txt# 导出当前环境依赖
pip freeze > requirements.txt# 查看已安装包
pip list# 卸载包
pip uninstall package_name -y
4. FastAPI项目启动
# 开发模式启动(自动重载)
uvicorn main:app --reload --host 0.0.0.0 --port 8000# 生产模式启动
uvicorn main:app --host 0.0.0.0 --port 8000 --workers 4# 后台启动(Git Bash)
nohup uvicorn main:app --host 0.0.0.0 --port 8000 &# 使用绝对路径启动
/d/ruanjian/miniconda/envs/ai_code/python.exe -m uvicorn main:app --reload# 指定日志级别
uvicorn main:app --log-level debug
5. 测试和调试
# 运行单个测试文件
pytest test_main.py -v# 运行所有测试
pytest tests/ -v# 带覆盖率
pytest --cov=src tests/# 调试模式
python -m pdb script.py# 打印调试信息
python -u script.py # 无缓冲输出
6. 文件操作
# 批量查找文件
find . -name "*.py" -type f# 查找并删除
find . -name "__pycache__" -type d -exec rm -rf {} +# 递归查找内容
grep -r "搜索内容" .# 统计代码行数
find . -name "*.py" | xargs wc -l# 批量替换
find . -name "*.py" -exec sed -i 's/old/new/g' {} +
⚠️ 常见问题解决方案
问题1: PowerShell中文编码错误
错误信息:
UnicodeEncodeError: 'gbk' codec can't encode character
解决方案:
# 方案1: 切换到Git Bash环境
# 方案2: 设置PowerShell编码
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
chcp 65001# 方案3: 在Python脚本开头添加
# -*- coding: utf-8 -*-
import sys
import io
sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8')
问题2: 路径找不到
错误信息:
No such file or directory
解决方案:
# 1. 使用绝对路径
/d/document/项目/script.py# 2. 检查路径分隔符
# 正确: /d/document/项目
# 错误: \d\document\项目# 3. 转义中文路径
python "/d/document/我的项目/main.py"# 4. 使用pathlib(在Python代码中)
from pathlib import Path
file_path = Path(__file__).parent / "data" / "file.txt"
问题3: 端口被占用
错误信息:
Address already in use
解决方案:
# Git Bash - 查找占用端口的进程
netstat -ano | grep 8000# PowerShell
Get-NetTCPConnection -LocalPort 8000# 结束进程(Git Bash)
taskkill //PID <进程ID> //F# PowerShell
Stop-Process -Id <进程ID> -Force# 或更改端口
uvicorn main:app --port 8001
问题4: 包导入失败
错误信息:
ModuleNotFoundError: No module named 'xxx'
解决方案:
# 1. 确认虚拟环境已激活
which python # Git Bash
Get-Command python # PowerShell# 2. 重新安装包
pip install --upgrade package_name# 3. 检查PYTHONPATH
echo $PYTHONPATH # Git Bash
$env:PYTHONPATH # PowerShell# 4. 将项目目录添加到Python路径
export PYTHONPATH="${PYTHONPATH}:/path/to/project" # Git Bash
$env:PYTHONPATH += ";D:\path\to\project" # PowerShell
🤖 AI提示词模板
在开始新项目时,向AI提供以下信息模板:
## 开发环境配置**操作系统**: Windows 10
**Shell环境**: Git Bash(请使用Git Bash命令,不要使用PowerShell专用命令)
**Python环境**: Miniconda的ai_code虚拟环境
**Python执行器**: 请使用绝对路径 `D:\ruanjian\miniconda\envs\ai_code\python.exe`**环境要求**:
1. 在执行Python脚本时,使用完整的Python路径,不需要激活虚拟环境
2. 所有命令请使用Git Bash语法(支持`ls`, `cat`, `grep`等Linux命令)
3. 路径请使用正斜杠`/`,如:`/d/document/项目名`
4. 中文路径请使用绝对路径并用双引号包裹
5. 避免使用`&&`连接符(PowerShell不支持),如需要可以分开执行**项目路径**:
- 项目根目录: `D:\document\BaiduSyncdisk\code\AI_code\项目名`
- 工作目录: 在Git Bash中当前位置**常用命令格式**:
- 运行脚本: `/d/ruanjian/miniconda/envs/ai_code/python.exe script.py`
- 安装依赖: `/d/ruanjian/miniconda/envs/ai_code/python.exe -m pip install package`
- 启动应用: `/d/ruanjian/miniconda/envs/ai_code/python.exe -m uvicorn main:app --reload`请根据以上环境信息提供可直接执行的命令。
📝 快速参考卡片
Python执行命令模板
# 基础执行
/d/ruanjian/miniconda/envs/ai_code/python.exe script.py# 带参数
/d/ruanjian/miniconda/envs/ai_code/python.exe script.py --arg value# 执行模块
/d/ruanjian/miniconda/envs/ai_code/python.exe -m module_name# 内联命令
/d/ruanjian/miniconda/envs/ai_code/python.exe -c "print('Hello')"# 安装包
/d/ruanjian/miniconda/envs/ai_code/python.exe -m pip install package# 查看版本
/d/ruanjian/miniconda/envs/ai_code/python.exe --version
Git Bash常用命令
# 导航
cd /d/document/项目
pwd
ls -la# 文件操作
cat file.txt
touch newfile.py
cp source.py dest.py
mv old.py new.py
rm file.py# 查找
find . -name "*.py"
grep -r "搜索内容" .# 后台执行
python script.py &
nohup python script.py &# 进程管理
ps aux | grep python
kill -9 PID
环境变量设置
# Git Bash
export VAR_NAME="value"
export PYTHONPATH="/d/project:$PYTHONPATH"# PowerShell
$env:VAR_NAME = "value"
$env:PYTHONPATH += ";D:\project"# 查看环境变量
echo $VAR_NAME # Git Bash
$env:VAR_NAME # PowerShell
🎯 最佳实践总结
DO ✅
- 使用Git Bash作为主要开发Shell环境
- 使用绝对路径执行Python脚本,避免环境混乱
- 路径统一使用正斜杠
/
分隔符 - 中文路径用双引号包裹
- 创建requirements.txt管理依赖
- 使用.gitignore排除无关文件
- 定期备份虚拟环境配置(
conda env export
) - 明确告知AI环境信息,避免命令不兼容
DON’T ❌
- ❌ 不要在PowerShell中使用
&&
连接符 - ❌ 不要混用不同shell的命令语法
- ❌ 不要依赖环境变量PATH(使用绝对路径更可靠)
- ❌ 不要在中文路径中使用相对路径
- ❌ 不要在全局环境安装包(使用虚拟环境)
- ❌ 不要提交虚拟环境到Git(使用requirements.txt)
- ❌ 不要假设AI知道您的环境配置(明确提供)
📌 版本历史
- v1.0 - 2024-10 - 初始版本,基于FastAPI项目开发经验总结
提示: 将本文档作为AI提示词的一部分,可以显著提高AI生成的命令的准确性和可执行性。
许可: 本文档可自由使用和修改,适用于任何Python项目开发场景。