[GH-3344] GeoPandas: expose valid spatial index predicates - #3345
Merged
jiayuasu merged 2 commits intoSep 11, 2026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Did you read the Contributor Guide?
Yes, I have read the Contributor Rules and Contributor Development Guide.
Is this PR related to a ticket?
Yes, the PR name follows the format
[GH-XXX] my subject.Closes #3344. Part of #2230.
What changes were proposed in this PR?
Add the read-only
SpatialIndex.valid_query_predicatesproperty. It returns a fresh set containingNone,"intersects", and"contains", using the same supported-predicate list asquery().This only exposes the accepted predicate values. It does not add predicates or change query execution.
How was this patch tested?
From the
pythondirectory:AttributeErrorbefore implementation. They cover querying with every advertised predicate on local and Spark-backed indexes, empty indexes, and isolation of the returned set.Did this PR include necessary documentation updates?
Yes, this adds a public API. Its docstring documents the returned predicates and the default behavior, with
versionadded:: 2.0.0for the currentv2.0.0development release.