mirror of
https://github.com/Hestia-Homes/Model.git
synced 2026-07-22 08:48:38 +00:00
66 lines
1.9 KiB
Python
66 lines
1.9 KiB
Python
"""The Download Package plan (ADR-0060).
|
|
|
|
Pure logic: given the documents resolved for a set of properties, decide what
|
|
goes where in the ZIP — one folder per property, the latest file of each
|
|
Document Type — and which rows are skipped and reported. No I/O: the
|
|
orchestrator does the S3/DB work; this module only lays out the archive.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from datetime import datetime
|
|
from typing import Optional, Sequence
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class ResolvedDocument:
|
|
"""One `uploaded_files` row resolved for packaging: its property identity
|
|
(matched by `landlord_property_id`, ADR-0060), the display address enriched
|
|
from the hubspot deals data, its Document Type (`file_type`, nullable), the
|
|
S3 location to read it from, and when it was uploaded (for latest-per-type).
|
|
"""
|
|
|
|
landlord_property_id: str
|
|
address: str
|
|
document_type: Optional[str]
|
|
s3_bucket: str
|
|
s3_key: str
|
|
uploaded_at: datetime
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class PackageEntry:
|
|
"""One file to place in the Download Package: where it lands in the ZIP and
|
|
the S3 object to stream in from."""
|
|
|
|
zip_path: str
|
|
s3_bucket: str
|
|
s3_key: str
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class SkippedDocument:
|
|
"""A resolved row left out of the package, with the reason (surfaced in the
|
|
run's `sub_task.outputs`, ADR-0060)."""
|
|
|
|
landlord_property_id: str
|
|
s3_key: str
|
|
reason: str
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class DownloadPackagePlan:
|
|
"""The laid-out archive: the files to include and the rows skipped."""
|
|
|
|
entries: tuple[PackageEntry, ...]
|
|
skipped: tuple[SkippedDocument, ...]
|
|
|
|
|
|
def plan_download_package(
|
|
documents: Sequence[ResolvedDocument],
|
|
) -> DownloadPackagePlan:
|
|
"""Lay out a Download Package from resolved documents (ADR-0060): one folder
|
|
per property, the latest file of each Document Type, null-Document-Type rows
|
|
skipped and reported."""
|
|
raise NotImplementedError
|