[GH-2166] More pathing fixes for Python package refactor (#2167)

james-willis · Kontinuation · web-flow · commit 44afedd80d1b · 2025-07-29T11:19:07.000-07:00
* SedonaUtils fix * maintain backwards compat from the restructuring in #1930 mostly these are just adding "redirects" to the new location. the geoarrow I moved out of the util folder. unless we had never released this at the time, this seemed to just be a mistake that failed to maintain backwards compatability. I skipped some things because I thought maybe theyre not supported APIS: * everything in core * sedona.register outside of what is available from the init file I'm sure I missed some things here but hopefull this makes things a lot better for existing users of sedona. * PR Comments + remove SedonaMapUtils.py, its not a public interface. * revert test style changes * clean up imports * remove print statements * fix tests * Fix raster UDT import order issue --------- Co-authored-by: Kristin Cowalcijk <bo@wherobots.com>
diff --git a/python/sedona/geoarrow/__init__.py b/python/sedona/geoarrow/__init__.py
@@ -16,12 +16,13 @@
 # under the License.
 
 import warnings
-from sedona.spark.geoarrow import create_spatial_dataframe, dataframe_to_arrow
+from sedona.spark.geoarrow import dataframe_to_arrow, create_spatial_dataframe
+from sedona.spark import geoarrow
 
 warnings.warn(
     "The 'sedona.geoarrow' module is deprecated and will be removed in future versions. Please use 'sedona.spark.geoarrow' instead.",
     DeprecationWarning,
     stacklevel=2,
 )
 
-__all__ = ["create_spatial_dataframe", "dataframe_to_arrow"]
+__all__ = geoarrow.__all__
diff --git a/python/sedona/maps/SedonaKepler.py b/python/sedona/maps/SedonaKepler.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.maps.SedonaKepler import SedonaKepler
+
+__all__ = ["SedonaKepler"]
diff --git a/python/sedona/maps/SedonaPyDeck.py b/python/sedona/maps/SedonaPyDeck.py
@@ -0,0 +1,19 @@
+# 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.
+from sedona.spark.maps.SedonaPyDeck import SedonaPyDeck
+
+__all__ = ["SedonaPyDeck"]
diff --git a/python/sedona/maps/__init__.py b/python/sedona/maps/__init__.py
@@ -0,0 +1,24 @@
+# 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.
+
+import warnings
+
+warnings.warn(
+    "The 'sedona.maps' module is deprecated and will be removed in future versions. Please use 'sedona.spark.maps' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
diff --git a/python/sedona/raster/__init__.py b/python/sedona/raster/__init__.py
@@ -0,0 +1,23 @@
+# 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.
+import warnings
+
+warnings.warn(
+    "The 'sedona.raster' package structure has been reorganized. Please update your imports to use 'sedona.spark.raster' prefix instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
diff --git a/python/sedona/raster/awt_raster.py b/python/sedona/raster/awt_raster.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.raster.awt_raster import AWTRaster
+
+__all__ = ["AWTRaster"]
diff --git a/python/sedona/raster/data_buffer.py b/python/sedona/raster/data_buffer.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.raster.data_buffer import DataBuffer
+
+__all__ = ["DataBuffer"]
diff --git a/python/sedona/raster/meta.py b/python/sedona/raster/meta.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.raster.meta import PixelAnchor, AffineTransform, SampleDimension
+
+__all__ = ["PixelAnchor", "AffineTransform", "SampleDimension"]
diff --git a/python/sedona/raster/raster_serde.py b/python/sedona/raster/raster_serde.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.raster.raster_serde import RasterTypes, deserialize
+
+__all__ = ["RasterTypes", "deserialize"]
diff --git a/python/sedona/raster/sample_model.py b/python/sedona/raster/sample_model.py
@@ -0,0 +1,32 @@
+# 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.
+
+from sedona.spark.raster.sample_model import (
+    SampleModel,
+    ComponentSampleModel,
+    PixelInterleavedSampleModel,
+    SinglePixelPackedSampleModel,
+    MultiPixelPackedSampleModel,
+)
+
+__all__ = [
+    "SampleModel",
+    "ComponentSampleModel",
+    "PixelInterleavedSampleModel",
+    "SinglePixelPackedSampleModel",
+    "MultiPixelPackedSampleModel",
+]
diff --git a/python/sedona/raster/sedona_raster.py b/python/sedona/raster/sedona_raster.py
@@ -0,0 +1,24 @@
+# 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.
+
+from sedona.spark.raster.sedona_raster import (
+    GDAL_VERSION,
+    SedonaRaster,
+    InDbSedonaRaster,
+)
+
+__all__ = ["GDAL_VERSION", "SedonaRaster", "InDbSedonaRaster"]
diff --git a/python/sedona/raster_utils/SedonaUtils.py b/python/sedona/raster_utils/SedonaUtils.py
@@ -0,0 +1,20 @@
+# 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.
+
+from sedona.spark.raster_utils.SedonaUtils import SedonaUtils
+
+__all__ = ["SedonaUtils"]
diff --git a/python/sedona/raster_utils/__init__.py b/python/sedona/raster_utils/__init__.py
@@ -0,0 +1,16 @@
+# 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.
diff --git a/python/sedona/register/__init__.py b/python/sedona/register/__init__.py
@@ -15,14 +15,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from sedona.spark.register.geo_registrator import SedonaRegistrator
 import warnings
 
-from sedona.spark.geoarrow.geoarrow import create_spatial_dataframe, dataframe_to_arrow
-
 warnings.warn(
-    "The 'sedona.geoarrow' module is deprecated and will be removed in future versions. Please use 'sedona.spark.geoarrow' instead.",
+    "Importing from 'sedona.register' is deprecated. Please use 'sedona.spark.register.geo_registrator' instead.",
     DeprecationWarning,
     stacklevel=2,
 )
 
-__all__ = ["create_spatial_dataframe", "dataframe_to_arrow"]
+__all__ = ["SedonaRegistrator"]
diff --git a/python/sedona/spark/__init__.py b/python/sedona/spark/__init__.py
@@ -64,6 +64,9 @@
     add_distance_band_column,
     add_binary_distance_band_column,
 )
+from sedona.spark.raster.awt_raster import AWTRaster
+from sedona.spark.raster.data_buffer import DataBuffer
+from sedona.spark.raster.meta import SampleDimension
 from sedona.spark.utils import KryoSerializer, SedonaKryoRegistrator
 from sedona.spark.utils.adapter import Adapter
 from sedona.spark.utils.spatial_rdd_parser import GeoData
diff --git a/python/sedona/spark/sql/types.py b/python/sedona/spark/sql/types.py
@@ -113,7 +113,3 @@ def needConversion(self):
     @classmethod
     def scalaUDT(cls):
         return "org.apache.spark.sql.sedona_sql.UDT.RasterUDT"
-
-
-if SedonaRaster is not None:
-    SedonaRaster.__UDT__ = RasterType()
diff --git a/python/sedona/spark/utils/prep.py b/python/sedona/spark/utils/prep.py
@@ -44,6 +44,7 @@ def assign_all() -> bool:
     assign_udt_shapely_objects(geoms=geoms)
     assign_user_data_to_shapely_objects(geoms=geoms)
     assign_udt_geography()
+    assign_udt_raster()
     return True
 
 
@@ -64,3 +65,17 @@ def assign_udt_geography():
     from sedona.spark.sql.types import GeographyType
 
     Geography.__UDT__ = GeographyType()
+
+
+def assign_udt_raster():
+    from sedona.spark.sql.types import RasterType
+
+    try:
+        from sedona.spark.raster.sedona_raster import SedonaRaster
+
+        SedonaRaster.__UDT__ = RasterType()
+    except ImportError:
+        # Some dependencies for SedonaRaster to work is not available (for
+        # instance, rasterio), Raster support is an opt-in feature, so we
+        # ignore this error and skip registering UDT for it.
+        pass
diff --git a/python/sedona/sql/__init__.py b/python/sedona/sql/__init__.py
@@ -14,3 +14,9 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
+# These allow use to access the __all__
+from sedona.spark.sql import *
+from sedona.spark import sql
+
+__all__ = sql.__all__
diff --git a/python/sedona/utils/__init__.py b/python/sedona/utils/__init__.py
@@ -14,3 +14,13 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+import warnings
+from sedona.spark.utils.serde import KryoSerializer, SedonaKryoRegistrator
+
+warnings.warn(
+    "The 'sedona.utils' package structure has been reorganized. Please update your imports to use 'sedona.spark.utils' prefix instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["KryoSerializer", "SedonaKryoRegistrator"]
diff --git a/python/tests/test_path_compatibility.py b/python/tests/test_path_compatibility.py
diff --git a/python/tests/test_path_compatibility_all.py b/python/tests/test_path_compatibility_all.py
