Skip to content

chore: merge dev into main#42

Merged
Illustar0 merged 7 commits intomainfrom
dev
Mar 27, 2026
Merged

chore: merge dev into main#42
Illustar0 merged 7 commits intomainfrom
dev

Conversation

@Illustar0
Copy link
Copy Markdown
Owner

@Illustar0 Illustar0 commented Mar 27, 2026

Summary by CodeRabbit

发布说明

  • 新功能

    • 用户认证模块新增获取用户个人信息的功能,可返回学号、姓名、学院、校园卡余额等数据。
    • 新增 OperationError 异常类型,用于处理认证成功但服务端业务操作失败的情况。
  • 文档

    • 文档站点生成工具已升级,API 参考文档现在自动生成。
    • 补充了新身份验证功能的使用示例和 API 文档。
  • Chores

    • 更新文档构建依赖,简化了构建流程。

Illustar0 and others added 7 commits March 19, 2026 20:38
Signed-off-by: Illustar0 <me@illustar0.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
* feat: add personal info lookup

* docs: document personal info lookup
* build: migrate documentation site to zensical

* fix: restore default theme and side navigation

* docs: automate API reference generation

Signed-off-by: Illustar0 <me@illustar0.com>

---------

Signed-off-by: Illustar0 <me@illustar0.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 866ab39e-820b-4983-8b1e-3a1c46f86e25

📥 Commits

Reviewing files that changed from the base of the PR and between edff5a1 and 623f31b.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (16)
  • .github/workflows/build-docs.yaml
  • AGENTS.md
  • README.md
  • context7.json
  • docs/index.md
  • docs/note.md
  • docs/reference/api.md
  • docs/usage/app/auth.md
  • llms.txt
  • mkdocs.yml
  • pyproject.toml
  • scripts/generate_api_reference.py
  • zensical.toml
  • zzupy/aio/app/auth.py
  • zzupy/app/auth.py
  • zzupy/model/auth.py

📝 Walkthrough

Walkthrough

本次更改将文档系统从 mkdocs 迁移至 Zensical,新增 CASClient.get_user_info() 方法以获取聚合用户信息,添加相应 Pydantic 数据模型,并更新文档配置和构建流程。

Changes

Cohort / File(s) Summary
文档系统基础设施迁移
mkdocs.yml, zensical.toml, pyproject.toml, .github/workflows/build-docs.yaml, scripts/generate_api_reference.py
将文档构建系统从 mkdocs 替换为 Zensical,新增 zensical.toml 配置并移除 mkdocs.yml;更新 GitHub Actions 工作流和依赖清单;添加 API 文档自动生成脚本。
文档内容更新
README.md, docs/index.md, docs/reference/api.md, docs/usage/app/auth.md, docs/note.md, AGENTS.md, llms.txt, context7.json
更新开发命令文档以使用 Zensical;新增 get_user_info() 方法用法示例;删除导航隐藏配置;补充项目元数据文档。
API 功能实现
zzupy/app/auth.py, zzupy/aio/app/auth.py, zzupy/model/auth.py
新增 CASClient.get_user_info() 同步/异步方法以聚合用户个人信息;添加 PersonalInfo、PersonalInfoModel、PersonalInfoCardModel 等 Pydantic 数据模型;扩展错误处理机制。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • refactor: improve exception hierarchy and error handling robustness #33: 新增的方法和错误处理直接使用相同的异常类型(OperationError、ParsingError、NetworkError)和错误包装模式,两个 PR 共同涉及异常处理的重构。
  • feat: add personal info lookup #40: 两个 PR 修改相同的代码表面:均在 zzupy/app/auth.py 和 zzupy/aio/app/auth.py 中添加 CASClient.get_user_info() 方法及常量,以及在 zzupy/model/auth.py 中引入相应的 Pydantic 模型。
  • chore: prepare v7.0.0 #36: 两个 PR 有重叠的代码级修改:均修改文档构建工作流、新增 scripts/generate_api_reference.py、引入 Zensical 配置,以及添加 CASClient.get_user_info() 方法和相关模型。

Poem

🐰 Zensical 扫过文档城,
API 参考自生成。
用户信息聚于一,
同步异步齐闪耀,
兔子舞动庆新章!✨

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Illustar0 Illustar0 merged commit 1e3a472 into main Mar 27, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant