leetcode-local-cli 0.7.2__tar.gz → 0.8.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/PKG-INFO +63 -22
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/README.md +62 -21
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/pyproject.toml +1 -1
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/auth.py +30 -60
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/cli.py +115 -20
- leetcode_local_cli-0.8.0/src/leetcode_local_cli/config.py +317 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/doctor.py +3 -5
- leetcode_local_cli-0.8.0/src/leetcode_local_cli/paths.py +95 -0
- leetcode_local_cli-0.8.0/src/leetcode_local_cli/safe_files.py +192 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/service.py +30 -17
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/ui.py +4 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/workspace.py +24 -22
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/LICENSE +0 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/__init__.py +0 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/__main__.py +0 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/client.py +0 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/problem.py +0 -0
- {leetcode_local_cli-0.7.2 → leetcode_local_cli-0.8.0}/src/leetcode_local_cli/version.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: leetcode-local-cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.8.0
|
|
4
4
|
Summary: Local coding workflow CLI for LeetCode CN.
|
|
5
5
|
Keywords: cli,leetcode,leetcode-cn,uv
|
|
6
6
|
Author: Aetherialter
|
|
@@ -24,24 +24,26 @@ Description-Content-Type: text/markdown
|
|
|
24
24
|
|
|
25
25
|
# 力扣中文站本地化刷题 CLI 工具
|
|
26
26
|
|
|
27
|
-
一个面向 LeetCode 中文站的轻量本地刷题 CLI
|
|
27
|
+
一个面向 LeetCode 中文站的轻量本地刷题 CLI。它复用浏览器登录态,在线获取题目,在显式配置的默认工作区维护单文件 `solution.py`,并支持本地测试和远程提交。
|
|
28
28
|
|
|
29
|
-
当前版本:`v0.
|
|
29
|
+
当前版本:`v0.8.0`
|
|
30
30
|
|
|
31
31
|
## 长期开发手册
|
|
32
32
|
|
|
33
|
-
[
|
|
33
|
+
[完整文档索引](docs/README.md)集中列出项目状态、架构、产品边界、技术决策、开发计划、安全审计和发布手册。
|
|
34
34
|
|
|
35
|
-
[
|
|
35
|
+
[v1.0 总体设计大纲](docs/PROJECT_DESIGN.md)记录了从当前版本演进到稳定 CLI 与 Python API 的长期架构、版本阶段和验收标准。该文档目前处于 Draft 状态,具体实施前仍需按阶段审查。
|
|
36
|
+
|
|
37
|
+
[产品边界与待定决策](docs/PRODUCT_BOUNDARIES.md)记录当前已经确认的行为,以及必须先由维护者拍板才能实现的测试、提交、工作区、编辑器和兼容性语义。[安全审计与修复清单](docs/SECURITY_REVIEW.md)记录当前源码仍需处理的风险。
|
|
36
38
|
|
|
37
39
|
## 核心能力
|
|
38
40
|
|
|
39
41
|
- 读取 Chrome 中的 `leetcode.cn` Cookie,复用登录态。
|
|
40
42
|
- 在线获取题目详情和题目索引。
|
|
41
|
-
-
|
|
43
|
+
- 使用 `lc init` 配置的默认工作区和单个 `solution.py`。
|
|
42
44
|
- `lc solve <题号>` 生成可编辑的 Python 解题模板。
|
|
43
45
|
- 生成模板后会按当前系统尝试打开 `solution.py`。
|
|
44
|
-
- `lc test`
|
|
46
|
+
- `lc test` 执行本地 `solution.py`;`run_cases()` 的最终调用契约仍在产品边界文档中待定。
|
|
45
47
|
- `lc doctor` 一次检查 Session 文件、站点连通性、Cookie 登录态和本地解题文件。
|
|
46
48
|
- `lc submit` 提交 marker 区域代码到 LeetCode 中文站,并轮询判题结果。
|
|
47
49
|
- 生成模板时写入 `problem_id` 和 `submit_question_id`,避免展示题号和 LeetCode 内部提交 ID 混用。
|
|
@@ -60,16 +62,16 @@ Description-Content-Type: text/markdown
|
|
|
60
62
|
Linux / macOS 一键安装:
|
|
61
63
|
|
|
62
64
|
```bash
|
|
63
|
-
curl -LsSf https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.
|
|
65
|
+
curl -LsSf https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.8.0/scripts/install.sh | sh
|
|
64
66
|
```
|
|
65
67
|
|
|
66
68
|
Windows PowerShell 一键安装:
|
|
67
69
|
|
|
68
70
|
```powershell
|
|
69
|
-
powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.
|
|
71
|
+
powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.8.0/scripts/install.ps1 | iex"
|
|
70
72
|
```
|
|
71
73
|
|
|
72
|
-
安装器要求系统已安装 uv;如果未检测到 uv,会安全退出并提示访问 [uv 官方文档](https://docs.astral.sh/uv/),不会自动下载或执行第三方远端安装脚本。检测到 uv 后,安装器会使用 `uv tool install` 安装 `leetcode-local-cli
|
|
74
|
+
安装器要求系统已安装 uv;如果未检测到 uv,会安全退出并提示访问 [uv 官方文档](https://docs.astral.sh/uv/),不会自动下载或执行第三方远端安装脚本。检测到 uv 后,安装器会使用 `uv tool install` 安装 `leetcode-local-cli`,执行绝对路径的 `lc --version` 验证结果,并在可交互终端继续运行 `lc init`。安装过程不使用 `sudo`,也不会保存 PyPI 或 GitHub 凭据。
|
|
73
75
|
|
|
74
76
|
已经安装 uv 时,也可以直接安装:
|
|
75
77
|
|
|
@@ -77,6 +79,20 @@ powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.c
|
|
|
77
79
|
uv tool install leetcode-local-cli
|
|
78
80
|
```
|
|
79
81
|
|
|
82
|
+
直接执行 `uv tool install` 不会运行项目自定义的安装后交互。首次使用前还需要手动执行:
|
|
83
|
+
|
|
84
|
+
```shell
|
|
85
|
+
lc init
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
自动化或 AI 验收可以显式指定完整工作区路径:
|
|
89
|
+
|
|
90
|
+
```shell
|
|
91
|
+
lc init D:/Projects/leetcode-local-cli --yes
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
官方安装器在非交互环境中不会等待输入,而是提示稍后手动执行 `lc init`。CI 可设置 `LEETCODE_LOCAL_CLI_NO_INIT=1` 显式跳过。版本更新发现有效默认工作区时会直接复用,不会重新询问、清空 `solution.py` 或修改工作区配置。
|
|
95
|
+
|
|
80
96
|
升级或卸载:
|
|
81
97
|
|
|
82
98
|
```shell
|
|
@@ -89,6 +105,7 @@ uv tool uninstall leetcode-local-cli
|
|
|
89
105
|
## 基本工作流
|
|
90
106
|
|
|
91
107
|
```shell
|
|
108
|
+
lc init
|
|
92
109
|
lc login
|
|
93
110
|
lc doctor
|
|
94
111
|
lc status
|
|
@@ -102,12 +119,14 @@ lc submit
|
|
|
102
119
|
|
|
103
120
|
| 命令 | 作用 |
|
|
104
121
|
| --- | --- |
|
|
122
|
+
| `lc init` | 交互输入父目录并创建或复用默认 `leetcode-local-cli` 工作区 |
|
|
123
|
+
| `lc init <完整路径> --yes` | 非交互配置明确的完整工作区路径,适合 AI/CI 验收 |
|
|
105
124
|
| `lc login` | 读取或手动录入 LeetCode 中文站 Cookie |
|
|
106
125
|
| `lc status` | 检查当前登录态 |
|
|
107
126
|
| `lc profile` | 展示账号和刷题统计 |
|
|
108
127
|
| `lc show --limit 20 --skip 0` | 分页展示题目索引,`limit` 单次最大为 100 |
|
|
109
128
|
| `lc get <题号>` | 在线展示题目详情 |
|
|
110
|
-
| `lc solve <题号>` |
|
|
129
|
+
| `lc solve <题号>` | 原子覆盖生成默认工作区的 `solution.py` |
|
|
111
130
|
| `lc test` | 运行本地 `solution.py` |
|
|
112
131
|
| `lc doctor` | 诊断 Session、网络、Cookie 和 `solution.py`,默认不执行代码 |
|
|
113
132
|
| `lc doctor --run-solution` | 额外运行当前工作区的 `solution.py` |
|
|
@@ -115,7 +134,9 @@ lc submit
|
|
|
115
134
|
|
|
116
135
|
## solution.py 规则
|
|
117
136
|
|
|
118
|
-
`lc solve`
|
|
137
|
+
`lc init` 会创建不存在的空 `solution.py`,但已有普通文件会完整保留。`lc solve` 会创建不存在的 `solution.py`,也会原子覆盖默认工作区中的普通 `solution.py`。切换题目前请自行保存当前解法。
|
|
138
|
+
|
|
139
|
+
如果工作区、配置或同名文件是符号链接、断链、目录链接、Windows junction 或其他 reparse point,初始化或写入会拒绝并以非零状态退出。普通文件覆盖使用同目录随机临时文件和原子替换,写入失败不会先截断旧解法。
|
|
119
140
|
|
|
120
141
|
生成文件会包含题目元信息和提交区域:
|
|
121
142
|
|
|
@@ -149,12 +170,12 @@ class Solution:
|
|
|
149
170
|
- 当前仅自动读取 Chrome Cookie。
|
|
150
171
|
- `lc solve` 生成模板后会尝试打开 `solution.py`;Windows 使用系统默认打开方式,macOS 使用 `open`,Linux 使用 `xdg-open`。
|
|
151
172
|
- 当前远程提交仅支持 Python3。
|
|
152
|
-
-
|
|
173
|
+
- 当前只维护用户配置所指向的单个默认工作区和单个 `solution.py`,不会生成每题独立目录,也不提供全局 `--workspace`。
|
|
153
174
|
- 当前不保存完整题面到本地,也不引入本地数据库。
|
|
154
|
-
- `lc solve`
|
|
175
|
+
- `lc solve` 会强制覆盖普通 `solution.py`,但拒绝符号链接、断链、目录、目录链接和 Windows reparse point。
|
|
155
176
|
- `lc show` 的 `limit` 必须为正整数且不超过 100,`skip` 必须为非负整数。
|
|
156
177
|
- `lc test` 默认隐藏 Python traceback,只展示本地测试通过或失败。
|
|
157
|
-
-
|
|
178
|
+
- 当前 `lc test` 执行整个 `solution.py`,不验证或主动调用 `run_cases()`;缺少该函数的非空脚本可能显示通过,此行为正在重新定界。
|
|
158
179
|
- 树、链表等题型中,LeetCode 模板里的 `TreeNode` / `ListNode` 定义默认保持注释状态;如需本地构造用例,请自行取消注释并编写测试数据。
|
|
159
180
|
- `lc doctor` 会向 LeetCode 中文站发送一次登录态查询,并静态检查 `solution.py` 的存在性、可读性、Python 语法和提交结构;默认不会执行文件。
|
|
160
181
|
- `lc doctor --run-solution` 会额外运行语法有效的 `solution.py`,本地运行超过 10 秒会判定失败。
|
|
@@ -162,17 +183,19 @@ class Solution:
|
|
|
162
183
|
|
|
163
184
|
## 安全说明
|
|
164
185
|
|
|
165
|
-
|
|
186
|
+
登录态会保存到默认工作区:
|
|
166
187
|
|
|
167
188
|
```text
|
|
168
189
|
.leetcode_local_cli/session.json
|
|
169
190
|
```
|
|
170
191
|
|
|
171
|
-
|
|
192
|
+
该文件包含敏感 Cookie 信息,当前仓库已在 `.gitignore` 中忽略。v0.8 不读取、迁移或删除旧 `.aether_lc/session.json`,也暂不接入操作系统凭据管理器;这是为维护者授权 AI 使用真实账号验收而保留的阶段性方案,不是长期安全终点。不要把工作区放进同步盘或共享目录,不要输出、暂存、提交或上传 Session 内容。发布前请确认仓库根目录的 `solution.py` 为空。
|
|
193
|
+
|
|
194
|
+
仓库还会忽略常见个人编辑器目录、`.env*` 和常见凭据 JSON 文件名,并通过测试检查已跟踪 JSON 中的高风险秘密字段。不要使用 `git add -f` 强制添加这些文件;提交前仍应检查 `git status`,因为 `.gitignore` 不能替代秘密扫描,也不能保护已经被跟踪的文件。
|
|
172
195
|
|
|
173
196
|
## 登录态说明
|
|
174
197
|
|
|
175
|
-
`leetcode-local-cli` 会把浏览器 Cookie
|
|
198
|
+
`leetcode-local-cli` 会把浏览器 Cookie 的本地副本保存到默认工作区的 `.leetcode_local_cli/session.json`。本地保存的 Cookie 不会延长 LeetCode 登录态有效期;实际是否有效以 LeetCode 服务端验证为准。`lc init`、版本更新和工具卸载都不会覆盖或删除该文件。
|
|
176
199
|
|
|
177
200
|
如果浏览器 Cookie 刷新,或旧 Cookie 被服务端判定失效,CLI 可能在 `lc status`、`lc profile` 或 `lc submit` 时提示重新执行:
|
|
178
201
|
|
|
@@ -210,7 +233,7 @@ uv run lc test
|
|
|
210
233
|
uv run ruff check solution.py
|
|
211
234
|
```
|
|
212
235
|
|
|
213
|
-
维护者发布流程见 [
|
|
236
|
+
维护者发布流程见 [发布手册](docs/RELEASING.md)。标签触发的发布工作流会在 Linux、macOS 和 Windows 上验收安装器,分别验证 wheel 与源码包,通过 PyPI Trusted Publisher 上传发行包,并创建 GitHub Release。
|
|
214
237
|
|
|
215
238
|
## 项目结构
|
|
216
239
|
|
|
@@ -219,8 +242,11 @@ src/leetcode_local_cli/
|
|
|
219
242
|
auth.py Cookie 读取与本地 session
|
|
220
243
|
client.py LeetCode 中文站 HTTP 客户端
|
|
221
244
|
cli.py Typer 命令入口
|
|
245
|
+
config.py 版本化配置读取与工作区初始化
|
|
222
246
|
doctor.py 本地环境、网络与登录态诊断
|
|
247
|
+
paths.py 跨平台路径与 AppPaths 运行上下文
|
|
223
248
|
problem.py 题号解析与题目数据标准化
|
|
249
|
+
safe_files.py 非普通目标拒绝与原子文件写入
|
|
224
250
|
service.py 应用层流程编排
|
|
225
251
|
ui.py Rich 终端输出
|
|
226
252
|
version.py 已安装发行版版本读取
|
|
@@ -231,14 +257,28 @@ scripts/
|
|
|
231
257
|
smoke_test.py wheel 与源码包发布验收
|
|
232
258
|
.github/workflows/
|
|
233
259
|
release.yml 跨平台验证、PyPI 发布与 GitHub Release
|
|
260
|
+
docs/
|
|
261
|
+
README.md 文档索引与权威顺序
|
|
262
|
+
PROJECT_STATUS.md 当前实现状态
|
|
263
|
+
ARCHITECTURE.md 当前架构与数据流
|
|
264
|
+
PRODUCT_BOUNDARIES.md 已确认边界与待定决策
|
|
265
|
+
TECH_DECISIONS.md 技术决策记录
|
|
266
|
+
DEVELOPMENT_PLAN.md 唯一长期开发路线
|
|
267
|
+
PROJECT_DESIGN.md v1.0 长期架构设计
|
|
268
|
+
SECURITY_REVIEW.md 当前安全与可靠性问题
|
|
269
|
+
RELEASING.md 发布流程
|
|
270
|
+
release-notes/ 版本化发布说明
|
|
234
271
|
tests/
|
|
235
272
|
test_auth.py
|
|
236
273
|
test_cli.py
|
|
237
274
|
test_client.py
|
|
275
|
+
test_config.py
|
|
238
276
|
test_doctor.py
|
|
239
277
|
test_install_scripts.py
|
|
240
278
|
test_problem.py
|
|
279
|
+
test_paths.py
|
|
241
280
|
test_release.py
|
|
281
|
+
test_safe_files.py
|
|
242
282
|
test_service.py
|
|
243
283
|
test_ui.py
|
|
244
284
|
test_workspace.py
|
|
@@ -255,9 +295,10 @@ tests/
|
|
|
255
295
|
- `v0.7.0`: uv 全局工具安装、跨平台引导脚本和 PyPI Trusted Publisher 发布流程。
|
|
256
296
|
- `v0.7.1`: 修正安装版 CLI 的命令建议,并引入版本化 GitHub Release Notes。
|
|
257
297
|
- `v0.7.2`: 收紧安全边界,避免诊断命令默认执行解题文件,并移除安装器的远端脚本执行。
|
|
258
|
-
- `v0.8`:
|
|
259
|
-
- `v0.9`:
|
|
260
|
-
- `v0.10`:
|
|
298
|
+
- `v0.8.0`: 新增显式运行上下文、版本化配置、`lc init`、默认工作区和安装后初始化。
|
|
299
|
+
- `v0.9`: 领域模型、异常与 Python API 预览。
|
|
300
|
+
- `v0.10`: 双站点客户端与独立账号体系。
|
|
301
|
+
- 后续版本:CLI 迁移、题面与 UI、源码收口和发布加固,详见[长期开发计划](docs/DEVELOPMENT_PLAN.md)。
|
|
261
302
|
- `v1.0`: 稳定轻量 CLI。
|
|
262
303
|
|
|
263
304
|
## License
|
|
@@ -1,23 +1,25 @@
|
|
|
1
1
|
# 力扣中文站本地化刷题 CLI 工具
|
|
2
2
|
|
|
3
|
-
一个面向 LeetCode 中文站的轻量本地刷题 CLI
|
|
3
|
+
一个面向 LeetCode 中文站的轻量本地刷题 CLI。它复用浏览器登录态,在线获取题目,在显式配置的默认工作区维护单文件 `solution.py`,并支持本地测试和远程提交。
|
|
4
4
|
|
|
5
|
-
当前版本:`v0.
|
|
5
|
+
当前版本:`v0.8.0`
|
|
6
6
|
|
|
7
7
|
## 长期开发手册
|
|
8
8
|
|
|
9
|
-
[
|
|
9
|
+
[完整文档索引](docs/README.md)集中列出项目状态、架构、产品边界、技术决策、开发计划、安全审计和发布手册。
|
|
10
10
|
|
|
11
|
-
[
|
|
11
|
+
[v1.0 总体设计大纲](docs/PROJECT_DESIGN.md)记录了从当前版本演进到稳定 CLI 与 Python API 的长期架构、版本阶段和验收标准。该文档目前处于 Draft 状态,具体实施前仍需按阶段审查。
|
|
12
|
+
|
|
13
|
+
[产品边界与待定决策](docs/PRODUCT_BOUNDARIES.md)记录当前已经确认的行为,以及必须先由维护者拍板才能实现的测试、提交、工作区、编辑器和兼容性语义。[安全审计与修复清单](docs/SECURITY_REVIEW.md)记录当前源码仍需处理的风险。
|
|
12
14
|
|
|
13
15
|
## 核心能力
|
|
14
16
|
|
|
15
17
|
- 读取 Chrome 中的 `leetcode.cn` Cookie,复用登录态。
|
|
16
18
|
- 在线获取题目详情和题目索引。
|
|
17
|
-
-
|
|
19
|
+
- 使用 `lc init` 配置的默认工作区和单个 `solution.py`。
|
|
18
20
|
- `lc solve <题号>` 生成可编辑的 Python 解题模板。
|
|
19
21
|
- 生成模板后会按当前系统尝试打开 `solution.py`。
|
|
20
|
-
- `lc test`
|
|
22
|
+
- `lc test` 执行本地 `solution.py`;`run_cases()` 的最终调用契约仍在产品边界文档中待定。
|
|
21
23
|
- `lc doctor` 一次检查 Session 文件、站点连通性、Cookie 登录态和本地解题文件。
|
|
22
24
|
- `lc submit` 提交 marker 区域代码到 LeetCode 中文站,并轮询判题结果。
|
|
23
25
|
- 生成模板时写入 `problem_id` 和 `submit_question_id`,避免展示题号和 LeetCode 内部提交 ID 混用。
|
|
@@ -36,16 +38,16 @@
|
|
|
36
38
|
Linux / macOS 一键安装:
|
|
37
39
|
|
|
38
40
|
```bash
|
|
39
|
-
curl -LsSf https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.
|
|
41
|
+
curl -LsSf https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.8.0/scripts/install.sh | sh
|
|
40
42
|
```
|
|
41
43
|
|
|
42
44
|
Windows PowerShell 一键安装:
|
|
43
45
|
|
|
44
46
|
```powershell
|
|
45
|
-
powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.
|
|
47
|
+
powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.com/Aetherialter/leetcode-local-cli/v0.8.0/scripts/install.ps1 | iex"
|
|
46
48
|
```
|
|
47
49
|
|
|
48
|
-
安装器要求系统已安装 uv;如果未检测到 uv,会安全退出并提示访问 [uv 官方文档](https://docs.astral.sh/uv/),不会自动下载或执行第三方远端安装脚本。检测到 uv 后,安装器会使用 `uv tool install` 安装 `leetcode-local-cli
|
|
50
|
+
安装器要求系统已安装 uv;如果未检测到 uv,会安全退出并提示访问 [uv 官方文档](https://docs.astral.sh/uv/),不会自动下载或执行第三方远端安装脚本。检测到 uv 后,安装器会使用 `uv tool install` 安装 `leetcode-local-cli`,执行绝对路径的 `lc --version` 验证结果,并在可交互终端继续运行 `lc init`。安装过程不使用 `sudo`,也不会保存 PyPI 或 GitHub 凭据。
|
|
49
51
|
|
|
50
52
|
已经安装 uv 时,也可以直接安装:
|
|
51
53
|
|
|
@@ -53,6 +55,20 @@ powershell -ExecutionPolicy ByPass -Command "irm https://raw.githubusercontent.c
|
|
|
53
55
|
uv tool install leetcode-local-cli
|
|
54
56
|
```
|
|
55
57
|
|
|
58
|
+
直接执行 `uv tool install` 不会运行项目自定义的安装后交互。首次使用前还需要手动执行:
|
|
59
|
+
|
|
60
|
+
```shell
|
|
61
|
+
lc init
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
自动化或 AI 验收可以显式指定完整工作区路径:
|
|
65
|
+
|
|
66
|
+
```shell
|
|
67
|
+
lc init D:/Projects/leetcode-local-cli --yes
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
官方安装器在非交互环境中不会等待输入,而是提示稍后手动执行 `lc init`。CI 可设置 `LEETCODE_LOCAL_CLI_NO_INIT=1` 显式跳过。版本更新发现有效默认工作区时会直接复用,不会重新询问、清空 `solution.py` 或修改工作区配置。
|
|
71
|
+
|
|
56
72
|
升级或卸载:
|
|
57
73
|
|
|
58
74
|
```shell
|
|
@@ -65,6 +81,7 @@ uv tool uninstall leetcode-local-cli
|
|
|
65
81
|
## 基本工作流
|
|
66
82
|
|
|
67
83
|
```shell
|
|
84
|
+
lc init
|
|
68
85
|
lc login
|
|
69
86
|
lc doctor
|
|
70
87
|
lc status
|
|
@@ -78,12 +95,14 @@ lc submit
|
|
|
78
95
|
|
|
79
96
|
| 命令 | 作用 |
|
|
80
97
|
| --- | --- |
|
|
98
|
+
| `lc init` | 交互输入父目录并创建或复用默认 `leetcode-local-cli` 工作区 |
|
|
99
|
+
| `lc init <完整路径> --yes` | 非交互配置明确的完整工作区路径,适合 AI/CI 验收 |
|
|
81
100
|
| `lc login` | 读取或手动录入 LeetCode 中文站 Cookie |
|
|
82
101
|
| `lc status` | 检查当前登录态 |
|
|
83
102
|
| `lc profile` | 展示账号和刷题统计 |
|
|
84
103
|
| `lc show --limit 20 --skip 0` | 分页展示题目索引,`limit` 单次最大为 100 |
|
|
85
104
|
| `lc get <题号>` | 在线展示题目详情 |
|
|
86
|
-
| `lc solve <题号>` |
|
|
105
|
+
| `lc solve <题号>` | 原子覆盖生成默认工作区的 `solution.py` |
|
|
87
106
|
| `lc test` | 运行本地 `solution.py` |
|
|
88
107
|
| `lc doctor` | 诊断 Session、网络、Cookie 和 `solution.py`,默认不执行代码 |
|
|
89
108
|
| `lc doctor --run-solution` | 额外运行当前工作区的 `solution.py` |
|
|
@@ -91,7 +110,9 @@ lc submit
|
|
|
91
110
|
|
|
92
111
|
## solution.py 规则
|
|
93
112
|
|
|
94
|
-
`lc solve`
|
|
113
|
+
`lc init` 会创建不存在的空 `solution.py`,但已有普通文件会完整保留。`lc solve` 会创建不存在的 `solution.py`,也会原子覆盖默认工作区中的普通 `solution.py`。切换题目前请自行保存当前解法。
|
|
114
|
+
|
|
115
|
+
如果工作区、配置或同名文件是符号链接、断链、目录链接、Windows junction 或其他 reparse point,初始化或写入会拒绝并以非零状态退出。普通文件覆盖使用同目录随机临时文件和原子替换,写入失败不会先截断旧解法。
|
|
95
116
|
|
|
96
117
|
生成文件会包含题目元信息和提交区域:
|
|
97
118
|
|
|
@@ -125,12 +146,12 @@ class Solution:
|
|
|
125
146
|
- 当前仅自动读取 Chrome Cookie。
|
|
126
147
|
- `lc solve` 生成模板后会尝试打开 `solution.py`;Windows 使用系统默认打开方式,macOS 使用 `open`,Linux 使用 `xdg-open`。
|
|
127
148
|
- 当前远程提交仅支持 Python3。
|
|
128
|
-
-
|
|
149
|
+
- 当前只维护用户配置所指向的单个默认工作区和单个 `solution.py`,不会生成每题独立目录,也不提供全局 `--workspace`。
|
|
129
150
|
- 当前不保存完整题面到本地,也不引入本地数据库。
|
|
130
|
-
- `lc solve`
|
|
151
|
+
- `lc solve` 会强制覆盖普通 `solution.py`,但拒绝符号链接、断链、目录、目录链接和 Windows reparse point。
|
|
131
152
|
- `lc show` 的 `limit` 必须为正整数且不超过 100,`skip` 必须为非负整数。
|
|
132
153
|
- `lc test` 默认隐藏 Python traceback,只展示本地测试通过或失败。
|
|
133
|
-
-
|
|
154
|
+
- 当前 `lc test` 执行整个 `solution.py`,不验证或主动调用 `run_cases()`;缺少该函数的非空脚本可能显示通过,此行为正在重新定界。
|
|
134
155
|
- 树、链表等题型中,LeetCode 模板里的 `TreeNode` / `ListNode` 定义默认保持注释状态;如需本地构造用例,请自行取消注释并编写测试数据。
|
|
135
156
|
- `lc doctor` 会向 LeetCode 中文站发送一次登录态查询,并静态检查 `solution.py` 的存在性、可读性、Python 语法和提交结构;默认不会执行文件。
|
|
136
157
|
- `lc doctor --run-solution` 会额外运行语法有效的 `solution.py`,本地运行超过 10 秒会判定失败。
|
|
@@ -138,17 +159,19 @@ class Solution:
|
|
|
138
159
|
|
|
139
160
|
## 安全说明
|
|
140
161
|
|
|
141
|
-
|
|
162
|
+
登录态会保存到默认工作区:
|
|
142
163
|
|
|
143
164
|
```text
|
|
144
165
|
.leetcode_local_cli/session.json
|
|
145
166
|
```
|
|
146
167
|
|
|
147
|
-
|
|
168
|
+
该文件包含敏感 Cookie 信息,当前仓库已在 `.gitignore` 中忽略。v0.8 不读取、迁移或删除旧 `.aether_lc/session.json`,也暂不接入操作系统凭据管理器;这是为维护者授权 AI 使用真实账号验收而保留的阶段性方案,不是长期安全终点。不要把工作区放进同步盘或共享目录,不要输出、暂存、提交或上传 Session 内容。发布前请确认仓库根目录的 `solution.py` 为空。
|
|
169
|
+
|
|
170
|
+
仓库还会忽略常见个人编辑器目录、`.env*` 和常见凭据 JSON 文件名,并通过测试检查已跟踪 JSON 中的高风险秘密字段。不要使用 `git add -f` 强制添加这些文件;提交前仍应检查 `git status`,因为 `.gitignore` 不能替代秘密扫描,也不能保护已经被跟踪的文件。
|
|
148
171
|
|
|
149
172
|
## 登录态说明
|
|
150
173
|
|
|
151
|
-
`leetcode-local-cli` 会把浏览器 Cookie
|
|
174
|
+
`leetcode-local-cli` 会把浏览器 Cookie 的本地副本保存到默认工作区的 `.leetcode_local_cli/session.json`。本地保存的 Cookie 不会延长 LeetCode 登录态有效期;实际是否有效以 LeetCode 服务端验证为准。`lc init`、版本更新和工具卸载都不会覆盖或删除该文件。
|
|
152
175
|
|
|
153
176
|
如果浏览器 Cookie 刷新,或旧 Cookie 被服务端判定失效,CLI 可能在 `lc status`、`lc profile` 或 `lc submit` 时提示重新执行:
|
|
154
177
|
|
|
@@ -186,7 +209,7 @@ uv run lc test
|
|
|
186
209
|
uv run ruff check solution.py
|
|
187
210
|
```
|
|
188
211
|
|
|
189
|
-
维护者发布流程见 [
|
|
212
|
+
维护者发布流程见 [发布手册](docs/RELEASING.md)。标签触发的发布工作流会在 Linux、macOS 和 Windows 上验收安装器,分别验证 wheel 与源码包,通过 PyPI Trusted Publisher 上传发行包,并创建 GitHub Release。
|
|
190
213
|
|
|
191
214
|
## 项目结构
|
|
192
215
|
|
|
@@ -195,8 +218,11 @@ src/leetcode_local_cli/
|
|
|
195
218
|
auth.py Cookie 读取与本地 session
|
|
196
219
|
client.py LeetCode 中文站 HTTP 客户端
|
|
197
220
|
cli.py Typer 命令入口
|
|
221
|
+
config.py 版本化配置读取与工作区初始化
|
|
198
222
|
doctor.py 本地环境、网络与登录态诊断
|
|
223
|
+
paths.py 跨平台路径与 AppPaths 运行上下文
|
|
199
224
|
problem.py 题号解析与题目数据标准化
|
|
225
|
+
safe_files.py 非普通目标拒绝与原子文件写入
|
|
200
226
|
service.py 应用层流程编排
|
|
201
227
|
ui.py Rich 终端输出
|
|
202
228
|
version.py 已安装发行版版本读取
|
|
@@ -207,14 +233,28 @@ scripts/
|
|
|
207
233
|
smoke_test.py wheel 与源码包发布验收
|
|
208
234
|
.github/workflows/
|
|
209
235
|
release.yml 跨平台验证、PyPI 发布与 GitHub Release
|
|
236
|
+
docs/
|
|
237
|
+
README.md 文档索引与权威顺序
|
|
238
|
+
PROJECT_STATUS.md 当前实现状态
|
|
239
|
+
ARCHITECTURE.md 当前架构与数据流
|
|
240
|
+
PRODUCT_BOUNDARIES.md 已确认边界与待定决策
|
|
241
|
+
TECH_DECISIONS.md 技术决策记录
|
|
242
|
+
DEVELOPMENT_PLAN.md 唯一长期开发路线
|
|
243
|
+
PROJECT_DESIGN.md v1.0 长期架构设计
|
|
244
|
+
SECURITY_REVIEW.md 当前安全与可靠性问题
|
|
245
|
+
RELEASING.md 发布流程
|
|
246
|
+
release-notes/ 版本化发布说明
|
|
210
247
|
tests/
|
|
211
248
|
test_auth.py
|
|
212
249
|
test_cli.py
|
|
213
250
|
test_client.py
|
|
251
|
+
test_config.py
|
|
214
252
|
test_doctor.py
|
|
215
253
|
test_install_scripts.py
|
|
216
254
|
test_problem.py
|
|
255
|
+
test_paths.py
|
|
217
256
|
test_release.py
|
|
257
|
+
test_safe_files.py
|
|
218
258
|
test_service.py
|
|
219
259
|
test_ui.py
|
|
220
260
|
test_workspace.py
|
|
@@ -231,9 +271,10 @@ tests/
|
|
|
231
271
|
- `v0.7.0`: uv 全局工具安装、跨平台引导脚本和 PyPI Trusted Publisher 发布流程。
|
|
232
272
|
- `v0.7.1`: 修正安装版 CLI 的命令建议,并引入版本化 GitHub Release Notes。
|
|
233
273
|
- `v0.7.2`: 收紧安全边界,避免诊断命令默认执行解题文件,并移除安装器的远端脚本执行。
|
|
234
|
-
- `v0.8`:
|
|
235
|
-
- `v0.9`:
|
|
236
|
-
- `v0.10`:
|
|
274
|
+
- `v0.8.0`: 新增显式运行上下文、版本化配置、`lc init`、默认工作区和安装后初始化。
|
|
275
|
+
- `v0.9`: 领域模型、异常与 Python API 预览。
|
|
276
|
+
- `v0.10`: 双站点客户端与独立账号体系。
|
|
277
|
+
- 后续版本:CLI 迁移、题面与 UI、源码收口和发布加固,详见[长期开发计划](docs/DEVELOPMENT_PLAN.md)。
|
|
237
278
|
- `v1.0`: 稳定轻量 CLI。
|
|
238
279
|
|
|
239
280
|
## License
|
|
@@ -6,6 +6,13 @@ from enum import Enum
|
|
|
6
6
|
from getpass import getpass
|
|
7
7
|
from pathlib import Path
|
|
8
8
|
|
|
9
|
+
from leetcode_local_cli.safe_files import (
|
|
10
|
+
SafeFileError,
|
|
11
|
+
atomic_write_text,
|
|
12
|
+
ensure_regular_directory,
|
|
13
|
+
validate_regular_file_target,
|
|
14
|
+
)
|
|
15
|
+
|
|
9
16
|
|
|
10
17
|
with warnings.catch_warnings():
|
|
11
18
|
# wmi 1.5.1, imported transitively by browser-cookie3 on Windows, contains
|
|
@@ -23,11 +30,6 @@ LC_DOMAIN = "leetcode.cn"
|
|
|
23
30
|
BROWSER_LOADERS = [("Chrome", browser_cookie3.chrome)]
|
|
24
31
|
|
|
25
32
|
REQUIRED_COOKIE_NAMES = ("LEETCODE_SESSION", "csrftoken")
|
|
26
|
-
PROJECT_ROOT = Path.cwd()
|
|
27
|
-
SESSION_DIR = PROJECT_ROOT / ".leetcode_local_cli"
|
|
28
|
-
SESSION_FILE = SESSION_DIR / "session.json"
|
|
29
|
-
LEGACY_SESSION_DIR = PROJECT_ROOT / ".aether_lc"
|
|
30
|
-
LEGACY_SESSION_FILE = LEGACY_SESSION_DIR / "session.json"
|
|
31
33
|
|
|
32
34
|
|
|
33
35
|
class SessionFileStatus(str, Enum):
|
|
@@ -51,31 +53,6 @@ class SessionFileError(OSError):
|
|
|
51
53
|
pass
|
|
52
54
|
|
|
53
55
|
|
|
54
|
-
def _resolve_default_session_file() -> Path:
|
|
55
|
-
"""Move the pre-v0.7 session to the canonical directory when possible."""
|
|
56
|
-
if SESSION_FILE.exists() or not LEGACY_SESSION_FILE.exists():
|
|
57
|
-
return SESSION_FILE
|
|
58
|
-
|
|
59
|
-
try:
|
|
60
|
-
SESSION_DIR.mkdir(mode=0o700, parents=True, exist_ok=True)
|
|
61
|
-
if os.name != "nt":
|
|
62
|
-
os.chmod(SESSION_DIR, 0o700)
|
|
63
|
-
LEGACY_SESSION_FILE.replace(SESSION_FILE)
|
|
64
|
-
if os.name != "nt":
|
|
65
|
-
os.chmod(SESSION_FILE, 0o600)
|
|
66
|
-
try:
|
|
67
|
-
LEGACY_SESSION_DIR.rmdir()
|
|
68
|
-
except OSError:
|
|
69
|
-
# Preserve a non-empty legacy directory instead of deleting unrelated data.
|
|
70
|
-
pass
|
|
71
|
-
except OSError:
|
|
72
|
-
if SESSION_FILE.exists():
|
|
73
|
-
return SESSION_FILE
|
|
74
|
-
return LEGACY_SESSION_FILE
|
|
75
|
-
|
|
76
|
-
return SESSION_FILE
|
|
77
|
-
|
|
78
|
-
|
|
79
56
|
def get_cookies_from_browser() -> tuple[str, dict[str, str]] | None:
|
|
80
57
|
for browser_name, loader in BROWSER_LOADERS:
|
|
81
58
|
try:
|
|
@@ -131,51 +108,44 @@ def get_cookies_from_input() -> dict[str, str] | None:
|
|
|
131
108
|
return parse_cookie_header(getpass("请粘贴 Cookie(输入内容不会回显):\n"))
|
|
132
109
|
|
|
133
110
|
|
|
134
|
-
def save_session(session_data: dict, path: Path
|
|
135
|
-
if path is None:
|
|
136
|
-
_resolve_default_session_file()
|
|
137
|
-
file_path = path or SESSION_FILE
|
|
138
|
-
temporary_file = file_path.with_suffix(f"{file_path.suffix}.tmp")
|
|
111
|
+
def save_session(session_data: dict, path: Path) -> None:
|
|
139
112
|
try:
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
113
|
+
content = json.dumps(session_data, indent=4, ensure_ascii=False)
|
|
114
|
+
ensure_regular_directory(
|
|
115
|
+
path.parent,
|
|
116
|
+
label="Session 目录",
|
|
117
|
+
mode=0o700,
|
|
118
|
+
)
|
|
119
|
+
if os.name != "nt":
|
|
120
|
+
os.chmod(path.parent, 0o700)
|
|
121
|
+
atomic_write_text(
|
|
122
|
+
path,
|
|
123
|
+
content,
|
|
124
|
+
label="Session 文件",
|
|
125
|
+
mode=0o600,
|
|
147
126
|
)
|
|
148
|
-
with os.fdopen(descriptor, "w", encoding="utf-8") as file:
|
|
149
|
-
json.dump(session_data, file, indent=4, ensure_ascii=False)
|
|
150
|
-
os.chmod(temporary_file, 0o600)
|
|
151
|
-
temporary_file.replace(file_path)
|
|
152
|
-
os.chmod(file_path, 0o600)
|
|
153
127
|
except (OSError, TypeError, ValueError) as exc:
|
|
154
|
-
try:
|
|
155
|
-
temporary_file.unlink(missing_ok=True)
|
|
156
|
-
except OSError:
|
|
157
|
-
pass
|
|
158
128
|
raise SessionFileError("无法保存 Session 文件") from exc
|
|
159
129
|
|
|
160
130
|
|
|
161
|
-
def load_session() -> dict | None:
|
|
162
|
-
file_path = _resolve_default_session_file()
|
|
131
|
+
def load_session(path: Path) -> dict | None:
|
|
163
132
|
try:
|
|
164
|
-
|
|
133
|
+
if validate_regular_file_target(path, label="Session 文件") is None:
|
|
134
|
+
return None
|
|
135
|
+
with path.open("r", encoding="utf-8") as f:
|
|
165
136
|
return json.load(f)
|
|
166
137
|
except FileNotFoundError:
|
|
167
138
|
return None
|
|
168
139
|
except json.JSONDecodeError:
|
|
169
140
|
return None
|
|
170
|
-
except OSError as exc:
|
|
141
|
+
except (OSError, SafeFileError) as exc:
|
|
171
142
|
raise SessionFileError("无法读取 Session 文件") from exc
|
|
172
143
|
|
|
173
144
|
|
|
174
|
-
def inspect_session_file(path: Path
|
|
175
|
-
if path is None:
|
|
176
|
-
path = _resolve_default_session_file()
|
|
177
|
-
|
|
145
|
+
def inspect_session_file(path: Path) -> SessionFileInspection:
|
|
178
146
|
try:
|
|
147
|
+
if validate_regular_file_target(path, label="Session 文件") is None:
|
|
148
|
+
return SessionFileInspection(status=SessionFileStatus.MISSING)
|
|
179
149
|
content = path.read_text(encoding="utf-8")
|
|
180
150
|
|
|
181
151
|
except FileNotFoundError:
|
|
@@ -183,7 +153,7 @@ def inspect_session_file(path: Path | None = None) -> SessionFileInspection:
|
|
|
183
153
|
status=SessionFileStatus.MISSING,
|
|
184
154
|
)
|
|
185
155
|
|
|
186
|
-
except OSError:
|
|
156
|
+
except (OSError, SafeFileError):
|
|
187
157
|
return SessionFileInspection(
|
|
188
158
|
status=SessionFileStatus.READ_ERROR,
|
|
189
159
|
)
|