Model/domain/property/property.py
Khalim Conn-Kowlessar c5182627ba feat(modelling): thread Property planning restrictions to the solid-wall gate
Slice 3b+3d (ADR-0019/0020). Property gains a planning_restrictions attribute
(default unrestricted); the ModellingOrchestrator threads it from the Property
through _plan_for -> _scored_candidate_groups -> _candidate_recommendations into
recommend_solid_wall, replacing the unrestricted default. run_modelling exposes
a planning_restrictions param so the offline harness can inspect restricted
properties. Integration test: a listed solid-brick dwelling that gets IWI when
unrestricted now yields no wall insulation. 145 tests pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-04 16:32:26 +00:00

80 lines
3.1 KiB
Python

from __future__ import annotations
from dataclasses import dataclass
from typing import Literal, Optional
from datatypes.epc.domain.epc_property_data import EpcPropertyData
from domain.geospatial.planning_restrictions import PlanningRestrictions
from domain.property.site_notes import SiteNotes
SourcePath = Literal["site_notes", "epc_with_overlay"]
@dataclass(frozen=True)
class PropertyIdentity:
"""Identifies a single Property within a portfolio.
Keyed by `(portfolio_id, uprn)` or `(portfolio_id, landlord_property_id)` —
a UPRN is permanent but each portfolio gets its own Property against it
(CONTEXT.md: UPRN).
"""
portfolio_id: int
postcode: str
address: str
uprn: Optional[int] = None
landlord_property_id: Optional[str] = None
@dataclass
class Property:
"""The Ara modelling aggregate root for a single dwelling (ADR-0002).
Holds identity plus the source data the pipeline reasons about. Enrichments
(geospatial, solar) and modelling outputs (baseline performance, plans) are
added by later slices — this is the minimal-and-growing shape for First Run.
"""
identity: PropertyIdentity
epc: Optional[EpcPropertyData] = None
site_notes: Optional[SiteNotes] = None
# The current open-market value (a Property Valuation) — externally sourced
# and mostly absent; feeds the Plan's Valuation Uplift £ forms (ADR-0018).
current_market_value: Optional[float] = None
# Planning protections resolved from the geospatial layer (ADR-0020); gate
# wall insulation (ADR-0019). Defaults to unrestricted when unknown.
planning_restrictions: PlanningRestrictions = PlanningRestrictions()
@property
def source_path(self) -> SourcePath:
"""Which of the two disjoint source paths models this Property (ADR-0001).
Site Notes alone, or the public EPC (with Landlord Overrides, once that
slice lands). When both exist the newer wins (Recency Tie-Break); on an
equal date the survey wins, as it reflects on-site observation.
"""
if self.site_notes is not None and self.epc is not None:
epc_date = self.epc.registration_date or self.epc.inspection_date
if self.site_notes.surveyed_at >= epc_date:
return "site_notes"
return "epc_with_overlay"
if self.site_notes is not None:
return "site_notes"
if self.epc is not None:
return "epc_with_overlay"
raise ValueError(
"Property has neither Site Notes nor an EPC; no source path to model from"
)
@property
def effective_epc(self) -> EpcPropertyData:
"""The EpcPropertyData the modelling pipeline scores against.
Path 1: the Site Notes' surveyed data. Path 2: the public EPC (Landlord
Overrides overlay is a later slice — returned as-is for now).
"""
if self.source_path == "site_notes":
assert self.site_notes is not None
return self.site_notes.to_epc_property_data()
assert self.epc is not None
return self.epc