Spaces:
Running on Zero
Running on Zero
File size: 14,249 Bytes
5861856 2655c68 5861856 7d49d45 c08d3e8 174bb90 1c8a58d 174bb90 d2490e1 8a7fa0c d2490e1 5861856 b9ee967 5861856 b55f9af 5861856 b5f94e8 5861856 2f36d8a 5861856 2655c68 5861856 7d49d45 5861856 b9ee967 5861856 b5f94e8 5861856 2f36d8a 5861856 c08d3e8 5861856 2655c68 5861856 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | """Spec for ``ltx25_studio/errors.py`` — PLAN §5.2, §5.3, §4.3, §7.2.
The contract, stated once so the implementer does not have to reverse-engineer it
from assertions:
* Every error in the package descends from a single root, ``LTXStudioError``.
* Every concrete error takes **keyword arguments naming the offending thing** and
renders a ``str()`` that contains them. "Fail loudly" is not a slogan here — an
error whose message does not name the file, the value, the URL or the prefixes
it actually found is a test failure.
* Four abstract bases group the hierarchy so ``ui/`` can catch by family:
``ConstraintError``, ``ModelFileError``, ``LoRAError``, ``GenerationError``.
* Adding a new error class without adding it to ``ERROR_SPECS`` below fails
``test_every_error_class_is_covered_by_this_spec``. That is deliberate: a new
error must come with a stated, checked message contract.
"""
from __future__ import annotations
import inspect
import pytest
from ltx25_studio import errors
# --------------------------------------------------------------------------
# The contract table: class name -> (kwargs, substrings the message must contain)
# --------------------------------------------------------------------------
ERROR_SPECS = {
# -- configuration (PLAN §5.1; env-driven config) ---------------------
"ConfigError": (
{
"variable": "LTX25_TRANSFORMER_PRECISION",
"value": "fp4",
"legal": ("bf16", "fp8"),
},
["LTX25_TRANSFORMER_PRECISION", "fp4", "bf16", "fp8"],
),
# -- constraints (PLAN §5.5) -----------------------------------------
"FrameCountError": (
{"num_frames": 120, "temporal_compression_ratio": 8, "nearest": (113, 121)},
["120", "113", "121"],
),
"DimensionError": (
{"name": "width", "value": 700, "multiple": 32},
["width", "700", "32"],
),
"AudioVideoDesyncError": (
{"video_seconds": 5.0, "audio_seconds": 4.25},
["5.0", "4.25"],
),
"OverLimitError": (
{"name": "width", "value": 2048, "limit": 1920, "nearest": 1920},
["width", "2048", "1920"],
),
"MissingInputError": (
{"mode": "Image to video", "missing": ("image",), "alternative": "Text to video"},
["Image to video", "image", "Text to video"],
),
"GpuMemoryError": (
{"mode": "text_to_video", "stage": "generating", "reason": "CUDA out of memory"},
["text_to_video", "out of memory", "smaller"],
),
"DecoderUnavailableError": (
{"reason": "it needs an NVIDIA (CUDA) GPU at this size"},
["Steadier (diffusion decoder)", "NVIDIA", "Sharper (standard decoder)"],
),
"DecoderTooSmallError": (
{
"output": (192, 128, 9),
"minimum": (224, 224, 17),
"smallest": (128, 128, 17),
"stage_2": True,
},
["192×128", "224×224", "17 frames", "128×128", "Upscale ×2"],
),
# -- model files (PLAN §5.2) -----------------------------------------
"MissingModelFileError": (
{
"filename": "diffusion_pytorch_model-00001-of-00004.safetensors",
"url": (
"https://huggingface.co/Lightricks/LTX-2.5-Diffusers/blob/main/"
"transformer/diffusion_pytorch_model-00001-of-00004.safetensors"
),
},
["diffusion_pytorch_model-00001-of-00004.safetensors", "https://huggingface.co/"],
),
"UnknownComponentError": (
{"name": "prompt_enhancer", "known": ("transformer", "vae", "vocoder")},
["prompt_enhancer", "transformer"],
),
# -- LoRA (PLAN §4.3, §4.6) ------------------------------------------
"LoRAFetchError": (
{
"source": "nobody/no-such-repo",
"reason": "'nobody/no-such-repo' was not found on the Hub",
},
["nobody/no-such-repo", "not found"],
),
"LoRATooLargeError": (
{
"source": "/tmp/huge.safetensors",
"size_bytes": 12_000_000_000,
"max_bytes": 10_000_000_000,
},
["huge.safetensors", "12", "10"],
),
"LoRAFormatError": (
{"source": "/tmp/notes.txt", "reason": "not a safetensors container"},
["notes.txt", "safetensors"],
),
"LoRAHeaderError": (
{"source": "/tmp/adapter.safetensors", "declared_header_bytes": 1152921504606846976},
["adapter.safetensors", "1152921504606846976"],
),
"LoRATruncatedError": (
{"source": "/tmp/adapter.safetensors", "declared_bytes": 4096, "available_bytes": 512},
["adapter.safetensors", "4096", "512"],
),
"LoRAVersionError": (
{"source": "/tmp/adapter.safetensors", "found": "2.3.0", "expected": "2.5"},
["adapter.safetensors", "2.3.0", "2.5"],
),
"LoRAConventionError": (
{
"source": "/tmp/adapter.safetensors",
"found_prefixes": ("unet.", "controlnet."),
"known_prefixes": ("diffusion_model.", "transformer."),
},
["adapter.safetensors", "unet.", "controlnet.", "diffusion_model."],
),
"LoRAPairingError": (
{
"source": "/tmp/adapter.safetensors",
"unpaired_keys": ("diffusion_model.transformer_blocks.0.attn1.to_q.lora_A.weight",),
},
["adapter.safetensors", "transformer_blocks.0.attn1.to_q", "lora_A"],
),
"LoRAInContextError": (
{
"source": "/tmp/ic-lora.safetensors",
"marker": "reference_downscale_factor",
"value": "1",
},
["ic-lora.safetensors", "reference_downscale_factor"],
),
"LoRADimensionError": (
{
"source": "/tmp/ltxv-2b.safetensors",
"module": "transformer_blocks.0.attn1.to_k",
"expected": 4096,
"actual": 2048,
},
["ltxv-2b.safetensors", "transformer_blocks.0.attn1.to_k", "4096", "2048"],
),
"LoRAModuleNotFoundError": (
{
"source": "/tmp/sdxl.safetensors",
"missing_modules": ("down_blocks.0.resnets.0.conv1", "mid_block.attentions.0.to_out.0"),
"module_count": 2,
},
["sdxl.safetensors", "down_blocks.0.resnets.0.conv1"],
),
"LoRANotAttachedError": (
{
"source": "/tmp/adapter.safetensors",
"adapter_name": "user_lora",
"components": ("transformer", "connectors"),
},
["adapter.safetensors", "user_lora", "transformer", "connectors"],
),
# -- generation (PLAN §5.3) ------------------------------------------
"ModelLoadError": (
{"component": "transformer", "reason": "connection reset by peer"},
["transformer", "connection reset by peer"],
),
"PromptEnhancementError": (
{
"repo_id": "google/gemma-4-E2B-it-qat-mobile-transformers",
"reason": "it returned an empty prompt",
},
["google/gemma-4-E2B-it-qat-mobile-transformers", "empty prompt"],
),
"DecodeError": (
{"mode": "text_to_video", "reason": "pipeline returned no frames"},
["text_to_video", "no frames"],
),
"EncodeError": (
{"path": "/tmp/run-abc/video.mp4", "reason": "ffmpeg exited 1"},
["video.mp4", "ffmpeg"],
),
"EmptyOutputError": (
{"mode": "text_to_video", "expected_path": "/tmp/run-abc/video.mp4"},
["text_to_video", "video.mp4"],
),
# -- modes (PLAN §3.2) -----------------------------------------------
"UnknownModeError": (
{"mode": "text_to_hologram", "known": ("text_to_video", "image_to_video")},
["text_to_hologram", "text_to_video"],
),
}
#: Grouping bases. They exist so callers can catch a family; they are not
#: required to accept the keyword contract above.
BASE_ERROR_NAMES = (
"LTXStudioError",
"ConstraintError",
"ModelFileError",
"LoRAError",
"GenerationError",
)
BASE_OF = {
"ConfigError": "LTXStudioError",
"FrameCountError": "ConstraintError",
"DimensionError": "ConstraintError",
"AudioVideoDesyncError": "ConstraintError",
"OverLimitError": "ConstraintError",
"MissingInputError": "ConstraintError",
"MissingModelFileError": "ModelFileError",
"UnknownComponentError": "ModelFileError",
"LoRAFetchError": "LoRAError",
"LoRATooLargeError": "LoRAError",
"LoRAFormatError": "LoRAError",
"LoRAHeaderError": "LoRAError",
"LoRATruncatedError": "LoRAError",
"LoRAVersionError": "LoRAError",
"LoRAConventionError": "LoRAError",
"LoRAPairingError": "LoRAError",
"LoRAInContextError": "LoRAError",
"LoRADimensionError": "LoRAError",
"LoRAModuleNotFoundError": "LoRAError",
"LoRANotAttachedError": "LoRAError",
"ModelLoadError": "GenerationError",
"PromptEnhancementError": "GenerationError",
"DecodeError": "GenerationError",
"GpuMemoryError": "GenerationError",
"EncodeError": "GenerationError",
"EmptyOutputError": "GenerationError",
}
def _get(name):
cls = getattr(errors, name, None)
assert cls is not None, f"ltx25_studio.errors.{name} does not exist (PLAN §5.2/§4.3/§5.3)"
return cls
# --------------------------------------------------------------------------
# hierarchy
# --------------------------------------------------------------------------
@pytest.mark.parametrize("name", BASE_ERROR_NAMES)
def test_base_error_class_exists(name):
assert isinstance(_get(name), type)
def test_root_error_is_an_exception_not_a_baseexception():
root = _get("LTXStudioError")
assert issubclass(root, Exception)
@pytest.mark.parametrize("name", sorted(BASE_ERROR_NAMES[1:]))
def test_grouping_bases_descend_from_the_root(name):
assert issubclass(_get(name), _get("LTXStudioError"))
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_class_exists(name):
assert isinstance(_get(name), type)
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_every_error_descends_from_the_single_root(name):
assert issubclass(_get(name), _get("LTXStudioError"))
@pytest.mark.parametrize("name,base", sorted(BASE_OF.items()))
def test_error_is_in_the_right_family(name, base):
assert issubclass(_get(name), _get(base))
# --------------------------------------------------------------------------
# actionable messages
# --------------------------------------------------------------------------
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_constructs_from_its_documented_keyword_arguments(name):
kwargs, _ = ERROR_SPECS[name]
exc = _get(name)(**kwargs)
assert isinstance(exc, Exception)
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_message_is_not_empty(name):
kwargs, _ = ERROR_SPECS[name]
message = str(_get(name)(**kwargs))
assert message.strip(), f"{name} renders an empty message — PLAN §5.3 forbids silent failure"
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_message_is_not_merely_the_class_name(name):
kwargs, _ = ERROR_SPECS[name]
message = str(_get(name)(**kwargs)).strip()
assert message != name
assert len(message) > 20, f"{name}: {message!r} is too terse to be actionable"
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_message_names_the_offending_detail(name):
kwargs, expected = ERROR_SPECS[name]
message = str(_get(name)(**kwargs))
missing = [needle for needle in expected if needle not in message]
assert not missing, f"{name} message omits {missing}; got: {message!r}"
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_message_reads_as_prose_not_a_repr_dump(name):
"""An actionable message is a sentence, not ``{'source': ..., 'reason': ...}``."""
kwargs, _ = ERROR_SPECS[name]
message = str(_get(name)(**kwargs))
assert not message.startswith("{"), f"{name} renders a dict repr: {message!r}"
assert not message.startswith("("), f"{name} renders a tuple repr: {message!r}"
assert " " in message.strip(), f"{name} renders a single token: {message!r}"
@pytest.mark.parametrize("name", sorted(ERROR_SPECS))
def test_error_can_be_raised_and_caught_as_the_root(name):
kwargs, _ = ERROR_SPECS[name]
cls = _get(name)
with pytest.raises(_get("LTXStudioError")) as excinfo:
raise cls(**kwargs)
assert isinstance(excinfo.value, cls)
# --------------------------------------------------------------------------
# no error may escape the spec
# --------------------------------------------------------------------------
def test_a_misconfiguration_is_not_a_generation_failure():
"""``ui/`` has to tell an operator who set a Space variable wrong from a user
whose run failed. Those are different messages to different people, so
``ConfigError`` must not sit inside the generation family."""
config_error = _get("ConfigError")
assert not issubclass(config_error, _get("GenerationError"))
assert not issubclass(config_error, _get("ConstraintError"))
assert issubclass(config_error, _get("LTXStudioError"))
def test_a_config_error_refuses_rather_than_falling_back():
"""PLAN §5.1's whole posture: an unrecognised value fails at startup naming
the variable and the legal values. A silent fallback to the default is how a
Space runs for a week in a configuration nobody chose."""
kwargs, _ = ERROR_SPECS["ConfigError"]
message = str(_get("ConfigError")(**kwargs))
assert "fp4" in message
assert "bf16" in message and "fp8" in message
def test_every_error_class_is_covered_by_this_spec():
root = _get("LTXStudioError")
defined = {
name
for name, obj in inspect.getmembers(errors, inspect.isclass)
if getattr(obj, "__module__", None) == errors.__name__
and issubclass(obj, root)
and not name.startswith("_")
}
uncovered = defined - set(ERROR_SPECS) - set(BASE_ERROR_NAMES)
assert not uncovered, (
f"errors.py defines {sorted(uncovered)} with no message contract in ERROR_SPECS. "
"Every error owes the user an actionable message (PLAN §5.3) — add it to the spec."
)
|