Class DoWhileStep

src/specify_cli/workflows/steps/do_while/__init__.py:10–64

Execute body at least once, then check condition. Continues while condition is truthy. ``max_iterations`` is an optional safety cap (defaults to 10 if omitted). The first invocation always returns the nested steps for execution. The engine re-evaluates ``step_config['condition']``

class DoWhileStep(StepBase):
    """Execute body at least once, then check condition.

    Continues while condition is truthy.  ``max_iterations`` is an
    optional safety cap (defaults to 10 if omitted).

    The first invocation always returns the nested steps for execution.
    The engine re-evaluates ``step_config['condition']`` after each
    iteration to decide whether to loop again.
    """

    type_key = "do-while"

    def execute(self, config: dict[str, Any], context: StepContext) -> StepResult:
        max_iterations = config.get("max_iterations")
        if max_iterations is None:
            max_iterations = 10
        nested_steps = config.get("steps", [])
        condition = config.get("condition", "false")

        # Always execute body at least once; the engine layer evaluates
        # `condition` after each iteration to decide whether to loop.
        return StepResult(
            status=StepStatus.COMPLETED,
            output={
                "condition": condition,
                "max_iterations": max_iterations,
                "loop_type": "do-while",
            },
            next_steps=nested_steps,
        )

    def validate(self, config: dict[str, Any]) -> list[str]:
        errors = super().validate(config)
        if "condition" not in config:
            errors.append(
                f"Do-while step {config.get('id', '?')!r} is missing "
                f"'condition' field."
            )
        max_iter = config.get("max_iterations")
        if max_iter is not None:
            # bool is a subclass of int, so isinstance(True, int) is True and
            # True < 1 is False; reject bools explicitly so `max_iterations: true`
            # is a type error rather than a silent single iteration.
            if isinstance(max_iter, bool) or not isinstance(max_iter, int) or max_iter < 1:
                errors.append(
                    f"Do-while step {config.get('id', '?')!r}: "
                    f"'max_iterations' must be an integer >= 1."
                )
        nested = config.get("steps", [])
        if not isinstance(nested, list):
            errors.append(
                f"Do-while step {config.get('id', '?')!r}: 'steps' must be a list."
            )
        return errors