brushline.strategic.validation
The 10-year synthetic strategic validation, named checks, result, writers, and replay evidence.
Synthetic-corridor validation for a strategic plan.
The validation builds a deterministic 10-year case, solves the optimized portfolio, monitoring policy, fixed-cycle BAU, report, and scenario, then checks coverage, budget, service, monitoring, BAU like-for-like status, report totals, and exact scenario replay.
- exception brushline.strategic.validation.StrategicValidationError[source]
Bases:
ValueErrorRaised when the synthetic case cannot be built.
- class brushline.strategic.validation.StrategicValidationResult(*, schema_version: Literal['brushline.strategic-validation.v1'] = 'brushline.strategic-validation.v1', instance_id: str, portfolio_id: str, bau_policy_id: str, report_id: str, scenario_id: str, checks: Annotated[list[ValidationCheck], MinLen(min_length=1)], passed: bool, created_utc: datetime)[source]
Bases:
BaseModelThe synthetic strategic validation result.
- Parameters:
schema_version ({"brushline.strategic-validation.v1"}) – Schema version.
instance_id (str) – Instance id.
portfolio_id (str) – Optimized portfolio id.
bau_policy_id (str) – BAU policy id.
report_id (str) – Report id.
scenario_id (str) – Scenario id.
checks (list of ValidationCheck) – Named checks.
passed (bool) – Whether all checks passed.
created_utc (datetime) – Timezone-aware time.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class brushline.strategic.validation.SyntheticCase(*, portfolio: StrategicPortfolio, monitoring: MonitoringPolicy, bau: BauPlan, report: StrategicReport, scenario: StrategicScenario, validation: StrategicValidationResult)[source]
Bases:
BaseModelA complete synthetic strategic case and its validation.
- Parameters:
portfolio (StrategicPortfolio) – Optimized portfolio.
monitoring (MonitoringPolicy) – Monitoring policy.
bau (BauPlan) – BAU plan.
report (StrategicReport) – Strategic report.
scenario (StrategicScenario) – Scenario record.
validation (StrategicValidationResult) – Validation checks.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class brushline.strategic.validation.ValidationCheck(*, code: Annotated[str, MinLen(min_length=1)], passed: bool, detail: str = '')[source]
Bases:
BaseModelOne named validation check.
- Parameters:
code (str) – Check code.
passed (bool) – Whether the check passed.
detail (str) – Human detail.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- brushline.strategic.validation.build_synthetic_case(created_utc: datetime | None = None) SyntheticCase[source]
Build the deterministic 10-year synthetic strategic case.
- Parameters:
created_utc (datetime, optional) – Creation time.
- Returns:
SyntheticCase – Portfolio, monitoring, BAU, report, scenario, and validation.
- brushline.strategic.validation.load_validation(path: str | Path) StrategicValidationResult[source]
Load a strategic validation result.
- Parameters:
path (str or Path) – Source.
- Returns:
StrategicValidationResult – Result.
- brushline.strategic.validation.validate_strategic_plan(*, portfolio: StrategicPortfolio, monitoring: MonitoringPolicy, bau: BauPlan, report: StrategicReport, scenario: StrategicScenario, created_utc: datetime | None = None) StrategicValidationResult[source]
Validate a strategic plan against the P6 acceptance checks.
- Parameters:
portfolio (StrategicPortfolio) – Optimized portfolio.
monitoring (MonitoringPolicy) – Monitoring policy.
bau (BauPlan) – BAU plan.
report (StrategicReport) – Report.
scenario (StrategicScenario) – Scenario.
created_utc (datetime, optional) – Result time.
- Returns:
StrategicValidationResult – Named checks and pass/fail.
- brushline.strategic.validation.write_validation(result: StrategicValidationResult, path: str | Path) Path[source]
Write a strategic validation result.
- Parameters:
result (StrategicValidationResult) – Result.
path (str or Path) – Destination.
- Returns:
Path – Written path.