Skip to content

Commit dcf51a8

Browse files
committed
fix: Address the second review of range list element resolution
The second review returned clean; these are its low findings. - When an element fails before a later element takes the list past its limit, report the element error, as openjd-rs does, instead of the limit. - Test FormatString.resolve_list_item's room directly, so stopping before a flattened element's members are copied is pinned rather than only observable as time. - resolve_list_item: type path_format as Optional[Any] like its siblings, and document the None return. Signed-off-by: Mark Wiebe <399551+mwiebe@users.noreply.github.com>
1 parent 5cd9e49 commit dcf51a8

3 files changed

Lines changed: 48 additions & 2 deletions

File tree

‎src/openjd/model/_format_strings/_format_string.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ def resolve_list_item(
241241
symtab: SymbolTable,
242242
target_type: str,
243243
room: Optional[int] = None,
244-
path_format: Optional[object] = None,
244+
path_format: Optional[Any] = None,
245245
) -> Optional[list[Any]]:
246246
"""Resolve this format string as a list item (Expression Language §1.3.2).
247247
@@ -259,6 +259,10 @@ def resolve_list_item(
259259
value references that cannot produce ``null`` or a list) contributes
260260
its resolved string, as :meth:`resolve` returns it.
261261
262+
Returns:
263+
The values the element contributes, or ``None`` when it is a list
264+
longer than ``room``.
265+
262266
Raises:
263267
FormatStringError: if the expression cannot be evaluated or its
264268
result does not coerce to ``target_type``.

‎src/openjd/model/_internal/_create_job.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,11 @@ def _instantiate_list_items(
411411
if resolved is not None:
412412
result.extend(spec.convert(v) for v in resolved)
413413
# The length is a property of the whole list, so it is reported at the
414-
# field rather than at the element that went over.
414+
# field rather than at the element that went over. An element error
415+
# found before it is reported instead, as openjd-rs does.
415416
if resolved is None or len(result) > spec.max_len:
417+
if errors:
418+
break
416419
raise ValueError(spec.too_long_message)
417420

418421
if errors:

‎test/openjd/model_v0/test_range_list_items.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,22 @@ def test_flattened_list_past_element_limit_rejected(
353353
"range exceeds 1024 elements."
354354
), range_
355355

356+
def test_element_error_before_the_limit_is_reported(self, tmp_path) -> None:
357+
error = _range_error(
358+
tmp_path,
359+
{"type": "INT", "range": ["{{ Param.S }}", "{{ [1] * 1024 }}", 2]},
360+
_STRING_S,
361+
{"S": "x"},
362+
["EXPR"],
363+
)
364+
assert error == (
365+
"1 validation errors for JobTemplate\n"
366+
"steps[0] -> parameterSpace -> taskParameterDefinitions[0] -> range[0]:\n\t"
367+
"Failed to parse interpolation expression at [0, 13]. Expression: Param.S . "
368+
"Reason: Expression failed validation: Cannot coerce string to int | list[int] | nulltype\n"
369+
" Param.S\n ~~~~~~^."
370+
)
371+
356372
def test_errors_name_the_element_as_written(self, tmp_path) -> None:
357373
# The element that fails is element 2 of the list as written, even
358374
# though the first element flattened into three values.
@@ -370,3 +386,26 @@ def test_errors_name_the_element_as_written(self, tmp_path) -> None:
370386
"Reason: Expression failed validation: Cannot coerce string to int | list[int] | nulltype\n"
371387
" Param.S\n ~~~~~~^."
372388
)
389+
390+
391+
class TestResolveListItem:
392+
"""``FormatString.resolve_list_item`` directly: a list longer than the
393+
room left is reported before its members are copied."""
394+
395+
def test_list_longer_than_room_returns_none(self) -> None:
396+
from openjd.model import SymbolTable
397+
from openjd.model._format_strings import FormatString
398+
from openjd.model.v2023_09 import ModelParsingContext
399+
400+
fs = FormatString(
401+
"{{ range_expr('1-9999999') }}",
402+
context=ModelParsingContext(supported_extensions=["EXPR"]),
403+
)
404+
target = "int | list[int] | nulltype"
405+
assert fs.resolve_list_item(symtab=SymbolTable(), target_type=target, room=1024) is None
406+
small = FormatString(
407+
"{{ [1, 2, 3] }}", context=ModelParsingContext(supported_extensions=["EXPR"])
408+
)
409+
assert small.resolve_list_item(symtab=SymbolTable(), target_type=target, room=2) is None
410+
values = small.resolve_list_item(symtab=SymbolTable(), target_type=target, room=3)
411+
assert values is not None and [v.item() for v in values] == [1, 2, 3]

0 commit comments

Comments
 (0)