Expose snapshot_path on IncompleteSnapshotError - #4500
Merged
Conversation
Requested by @Wauplin (Lucain Pouget) via Moon Bot. Co-authored-by: Wauplin <Wauplin@users.noreply.github.com> Slack thread: https://huggingface.slack.com/archives/D0AHN75EA81/p1783445397440309?thread_ts=1783445397.440309&cid=D0AHN75EA81
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Wauplin
approved these changes
Jul 7, 2026
Contributor
|
This PR has been shipped as part of the v1.23.0 release. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Should help huggingface/diffusers#14118 (see huggingface/diffusers#14118 (comment))
IncompleteSnapshotErrornow carries asnapshot_pathattribute pointing to the (incomplete) local snapshot, so downstream libraries can still locate the latest cached files even when they are known to be incomplete.snapshot_downloadpopulates it at the raise site, the CLI appends the path to its error output when available, and the cache-management docs mention the attribute.CLI example:
and in Python:
Requested by @Wauplin - Slack thread - Agent trace
Note
Low Risk
Small, backward-compatible extension to an existing error type with a single internal raise site updated; no auth or download logic changes.
Overview
IncompleteSnapshotErrornow includes asnapshot_pathattribute so callers can find partially cached files when offline orlocal_files_onlyblocks completing a download.snapshot_downloadsetssnapshot_pathto the incomplete snapshot directory (base_dir) when raising from_raise_if_incomplete_snapshot. ThehfCLI registers a dedicated formatter that appends that path to the error message (before the genericLocalEntryNotFoundErrorhandler). Cache docs note the new attribute.Reviewed by Cursor Bugbot for commit 4a48a1f. Bugbot is set up for automated code reviews on this repo. Configure here.