Local UI to run and train LLMs and diffusion models. Supports GGUF, MLX, Qwen3.8, DeepSeek-V4.1, MiniMax-H3, Gemma 4, FLUX and more.
Python agentaichatgptdeepseekfine-tuninggemmaimage-generationllamallmllmsopenaipythonqwenreinforcement-learningself-hostedstable-diffusiontext-to-speechttsuiunsloth
# Unsloth Zoo - Utilities for Unsloth
# Copyright 2023-present Daniel Han-Chen, Michael Han-Chen & the Unsloth team. All rights reserved.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""Every uv `-r` in install.ps1 must use the space-safe helper, since uv splits paths on whitespace."""
from __future__ import annotations
import re
from pathlib import Path
REPO_ROOT = Path(__file__).resolve().parents[2]
# run_pwsh treats this as the verdict, so a real result is never retried as a startup crash.
_VERDICT = "All Get-UvSafeRequirementsPath checks passed"
INSTALL_PS1 = REPO_ROOT / "install.ps1"
HELPER = "Get-UvSafeRequirementsPath"
def _code_lines(text: str) -> list[str]:
"""Drop whole-line comments so a commented example never satisfies an assertion."""
return [line for line in text.splitlines() if not line.lstrip().startswith("#")]
def test_the_helper_is_defined():
lines = _code_lines(INSTALL_PS1.read_text(encoding = "utf-8"))
assert any(
re.match(rf"\s*function\s+{HELPER}\b", line) for line in lines
), f"{HELPER} is missing from install.ps1"
def test_every_uv_requirements_flag_uses_a_sanitised_path():
lines = _code_lines(INSTALL_PS1.read_text(encoding = "utf-8"))
# Track variables by data flow from the helper, not by name.
from_helper = set()
for line in lines:
hit = re.search(rf"(\$[A-Za-z_][A-Za-z0-9_]*)\s*=\s*{HELPER}\b", line)
if hit:
from_helper.add(hit.group(1))
sanitised = set()
for line in lines:
hit = re.search(
r"(\$[A-Za-z_][A-Za-z0-9_]*)\s*=\s*(\$[A-Za-z_][A-Za-z0-9_]*)\.Path\b", line
)
if hit and hit.group(2) in from_helper:
sanitised.add(hit.group(1))
sanitised |= {f"{name}.Path" for name in from_helper}
uses = [(n, line) for n, line in enumerate(lines, 1) if re.search(r"\s-r\s+\$", line)]
assert uses, "no uv -r call sites found; this test is no longer measuring anything"
unsafe = []
for number, line in uses:
arg = re.search(r"\s-r\s+(\$[A-Za-z_][A-Za-z0-9_:]*(?:\.Path)?)", line)
if arg and arg.group(1) not in sanitised:
unsafe.append(f"line {number}: {line.strip()}")
assert not unsafe, (
"uv -r is handed a path that never passed through "
f"{HELPER}, so an install root containing a space truncates it:\n" + "\n".join(unsafe)
)
def test_a_copy_is_removed_but_the_users_own_file_is_not():
"""The helper may return a copy; only a copy may be deleted."""
text = INSTALL_PS1.read_text(encoding = "utf-8")
body = text[text.index(f"function {HELPER}") :]
body = body[: body.index("\n function ")]
assert "Temporary = $true" in body, "the helper never reports that it made a copy"
assert "Temporary = $false" in body, "the helper never reports a pass-through path"
for line in _code_lines(text):
if "Remove-Item" in line and "NoTorchReqArg" in line:
break
else:
raise AssertionError("a temporary copy is created but never removed")
guarded = re.search(r"if \(\$NoTorchReqSafe\.Temporary\) \{\s*\n\s*Remove-Item", text)
assert guarded, (
"the Remove-Item is not guarded on .Temporary, so a pass-through path "
"would delete the user's own requirements file"
)
def test_the_helper_behaviour_suite_runs():
"""Runs the PowerShell helper test under pytest so the CPU job executes it, including fallbacks."""
import shutil
import pytest
from unsloth_pwsh_runner import run_pwsh
if shutil.which("pwsh") is None:
pytest.skip("pwsh not available")
script = REPO_ROOT / "tests" / "studio" / "test_uv_safe_requirements_path.ps1"
assert script.is_file(), f"missing: {script}"
proc = run_pwsh(
["pwsh", "-NoProfile", "-File", str(script)],
verdict = _VERDICT,
capture_output = True,
text = True,
)
assert proc.returncode == 0, proc.stdout + proc.stderr
assert _VERDICT in proc.stdout, proc.stdout
def test_an_8dot3_alias_is_only_used_once_it_resolves():
"""`GetShortPathName` can return an 8.3 alias the volume never created, so it must exist before use."""
text = INSTALL_PS1.read_text(encoding = "utf-8")
body = text[text.index(f"function {HELPER}") :]
body = body[: body.index("\n function ")]
# Test-Path needs -ErrorAction SilentlyContinue: under Stop it throws on ACL-denied dirs.
assert re.search(r"-and \(Test-Path -LiteralPath \$short -PathType Leaf\b[^)]*\)", body), (
f"{HELPER} accepts an 8.3 short path on 'contains no space' alone, so an alias that "
"does not resolve is handed to uv and later to Remove-Item"
)
assert re.search(r"Test-Path -LiteralPath \$short[^)]*-ErrorAction SilentlyContinue\)", body), (
f"{HELPER} queries the filesystem without -ErrorAction SilentlyContinue, so an unreadable "
"directory aborts the install instead of rejecting the alias"
)
def test_get_uv_safe_path_queries_the_filesystem_safely():
"""Test-Path needs `-ErrorAction SilentlyContinue`, since Stop throws on ACL-denied directories."""
guard = r"Test-Path -LiteralPath \$short\b[^)]*-ErrorAction SilentlyContinue\)"
for path in (INSTALL_PS1, REPO_ROOT / "studio" / "setup.ps1"):
text = path.read_text(encoding = "utf-8")
start = text.index("function Get-UvSafePath")
body = text[start : text.index("\n}", start)]
assert re.search(guard, body), (
f"{path.name}: Get-UvSafePath probes the filesystem without -ErrorAction "
"SilentlyContinue, so an unreadable directory aborts the install"
)