mirror of
https://github.com/apache/superset.git
synced 2026-05-24 17:25:20 +00:00
Covers the pure-Python helpers and YAML-applied transforms that the build pipeline relies on. Subprocess calls (mapshaper, NE download) are not exercised — those are integration concerns covered by the regen workflow itself. Test categories: - _matches (4 tests): scalar equality, AND'd conditions, `in: [...]` list-membership matcher, missing property - _bbox_center (2 tests): unit square, offset square - _translate_and_scale (4 tests): pure translate, scale-around-centroid, combined transform, multipolygon handling - _translate_and_scale_with_pivot (1 test): shared pivot preserves relative positions of grouped features (the Paris-petite-couronne case) - _drop_parts (2 tests): drops specified indices, polygon unchanged - _bbox_contains (2 tests): inside-bbox, outside-bbox-west - apply_name_overrides (1 test): applies only to matching features, respects match conditions across countries (FRA "Seien" vs GBR "Seien" don't collide) - apply_flying_islands (2 tests): repositions matched features, drop_outside_bbox guarded to Admin 1 only (the bug we fixed earlier) Wired into the regen workflow as a step that runs BEFORE the build, so a broken transform fails CI before producing potentially-bad output files. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Country Map data pipeline
This directory contains the build pipeline that turns upstream Natural Earth data into the GeoJSON files consumed by @superset-ui/plugin-chart-country-map.
It replaces the legacy scripts/Country Map GeoJSON Generator.ipynb notebook. See SIP_DRAFT.md in the parent directory for the full design rationale.
Layout
scripts/
build.sh # one-shot reproducible build
README.md # this file
config/ # declarative YAML — handles ~95% of fixes
name_overrides.yaml # typos, deprecated ISO codes, admin renames
flying_islands.yaml # repositioning + bbox drops for far-flung territories
territory_assignments.yaml # add features from sibling Admin 0 records
regional_aggregations.yaml # dissolve Admin 1 into administrative regions
composite_maps.yaml # multi-country composites (e.g. France-with-Overseas)
procedural/ # escape hatch — handles the rare 5%
README.md # when to use, when not
NN_<descriptive_name>.py # one focused script per genuine edge case
output/ # gitignored — build artifacts
Operating principles
- Default tool: declarative YAML. Most touchups are renames, repositions, dissolves, or filters — all expressible in YAML. Diffs are small, conflicts localize cleanly to one entry, contributors can submit "fix typo X" as a one-line PR.
- Escape hatch:
procedural/directory of small, named, single-purpose Python scripts for the rare cases YAML can't express cleanly. Each script has a header comment explaining why it's not in YAML. Seeprocedural/README.mdfor the bar. - Build is reproducible from a pinned NE version.
build.shrecords the NE git SHA it consumed; outputs are deterministic given inputs. - CI regenerates on schema change and opens a PR if outputs differ. Maintainers review the cartographic diff in legible GeoJSON, not opaque notebook JSON.
Workflow for adding a fix
- Identify the upstream NE issue (wrong name, missing territory, etc.).
- Try YAML first. Add the smallest possible entry to the appropriate config file with a
descriptionfield explaining the fix. - If YAML can't express it cleanly, add a numbered script in
procedural/with a header comment explaining why YAML didn't fit. - Run
build.shlocally, verify the output GeoJSON looks right. - Open PR. Reviewer sees the YAML diff (or new procedural script) plus the regenerated GeoJSON.
See also
SIP_DRAFT.md(parent dir) — design rationale, notebook audit, obsolescence checkprocedural/README.md— when to use the escape hatch