Skip to content

feat(osm-equity): FW_EQUITY_OSM_KINDS Overpass-lite mode #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlemke merged 1 commit into from
Jul 14, 2026
Merged

feat(osm-equity): FW_EQUITY_OSM_KINDS Overpass-lite mode #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions examples/osm-equity/handlers/shared/sources_real.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from __future__ import annotations

import math
import os
import time
from datetime import UTC, datetime
from typing import Any
Expand Down Expand Up @@ -233,22 +234,32 @@ def _recency_days(ts: str | None, now: datetime) -> int:
return 0


def osm_kinds() -> set[str]:
"""Which OSM feature classes to fetch (env FW_EQUITY_OSM_KINDS, default all).
Set e.g. ``poi`` for a lightweight, Overpass-friendly large-scale run (POI
attribute completeness + diversity only; building/road metrics omitted)."""
raw = os.environ.get("FW_EQUITY_OSM_KINDS", "building,road,poi")
return {k.strip() for k in raw.split(",") if k.strip()}
Comment on lines +237 to +242

@gemini-code-assist gemini-code-assist Bot Jul 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The environment variable FW_EQUITY_OSM_KINDS is parsed without case-insensitivity or validation. If a user inputs mixed-case values (e.g., POI) or invalid/empty values, it can lead to silent failures or a misleading RuntimeError claiming Overpass returned no features.

Adding case-insensitivity and validating that the specified kinds are supported (building, road, poi) will make the configuration much more robust and user-friendly.

Suggested change
def osm_kinds() -> set[str]:
"""Which OSM feature classes to fetch (env FW_EQUITY_OSM_KINDS, default all).
Set e.g. ``poi`` for a lightweight, Overpass-friendly large-scale run (POI
attribute completeness + diversity only; building/road metrics omitted)."""
raw = os.environ.get("FW_EQUITY_OSM_KINDS", "building,road,poi")
return {k.strip() for k in raw.split(",") if k.strip()}
def osm_kinds() -> set[str]:
"""Which OSM feature classes to fetch (env FW_EQUITY_OSM_KINDS, default all).
Set e.g. 'poi' for a lightweight, Overpass-friendly large-scale run (POI
attribute completeness + diversity only; building/road metrics omitted)."""
raw = os.environ.get("FW_EQUITY_OSM_KINDS", "building,road,poi")
kinds = {k.strip().lower() for k in raw.split(",") if k.strip()}
valid = {"building", "road", "poi"}
invalid = kinds - valid
if invalid:
raise ValueError(f"Unsupported OSM kinds in FW_EQUITY_OSM_KINDS: {invalid}. Supported: {valid}")
if not kinds:
raise ValueError("FW_EQUITY_OSM_KINDS cannot be empty. Supported: {valid}")
return kinds



def real_fetch_region_osm(bbox: tuple[float, float, float, float]) -> tuple[list[dict], str]:
xmin, ymin, xmax, ymax = bbox
b = f"{ymin},{xmin},{ymax},{xmax}" # Overpass order: S,W,N,E
now = datetime.now(UTC)
kinds = osm_kinds()

# buildings + amenities: centroids are enough (count/density/tags)
q_bp = (
f"[out:json][timeout:180];("
f'way["building"]({b});node["amenity"]({b});way["amenity"]({b});'
f");out center meta tags;"
)
parts = []
if "building" in kinds:
parts.append(f'way["building"]({b});')
if "poi" in kinds:
parts.append(f'node["amenity"]({b});way["amenity"]({b});')
q_bp = f"[out:json][timeout:180];({''.join(parts)});out center meta tags;" if parts else ""
# highways need geometry for length
q_hw = f'[out:json][timeout:180];(way["highway"]({b}););out geom meta tags;'

feats: list[dict] = []
for el in _overpass(q_bp):
for el in _overpass(q_bp) if q_bp else []:
tags = el.get("tags", {}) or {}
rec = _recency_days(el.get("timestamp"), now)
if el["type"] == "node":
Expand Down Expand Up @@ -277,7 +288,7 @@ def real_fetch_region_osm(bbox: tuple[float, float, float, float]) -> tuple[list
}
)

for el in _overpass(q_hw):
for el in _overpass(q_hw) if "road" in kinds else []:
geom = el.get("geometry") or []
if len(geom) < 2:
continue
Expand Down
Loading