Skip to content

[GH-2513] chore(python): Make 'assert_geometry_almost_equal' check for Z and M dimensions too #2517

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
merged 3 commits into from
Nov 23, 2025
+85 −2
Merged

[GH-2513] chore(python): Make 'assert_geometry_almost_equal' check for Z and M dimensions too #2517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c634b8e
Make 'assert_geometry_almost_equal' check for Z and M dimensions too …
petern48 Nov 23, 2025
8a86f81
Add a docstring
petern48 Nov 23, 2025
4ce17fb
Fix ST_RotateX test in test_dataframe_api.py
petern48 Nov 23, 2025
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
2 changes: 1 addition & 1 deletion python/tests/sql/test_dataframe_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,7 +916,7 @@
("line", 10.0),
"4D_line",
"ST_ReducePrecision(geom, 2)",
"LINESTRING Z (1 -0.3 -1.383092639965822, 2 -0.59 -2.766185279931644, 3 -0.89 -4.149277919897466, -1 0.3 1.383092639965822)",
"LINESTRING ZM (1 -0.3 -1.383092639965822 1, 2 -0.59 -2.766185279931644 2, 3 -0.89 -4.149277919897466 3, -1 0.3 1.383092639965822 -1)",
),
(
stf.ST_RotateY,
Expand Down
85 changes: 84 additions & 1 deletion python/tests/test_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@
SPARK_REMOTE = os.getenv("SPARK_REMOTE")
EXTRA_JARS = os.getenv("SEDONA_PYTHON_EXTRA_JARS")

import shapely
from shapely import wkt
from shapely.geometry.base import BaseGeometry

SHAPELY_GE_210 = shapely.__version__ >= "2.1.0"


class TestBase:

Expand Down Expand Up @@ -122,14 +125,31 @@ def assert_geometry_almost_equal(
right_geom: Union[str, BaseGeometry],
tolerance=1e-6,
):
"""
Assert that two geometries are almost equal.

Note: this function will only check Z and M dimensions for shapely >= 2.1.0 (python >= 3.10)

When comparing geometries with Z or M dimensions, this function will ignore `tolerance` and check for exact equality.
Comment on lines +131 to +133
Copy link
Collaborator Author

@petern48 petern48 Nov 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Reasons for this:

  • Z and M support isn't introduced until Shapely 2.1.0

    • equals_exact only compares X and Y dimensions and not Z/M (as mentioned here in the equals_identical docs, but not the equals_exact docs...)

  • We now use equals_identical to check Z/M, but it doesn't support a tolerance parameter. I think this is fine, given the rare need for tolerance.

"""
expected_geom = (
wkt.loads(left_geom) if isinstance(left_geom, str) else left_geom
)
actual_geom = (
wkt.loads(right_geom) if isinstance(right_geom, str) else right_geom
)

if not actual_geom.equals_exact(expected_geom, tolerance=tolerance):
# Note: only shapely >= 2.1.0 supports Z and M dimensions
# If has Z or M dimension, use equals_identical to check the equality
if SHAPELY_GE_210 and (has_zm(actual_geom) or has_zm(expected_geom)):
if not shapely.equals_identical(actual_geom, expected_geom):
raise ValueError(
f"Geometry equality check failed for {left_geom} and {right_geom}"
)

# Comparison for XY geometries
# Note: equals_exact doesn't check for Z or M dimensions
elif not actual_geom.equals_exact(expected_geom, tolerance=tolerance):
# If the exact equals check fails, perform a buffer check with tolerance
if (
actual_geom.is_valid
Expand All @@ -143,3 +163,66 @@ def assert_geometry_almost_equal(
raise ValueError(
f"Geometry equality check failed for {left_geom} and {right_geom}"
)


def has_zm(geom: BaseGeometry):
return geom.has_z or geom.has_m


def test_assert_geometry_almost_equal():
import pytest

TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (1 1)")
TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (1.000001 1)")
TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (1.000001 1)")

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (2 2)")

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (2 2)")

# Check Z and M dimension compatibility (requires shapely >= 2.1.0)
if SHAPELY_GE_210:
# 2D vs 3D should fail
with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1)", "POINT (1 1 0)")

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1 0)", "POINT (1 1)")

# Different 3D should fail
with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1 1)", "POINT (1 1 2)")

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT (1 1 2)", "POINT (1 1 1)")

# Z vs M dimension should fail
with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT Z (1 1 1)", "POINT M (1 1 1)")

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal("POINT M (1 1 1)", "POINT Z (1 1 1)")

# 3D vs 4D should fail
with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal(
"POINT Z (1 1 1)", "POINT ZM (1 1 1 1)"
)

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal(
"POINT ZM (1 1 1 1)", "POINT Z (1 1 1)"
)

# Different 4D should fail
with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal(
"POINT ZM (1 1 1 1)", "POINT ZM (1 1 1 2)"
)

with pytest.raises(ValueError):
TestBase.assert_geometry_almost_equal(
"POINT ZM (1 1 1 2)", "POINT ZM (1 1 1 1)"
)
Loading