uros-db commented on code in PR #54571: URL: https://github.com/apache/spark/pull/54571#discussion_r2884675990
########## dev/generate_srs_registry.py: ########## @@ -0,0 +1,377 @@ +#!/usr/bin/env python3 + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +""" +Generate the Spatial Reference System (SRS) registry for Apache Spark. + +Downloads CRS definitions from the PROJ (Cartographic Projections and +Coordinate Transformations Library) GitHub repository and generates a CSV +file used by Spark for geospatial types on both the JVM and Python sides. + +PROJ is a C/C++ library (https://proj.org/) that maintains the authoritative +EPSG and ESRI CRS databases. This script extracts SRID metadata from PROJ's +SQL source files, which contain easily parseable plain-text SRS information. + +The script produces entries from the following PROJ SQL files: + - geodetic_crs.sql (EPSG geodetic CRS: geographic, geocentric, etc.) + - projected_crs.sql (EPSG projected CRS) + - compound_crs.sql (EPSG compound CRS) + - vertical_crs.sql (EPSG vertical CRS) + - engineering_crs.sql (EPSG engineering CRS) + - esri.sql (ESRI geodetic, projected, compound, vertical, engineering CRS) + +Additionally, the following special entries are added: + - SRID 0 -> SRID:0 (Spark convention: Cartesian, no defined SRS) + - SRID 4267 -> OGC:CRS27 (OGC standardization of NAD27) + - SRID 4269 -> OGC:CRS83 (OGC standardization of NAD83) + - SRID 4326 -> OGC:CRS84 (OGC standardization of WGS 84) + +Prerequisites: + Python 3.9+ (no third-party packages required) + +Usage: + # Generate from the default PROJ version: + python dev/generate_srs_registry.py + + # Generate from a specific PROJ version: + python dev/generate_srs_registry.py --proj-version 9.7.1 + + # Verify the generated files: + wc -l sql/api/src/main/resources/org/apache/spark/sql/srs_registry.csv + wc -l python/pyspark/sql/srs_registry.csv + +Upgrade workflow: + 1. Update `DEFAULT_PROJ_VERSION` to the new PROJ release tag. + 2. Run this script using `python dev/generate_srs_registry.py`. + 3. Review the diff to see which SRIDs were added or removed. +""" + +import argparse +import csv +import os +import re +import sys +import urllib.request + +# Default PROJ version to download SQL files from. +DEFAULT_PROJ_VERSION = "9.7.1" +# PLEASE ENSURE THIS IS UPDATED TO A VALID PROJ VERSION TAG WHEN UPGRADING! + +# URL template for raw SQL files from the PROJ GitHub repository. +PROJ_RAW_URL = "https://raw.githubusercontent.com/OSGeo/PROJ/{version}/data/sql/{filename}"; + +# PROJ SQL files to download. EPSG CRS definitions are spread across +# dedicated files, while ESRI definitions are all in a single file. +PROJ_SQL_FILES = [ + "geodetic_crs.sql", + "projected_crs.sql", + "compound_crs.sql", + "vertical_crs.sql", + "engineering_crs.sql", + "esri.sql", +] + +# OGC special cases: these SRIDs are standardized under OGC rather than EPSG. +# The OGC string IDs override the EPSG ones for these SRIDs. +OGC_SPECIAL_CASES = { + 4267: "OGC:CRS27", # NAD27 + 4269: "OGC:CRS83", # NAD83 + 4326: "OGC:CRS84", # WGS 84 +} + +# Output paths for the generated CSV, relative to the Spark repo root. +JAVA_RESOURCE_PATH = os.path.join( + "sql", "api", "src", "main", "resources", "org", "apache", "spark", "sql", "srs_registry.csv" +) +PYTHON_RESOURCE_PATH = os.path.join("python", "pyspark", "sql", "srs_registry.csv") + + +def download_sql(version, filename): + """Download a SQL file from the PROJ GitHub repository at a pinned version tag.""" + url = PROJ_RAW_URL.format(version=version, filename=filename) + print(f" Downloading {url}") + try: + with urllib.request.urlopen(url) as response: + return response.read().decode("utf-8") + except urllib.error.HTTPError as e: Review Comment: Makes sense, URLError will cover HTTP errors, DNS failures, timeouts, and SSL issues in one catch. Udpdating accordingly. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
