copilot-instructions.md 2.8 KB

GitHub Copilot Agent 指令

Python 环境要求

重要:本项目必须在 mineru2 conda 环境下运行所有代码。

环境配置

  • Python 解释器: /opt/miniconda3/envs/mineru2/bin/python
  • Conda 环境: mineru2
  • Python 版本: 3.12+
  • 平台: macOS (Darwin)

执行命令时的要求

  1. 所有 Python 脚本执行前必须激活环境

    conda activate mineru2
    
  2. 直接使用完整路径

    /opt/miniconda3/envs/mineru2/bin/python script.py
    
  3. 使用 run_in_terminal 工具时,命令格式:

    conda activate mineru2 && python script.py
    

项目模块路径

确保以下路径在 PYTHONPATH 中:

  • 当前项目: /Users/zhch158/workspace/repository.git/ocr_platform
  • MinerU: /Users/zhch158/workspace/repository.git/MinerU
  • dots.ocr: /Users/zhch158/workspace/repository.git/dots.ocr
  • PaddleX: /Users/zhch158/workspace/repository.git/PaddleX

常用命令模板

运行 Streamlit 应用

cd ocr_validator && conda activate mineru2 && streamlit run streamlit_ocr_validator.py --server.runOnSave=true

运行 Python 脚本

conda activate mineru2 && python script.py

安装依赖

conda activate mineru2 && pip install package-name

运行测试

conda activate mineru2 && pytest tests/

禁止的操作

不要使用系统 Python

# 错误示例
python3 script.py
/usr/bin/python script.py

不要在其他虚拟环境中运行

# 错误示例
source venv/bin/activate

代码生成规则

  1. 生成的 Python 代码应该兼容 Python 3.12
  2. 导入语句要考虑项目模块路径
  3. 使用类型注解(遵循 PEP 484)
  4. 遵循项目现有的代码风格

依赖包说明

主要依赖(已安装在 mineru2 环境):

  • streamlit >= 1.30.0
  • plotly >= 5.18.0
  • pandas >= 2.1.0
  • torch >= 2.0.0
  • paddlepaddle >= 2.5.0
  • opencv-python >= 4.8.0
  • pillow >= 10.0.0

文件操作规则

  1. 创建新文件时,确保使用项目的模块导入路径
  2. 修改配置文件时,保持与 mineru2 环境的一致性
  3. 添加新的脚本时,在文件头部添加 shebang:

    #!/opt/miniconda3/envs/mineru2/bin/python
    

调试和测试

执行测试或调试时,始终使用:

conda activate mineru2 && python -m pytest
conda activate mineru2 && python -m pdb script.py

环境验证

在执行任何 Python 代码前,验证环境:

conda activate mineru2
python -c "import sys; print(sys.executable)"
# 应输出: /opt/miniconda3/envs/mineru2/bin/python

记住:任何涉及 Python 代码执行、包安装、测试运行的操作,都必须在 mineru2 环境下进行!