|
| 1 | +"""ETL for HUD-assisted household count calibration targets.""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import io |
| 6 | +import logging |
| 7 | + |
| 8 | +import pandas as pd |
| 9 | +import requests |
| 10 | +from sqlmodel import Session, create_engine |
| 11 | + |
| 12 | +from policyengine_us_data.db.create_database_tables import ( |
| 13 | + Stratum, |
| 14 | + StratumConstraint, |
| 15 | + Target, |
| 16 | +) |
| 17 | +from policyengine_us_data.storage import STORAGE_FOLDER |
| 18 | +from policyengine_us_data.utils.census import STATE_ABBREV_TO_FIPS |
| 19 | +from policyengine_us_data.utils.db import ( |
| 20 | + etl_argparser, |
| 21 | + get_geographic_strata, |
| 22 | + parse_ucgid, |
| 23 | +) |
| 24 | +from policyengine_us_data.utils.raw_cache import ( |
| 25 | + is_cached, |
| 26 | + load_bytes, |
| 27 | + save_bytes, |
| 28 | +) |
| 29 | + |
| 30 | +logger = logging.getLogger(__name__) |
| 31 | + |
| 32 | +HUD_PICTURE_SOURCE = "HUD Picture of Subsidized Households" |
| 33 | + |
| 34 | + |
| 35 | +def _hud_picture_state_url(year: int) -> str: |
| 36 | + return ( |
| 37 | + "https://www.huduser.gov/portal/datasets/pictures/files/" |
| 38 | + f"STATE_{year}_2020census.xlsx" |
| 39 | + ) |
| 40 | + |
| 41 | + |
| 42 | +def extract_hud_picture_state_data(year: int) -> bytes: |
| 43 | + """Download HUD Picture of Subsidized Households state extract.""" |
| 44 | + cache_file = f"hud_picture_state_{year}_2020census.xlsx" |
| 45 | + if is_cached(cache_file): |
| 46 | + logger.info("Using cached %s", cache_file) |
| 47 | + return load_bytes(cache_file) |
| 48 | + |
| 49 | + headers = { |
| 50 | + "User-Agent": ( |
| 51 | + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) " |
| 52 | + "AppleWebKit/537.36 (KHTML, like Gecko) " |
| 53 | + "Chrome/123.0.0.0 Safari/537.36" |
| 54 | + ), |
| 55 | + "Accept": ( |
| 56 | + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet," |
| 57 | + "application/vnd.ms-excel,*/*" |
| 58 | + ), |
| 59 | + "Accept-Language": "en-US,en;q=0.9", |
| 60 | + } |
| 61 | + response = requests.get( |
| 62 | + _hud_picture_state_url(year), |
| 63 | + headers=headers, |
| 64 | + timeout=60, |
| 65 | + ) |
| 66 | + response.raise_for_status() |
| 67 | + if not response.content.startswith(b"PK"): |
| 68 | + raise ValueError( |
| 69 | + "HUD Picture state extract did not return an Excel workbook. " |
| 70 | + f"HTTP status={response.status_code}, " |
| 71 | + f"x-amzn-waf-action={response.headers.get('x-amzn-waf-action')!r}" |
| 72 | + ) |
| 73 | + save_bytes(cache_file, response.content) |
| 74 | + return response.content |
| 75 | + |
| 76 | + |
| 77 | +def transform_hud_picture_state_data(workbook_content: bytes) -> pd.DataFrame: |
| 78 | + """Return state assisted-household targets from a HUD Picture workbook.""" |
| 79 | + raw_df = pd.read_excel(io.BytesIO(workbook_content)) |
| 80 | + summary = raw_df.loc[ |
| 81 | + raw_df["program_label"].eq("Summary of All HUD Programs") |
| 82 | + & raw_df["State"].isin(STATE_ABBREV_TO_FIPS) |
| 83 | + ].copy() |
| 84 | + summary["STATE_FIPS"] = summary["State"].map(STATE_ABBREV_TO_FIPS) |
| 85 | + summary["ucgid_str"] = "0400000US" + summary["STATE_FIPS"] |
| 86 | + summary["assisted_households"] = pd.to_numeric( |
| 87 | + summary["number_reported"], |
| 88 | + errors="raise", |
| 89 | + ) |
| 90 | + return ( |
| 91 | + summary[["ucgid_str", "assisted_households"]] |
| 92 | + .sort_values("ucgid_str") |
| 93 | + .reset_index(drop=True) |
| 94 | + ) |
| 95 | + |
| 96 | + |
| 97 | +def load_housing_assistance_data(state_df: pd.DataFrame, year: int) -> None: |
| 98 | + """Load national and state assisted-household count targets.""" |
| 99 | + database_url = f"sqlite:///{STORAGE_FOLDER / 'calibration' / 'policy_data.db'}" |
| 100 | + engine = create_engine(database_url) |
| 101 | + national_households = float(state_df["assisted_households"].sum()) |
| 102 | + |
| 103 | + with Session(engine) as session: |
| 104 | + geo_strata = get_geographic_strata(session) |
| 105 | + if geo_strata["national"] is None: |
| 106 | + raise ValueError( |
| 107 | + "National stratum not found. Run create_initial_strata.py first." |
| 108 | + ) |
| 109 | + |
| 110 | + national_stratum = Stratum( |
| 111 | + parent_stratum_id=geo_strata["national"], |
| 112 | + notes="National HUD-assisted households", |
| 113 | + ) |
| 114 | + national_stratum.constraints_rel = [ |
| 115 | + StratumConstraint( |
| 116 | + constraint_variable="housing_assistance", |
| 117 | + operation=">", |
| 118 | + value="0", |
| 119 | + ) |
| 120 | + ] |
| 121 | + national_stratum.targets_rel.append( |
| 122 | + Target( |
| 123 | + variable="household_count", |
| 124 | + period=year, |
| 125 | + value=national_households, |
| 126 | + active=True, |
| 127 | + source=HUD_PICTURE_SOURCE, |
| 128 | + notes=( |
| 129 | + "HUD Picture of Subsidized Households state extract, " |
| 130 | + "Summary of All HUD Programs, number_reported column. " |
| 131 | + "This is a December point-in-time assisted-household count." |
| 132 | + ), |
| 133 | + ) |
| 134 | + ) |
| 135 | + session.add(national_stratum) |
| 136 | + session.flush() |
| 137 | + |
| 138 | + for _, row in state_df.iterrows(): |
| 139 | + state_fips = parse_ucgid(row["ucgid_str"])["state_fips"] |
| 140 | + parent_stratum_id = geo_strata["state"][state_fips] |
| 141 | + state_stratum = Stratum( |
| 142 | + parent_stratum_id=parent_stratum_id, |
| 143 | + notes=f"State FIPS {state_fips} HUD-assisted households", |
| 144 | + ) |
| 145 | + state_stratum.constraints_rel = [ |
| 146 | + StratumConstraint( |
| 147 | + constraint_variable="state_fips", |
| 148 | + operation="==", |
| 149 | + value=str(state_fips), |
| 150 | + ), |
| 151 | + StratumConstraint( |
| 152 | + constraint_variable="housing_assistance", |
| 153 | + operation=">", |
| 154 | + value="0", |
| 155 | + ), |
| 156 | + ] |
| 157 | + state_stratum.targets_rel.append( |
| 158 | + Target( |
| 159 | + variable="household_count", |
| 160 | + period=year, |
| 161 | + value=float(row["assisted_households"]), |
| 162 | + active=True, |
| 163 | + source=HUD_PICTURE_SOURCE, |
| 164 | + notes=( |
| 165 | + "HUD Picture of Subsidized Households state extract, " |
| 166 | + "Summary of All HUD Programs, number_reported column. " |
| 167 | + "This is a December point-in-time assisted-household count." |
| 168 | + ), |
| 169 | + ) |
| 170 | + ) |
| 171 | + session.add(state_stratum) |
| 172 | + |
| 173 | + session.commit() |
| 174 | + |
| 175 | + |
| 176 | +def main() -> None: |
| 177 | + _, year = etl_argparser("ETL for HUD housing assistance count targets") |
| 178 | + workbook = extract_hud_picture_state_data(year) |
| 179 | + state_df = transform_hud_picture_state_data(workbook) |
| 180 | + load_housing_assistance_data(state_df, year) |
| 181 | + |
| 182 | + |
| 183 | +if __name__ == "__main__": |
| 184 | + main() |
0 commit comments