Skip to main content

Module plan

Module plan 

Source
Expand description

Transaction plan format parsing.

Structs§

ForEach
Glob-driven batch expansion: apply the same set of operations to every file matching a glob pattern, with template variable substitution.
FormatStep
A format step to run after applying operations but before validation.
Plan
A transaction plan containing multiple operations to execute atomically.
SplitTargetSpec
Target file specification for ast.split.
ValidationStep
A validation step to run after applying operations.

Enums§

Operation
A single operation within a plan.
VerifyCheck
A single verification check parsed from --verify or plan verify field.

Constants§

SCHEMA_VERSION
Current plan schema version.

Functions§

effective_strict
Resolve effective strict mode: --no-strict > plan field > config > default true.
expand_for_each
Expand a plan’s for_each block: match files via glob, apply exclude/filter, substitute template variables into each operation, and flatten the result into plan.operations. After this call, plan.for_each is None.
parse_plan
Parse a plan from a JSON string.
parse_plan_auto
Detect plan format from a file path extension and parse accordingly.
parse_plan_toml
Parse a plan from a TOML string.
parse_plan_yaml
Parse a plan from a YAML string.