123 lines
4.0 KiB
Markdown
123 lines
4.0 KiB
Markdown
|
|
# 引用路径更新总结
|
|||
|
|
|
|||
|
|
## ✅ 已完成的更新
|
|||
|
|
|
|||
|
|
### 1. 工具脚本引用更新
|
|||
|
|
|
|||
|
|
**更新的文档**(6个):
|
|||
|
|
- ✅ `FINAL_OPTIMIZATION_GUIDE.md`
|
|||
|
|
- ✅ `ADVANCED_OPTIMIZATION_PLAN.md`
|
|||
|
|
- ✅ `docs/guides/DOCUMENTATION_CLEANUP_GUIDE.md`
|
|||
|
|
- ✅ `docs/guides/PROJECT_STRUCTURE_ANALYSIS.md`
|
|||
|
|
- ✅ `docs/guides/QUICK_REORGANIZE.md`
|
|||
|
|
- ✅ `docs/guides/REORGANIZATION_SUMMARY.md`
|
|||
|
|
|
|||
|
|
**更新内容**:
|
|||
|
|
- `python update_imports.py` → `python scripts/update_imports.py`
|
|||
|
|
- `python cleanup_duplicate_docs.py` → `python scripts/cleanup_duplicate_docs.py`
|
|||
|
|
- `update_imports.py` → `scripts/update_imports.py`
|
|||
|
|
- 等等...
|
|||
|
|
|
|||
|
|
### 2. 模块导入路径更新
|
|||
|
|
|
|||
|
|
**已更新的文件**:
|
|||
|
|
- ✅ `geo_tool.py` - 所有导入已更新为 `from modules.xxx import`
|
|||
|
|
- ✅ `modules/storage_example.py` - 导入已更新为 `from modules.data_storage import`
|
|||
|
|
- ✅ `storage_example.py` (根目录) - 导入已更新为 `from modules.data_storage import`
|
|||
|
|
|
|||
|
|
## 📋 引用路径对照表
|
|||
|
|
|
|||
|
|
### 工具脚本路径
|
|||
|
|
|
|||
|
|
| 旧路径 | 新路径 |
|
|||
|
|
|--------|--------|
|
|||
|
|
| `python update_imports.py` | `python scripts/update_imports.py` |
|
|||
|
|
| `python update_doc_references.py` | `python scripts/update_doc_references.py` |
|
|||
|
|
| `python cleanup_duplicate_docs.py` | `python scripts/cleanup_duplicate_docs.py` |
|
|||
|
|
| `python move_reorganization_docs.py` | `python scripts/move_reorganization_docs.py` |
|
|||
|
|
| `python reorganize_files.py` | `python scripts/reorganize_files.py` |
|
|||
|
|
|
|||
|
|
### 模块导入路径
|
|||
|
|
|
|||
|
|
| 旧导入 | 新导入 |
|
|||
|
|
|--------|--------|
|
|||
|
|
| `from data_storage import DataStorage` | `from modules.data_storage import DataStorage` |
|
|||
|
|
| `from keyword_tool import KeywordTool` | `from modules.keyword_tool import KeywordTool` |
|
|||
|
|
| `from content_scorer import ContentScorer` | `from modules.content_scorer import ContentScorer` |
|
|||
|
|
| ... | ... (所有模块都已更新) |
|
|||
|
|
|
|||
|
|
## ✅ 验证清单
|
|||
|
|
|
|||
|
|
### Python 导入验证
|
|||
|
|
- [x] `geo_tool.py` - 所有导入使用 `modules.xxx`
|
|||
|
|
- [x] `modules/storage_example.py` - 导入已更新
|
|||
|
|
- [x] `storage_example.py` (根目录) - 导入已更新
|
|||
|
|
- [x] 测试导入:`python -c "from modules.data_storage import DataStorage"` ✓
|
|||
|
|
|
|||
|
|
### 文档引用验证
|
|||
|
|
- [x] 所有文档中的工具脚本路径已更新为 `scripts/` 前缀
|
|||
|
|
- [x] 所有文档中的模块路径引用已更新(通过之前的 `update_doc_references.py`)
|
|||
|
|
|
|||
|
|
### 脚本路径验证
|
|||
|
|
- [ ] 移动脚本后,测试脚本是否仍可运行
|
|||
|
|
- [ ] 确认所有文档中的脚本路径正确
|
|||
|
|
|
|||
|
|
## 🎯 下一步操作
|
|||
|
|
|
|||
|
|
### 执行优化前
|
|||
|
|
|
|||
|
|
1. **确认所有引用已更新** ✅
|
|||
|
|
- Python 导入路径:已更新
|
|||
|
|
- 文档引用路径:已更新
|
|||
|
|
|
|||
|
|
2. **执行文件移动**
|
|||
|
|
```powershell
|
|||
|
|
# 步骤1:移动工具脚本
|
|||
|
|
python move_scripts.py
|
|||
|
|
|
|||
|
|
# 步骤2:清理重复模块(在确认导入路径正确后)
|
|||
|
|
python cleanup_duplicate_modules.py
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
3. **验证**
|
|||
|
|
```powershell
|
|||
|
|
# 测试脚本
|
|||
|
|
python scripts/update_imports.py
|
|||
|
|
|
|||
|
|
# 测试主程序
|
|||
|
|
streamlit run geo_tool.py
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 📝 注意事项
|
|||
|
|
|
|||
|
|
1. **工具脚本移动后**:
|
|||
|
|
- 使用方式:`python scripts/script_name.py`
|
|||
|
|
- 或在 `scripts/` 目录下运行:`cd scripts && python script_name.py`
|
|||
|
|
|
|||
|
|
2. **模块文件删除后**:
|
|||
|
|
- 确保 `modules/` 目录中有完整版本
|
|||
|
|
- 确保所有导入使用 `modules.xxx` 格式
|
|||
|
|
- 如有问题,可从 Git 恢复
|
|||
|
|
|
|||
|
|
3. **文档引用**:
|
|||
|
|
- 所有文档中的路径引用已自动更新
|
|||
|
|
- 如有遗漏,可手动检查并更新
|
|||
|
|
|
|||
|
|
## 🆘 如果遇到问题
|
|||
|
|
|
|||
|
|
### 问题1:脚本找不到
|
|||
|
|
**解决方案**:
|
|||
|
|
- 使用完整路径:`python scripts/script_name.py`
|
|||
|
|
- 或进入目录:`cd scripts && python script_name.py`
|
|||
|
|
|
|||
|
|
### 问题2:导入错误
|
|||
|
|
**解决方案**:
|
|||
|
|
- 检查导入路径:确认使用 `from modules.xxx import`
|
|||
|
|
- 检查 `modules/__init__.py` 是否存在
|
|||
|
|
- 从 Git 恢复文件:`git checkout HEAD -- filename.py`
|
|||
|
|
|
|||
|
|
### 问题3:文档链接失效
|
|||
|
|
**解决方案**:
|
|||
|
|
- 运行 `python scripts/update_doc_references.py` 更新文档引用
|
|||
|
|
- 运行 `python scripts/update_script_references.py` 更新脚本引用
|