[PR #211] docs(router): clarify the ModelNotFound docstring #210

New issue

Open

opened 2026-10-31 22:02:21 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:02:21 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/211
Author: @mattmillerai
Created: 10/9/2026
Status: 🔄 Open

Base: main ← Head: matt/land-router-spec-sync-9794097

📝 Commits (3)

d1ab5f0 chore: sync vendored Comfy Router spec from cloud@9794097
954ef65 fix(router): re-bless ModelNotFound against the cloud@9794097 Router spec
d999259 Merge branch 'main' into matt/land-router-spec-sync-9794097

📊 Changes

1 file changed (+12 additions, -9 deletions)

View changed files

📝 src/comfy_sdk/router_exceptions.py (+12 -9)

📄 Description

ELI5

This rewrites the help text for the "model not found" error so it explains more clearly when a model counts as gone, when you are pointed at a replacement, and when you get suggestions instead. It changes wording only. The SDK behaves exactly as before.

Summary

Rewords the ModelNotFound docstring in src/comfy_sdk/router_exceptions.py. That 12-line docstring is the PR's whole diff against main.

It now says plainly that the error covers any id Router cannot run, not just unknown ids. It also says the retired-model detail (retirement date, plus a successor when one is visible) replaces the suggestion list.
A catalogued id the provider does not currently serve for Comfy gets no suggestions. The docstring now says so in its own paragraph.
The class's _spec_meaning_digest (6c0e0e327e4d) is unchanged. It already matches the vendored Router spec.

History. This PR originally carried the cloud@9794097 Router spec sync and the ModelNotFound read-marker re-bless. Both have since landed on main via #209. After a merge from main (no rebase, no force-push), only this branch's docstring wording is left. Merging it lands the clearer wording. Closing it instead loses only that wording.

Provenance

Verified:

Final diff against main is the ModelNotFound docstring only. Spec, generated models and digest are all unchanged.
At merge commit d999259, the local gates passed: ruff check, ruff format --check, mypy src, pytest (1265 passed, 9 skipped), scripts/check_drift.py and the public-repo hygiene script.
PR CI on head d999259 is green: Test py3.10 to 3.13, codegen drift, build-check, public-repo-hygiene.

Deviations:

The scope has narrowed from "land the spec sync" to a docstring-only change, because #209 already landed the sync and the digest on main.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/211 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 10/9/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `matt/land-router-spec-sync-9794097` --- ### 📝 Commits (3) - [`d1ab5f0`](https://github.com/Comfy-Org/comfy-python-sdk/commit/d1ab5f02bc004a6ee71e4e9b63eb6e278b12aedb) chore: sync vendored Comfy Router spec from cloud@9794097 - [`954ef65`](https://github.com/Comfy-Org/comfy-python-sdk/commit/954ef65e471fde9257b7be8a482bfcd6bf04a2a5) fix(router): re-bless ModelNotFound against the cloud@9794097 Router spec - [`d999259`](https://github.com/Comfy-Org/comfy-python-sdk/commit/d99925981a982d4a49334f19ee9f7709d502add6) Merge branch 'main' into matt/land-router-spec-sync-9794097 ### 📊 Changes **1 file changed** (+12 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `src/comfy_sdk/router_exceptions.py` (+12 -9) </details> ### 📄 Description ## ELI5 This rewrites the help text for the "model not found" error so it explains more clearly when a model counts as gone, when you are pointed at a replacement, and when you get suggestions instead. It changes wording only. The SDK behaves exactly as before. ## Summary Rewords the `ModelNotFound` docstring in `src/comfy_sdk/router_exceptions.py`. That 12-line docstring is the PR's whole diff against `main`. - It now says plainly that the error covers any id Router cannot run, not just unknown ids. It also says the retired-model `detail` (retirement date, plus a successor when one is visible) replaces the suggestion list. - A catalogued id the provider does not currently serve for Comfy gets no suggestions. The docstring now says so in its own paragraph. - The class's `_spec_meaning_digest` (`6c0e0e327e4d`) is unchanged. It already matches the vendored Router spec. **History.** This PR originally carried the cloud@9794097 Router spec sync and the `ModelNotFound` read-marker re-bless. Both have since landed on `main` via #209. After a merge from `main` (no rebase, no force-push), only this branch's docstring wording is left. Merging it lands the clearer wording. Closing it instead loses only that wording. ## Provenance **Verified:** - Final diff against `main` is the `ModelNotFound` docstring only. Spec, generated models and digest are all unchanged. - At merge commit d999259, the local gates passed: `ruff check`, `ruff format --check`, `mypy src`, `pytest` (1265 passed, 9 skipped), `scripts/check_drift.py` and the public-repo hygiene script. - PR CI on head d999259 is green: Test py3.10 to 3.13, codegen drift, build-check, public-repo-hygiene. **Deviations:** - The scope has narrowed from "land the spec sync" to a docstring-only change, because #209 already landed the sync and the digest on `main`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-31 22:02:21 +00:00

bsakaguchi referenced this issue

2026-10-31 22:02:21 +00:00

[PR #210] docs(errors): list rate_limited explicitly as the fourth code both surfaces share #211