Skip to content

topmark.runtime.model

topmark / runtime / model

Execution-only runtime models.

This package holds values that describe invocation intent for a single TopMark run. These values do not participate in layered config discovery, per-path effective config resolution, or file-backed merge semantics.

The initial runtime split introduces RunOptions as the authoritative home for execution-only concerns such as apply mode, stdin handling, output routing, file-write strategy, and run timestamps.

RunOptions dataclass

RunOptions(
    *,
    apply_changes=None,
    output_target=None,
    file_write_strategy=None,
    stdin_mode=False,
    stdin_filename=None,
    prune_views=True,
    keep_diff_view=False,
    started_at=get_utc_now(),
)

Execution-only options for a single TopMark run.

This value carries invocation intent that does not participate in layered config discovery or per-path effective config resolution.

Attributes:

Name Type Description
apply_changes bool | None

Whether the run should write changes (True) or preview only (False).

output_target OutputTarget | None

Where output should be emitted for this run.

file_write_strategy FileWriteStrategy | None

How file writes should be performed when output_target targets files.

stdin_mode bool

Whether content is being provided on stdin for this run.

stdin_filename str | None

Synthetic filename associated with stdin content, used when header generation requires a file identity.

prune_views bool

Whether heavy views should be trimmed after the run while preserving summary-level results.

keep_diff_view bool

Whether to preserve the diff view.

started_at datetime

Timestamp captured once for the whole run.