RomanNum3ral
/
soup
mirror of https://github.com/razor-ai/soup.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(registry): recommend is_under_cwd over resolve()+relative_to() in resolve_dataset docstring 

Last holdout of the recurring Path.resolve()+relative_to() containment class —
an advisory docstring (no behaviour change) that still recommended the
Windows-broken idiom.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Alpamys 2026-07-02 19:41:25 +05:00
parent cba51e153b
commit 7476b75a73
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/soup_cli/utils/registry.py
View File

@ -86,8 +86,10 @@ def resolve_dataset(
) -> Optional[dict]:
"""Resolve a dataset name to its entry (path + format). None if not found.
Callers must apply resolve + relative_to(cwd) before trusting the path.
The returned path is validated for null bytes.
Callers must apply ``utils.paths.is_under_cwd`` (realpath + commonpath)
before trusting the path — NOT ``Path.resolve()+relative_to()``, which
breaks on Windows 8.3 short names. The returned path is validated for null
bytes here.
"""
registry = load_registry(registry_path)
entry = registry.get(name)