pyre-lsp

面向 sqlalchemy_db / pyre_starlette.models 的 Language Server（不是只绑 VS Code）。 同一套服务可被 VS Code、Cursor、Windsurf、Neovim、Zed 接入。

✨ 特点

• ⚡ 字段补全 — User.query.filter_by( 直接补字段 kwargs，User( 补构造参数。
• 🎯 签名提示 — SignatureHelp 随光标位置给出参数名与类型。
• 💬 类型 Hover — first() → User | None，all() → list[User]。
• 🧠 混入字段合并 — 继承 PkMixin / TimestampMixin 时字段自动合并到模型。
• 🔎 DTO 感知 — .from_entity( 补工作区内的 Pydantic DTO。
• 🔌 编辑器无关 — 标准 LSP 协议，VS Code / Cursor / Windsurf / Neovim / Zed / PyCharm 通用。
• 🚀 轻量 — 只依赖 pygls 与 lsprotocol，索引完全在本地完成。

📦 安装

pip install pyre-lsp

本地开发：

cd pyre_lsp
pip install -e .

验证：

python -m pyre_lsp --help
python tests/test_smoke.py

💡 效果一览

对本仓库实测索引：约 71 个 Model、128 个 DTO；Department 会合并 OmnModel 混入字段（id / create_time / 软删等）。

👩‍💻 目录结构

pyre-lsp
├── pyre_lsp
│   ├── __init__.py
│   ├── __main__.py    # python -m pyre_lsp
│   ├── server.py      # LSP 入口与能力注册
│   ├── parser.py      # 扫描 Model / Field / DTO
│   ├── cache.py       # 模型缓存与字段合并
│   ├── context.py     # 光标上下文（filter_by / first / …）
│   └── providers/     # Completion / Hover / SignatureHelp
├── vscode/            # 薄客户端（LanguageClient）
├── jetbrains/         # LSP4IJ 配置示例
├── tests/
└── pyproject.toml

🧩 VS Code / Cursor 扩展

cd pyre_lsp/vscode
npm install
npm run compile

然后任选其一：

1. 开发调试：用仓库根目录 .vscode/launch.json → Launch Pyre LSP Extension
2. 本机加载：命令面板 “Developer: Install Extension from Location…” 选 pyre_lsp/vscode

设置（可选）：

• pyreLsp.pythonPath：跑 python -m pyre_lsp 的解释器（默认 python）
• pyreLsp.serverPath：若已把 pyre-lsp 装进 PATH，可直接填可执行文件路径

🧩 PyCharm / IntelliJ（LSP4IJ）

PyCharm 本身不内置任意 LSP，用官方生态插件 LSP4IJ 接入即可（Community / Professional 都行）。

1. 安装 Language Server

在你项目用的那个 Python 解释器里：

cd pyre_lsp
pip install -e .

确认能启动：

pyre-lsp --help
# 或
python -m pyre_lsp --help

Windows 上若 pyre-lsp 不在 PATH，下面命令里用完整路径，例如：

D:\Python\Python311\Scripts\pyre-lsp.EXE

或统一用解释器模块方式（更稳）：

D:\Python\Python311\python.exe -m pyre_lsp

2. 安装 LSP4IJ

Settings → Plugins → Marketplace 搜索 LSP4IJ → Install → 重启。

插件页：LSP4IJ

3. 注册 User-defined Language Server

Settings → Languages & Frameworks → Language Servers → + → New user-defined language server

Mappings 页：

• Language / File type 选 Python（或 File name patterns：*.py）

保存后打开任意 .py，在 View → Tool Windows → Language Servers / LSP Consoles 里应能看到 Pyre LSP 已连接。

4. 验证

在代码里输入：

AdminUser.query.filter_by(

应出现字段 kwargs（如 avatar=）。鼠标悬停 first / all 应有返回类型提示。

5. 常见问题

• 没有补全：确认 Command 用的是「项目解释器」那套 Python（和 pip install -e . 同一环境）。
• 和官方 Python 补全抢位置：正常现象；Pyre 项会带字段语义，可继续输入字段名前缀过滤。
• 想看通信日志：Language Servers → 选中 Pyre LSP → Debug → Trace 调到 verbose，在 LSP Console 查看。

更细的 User-defined 配置说明见：LSP4IJ User-defined LS。

📌 说明

• 不会改写 Pylance 的类型推导；变量 user = User.query.first() 的类型仍由 Pylance 决定。
• 本 LSP 负责「写到 User( / filter_by( 时」的参数提示、字段补全，以及 first/all 等方法上的 Hover。
• 若以后要让 Pylance 也认识构造参数，可再加 .pyi 生成（与 LSP 互补）。

📄 许可

本项目基于 MIT 许可开源。