Feature: Add geometry filters #710
Open
Conversation
This file contains 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
Reviewer's Guide by SourceryThis pull request introduces the Class diagram for GeometryFilterLookupclassDiagram
class GeometryFilterLookup {
bbcontains: Geometry
bboverlaps: Geometry
contained: Geometry
contains: Geometry
contains_properly: Geometry
coveredby: Geometry
covers: Geometry
crosses: Geometry
disjoint: Geometry
equals: Geometry
exacts: Geometry
intersects: Geometry
isempty: bool
isvalid: bool
overlaps: Geometry
touches: Geometry
within: Geometry
left: Geometry
right: Geometry
overlaps_left: Geometry
overlaps_right: Geometry
overlaps_above: Geometry
overlaps_below: Geometry
strictly_above: Geometry
strictly_below: Geometry
}
note for GeometryFilterLookup "This class is only available when GeoDjango is installed"
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
for more information, see https://pre-commit.ci
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @shmoon-kr - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a test case to ensure that the GeometryFilterLookup works as expected.
- It might be worth extracting the GeometryFilterLookup try/except block into a separate function or module to improve readability.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
strawberry_django/fields/types.py
Outdated
| @@ -557,9 +558,11 @@ | |||
| ): | |||
| if using_old_filters: | |||
| field_type = filters.FilterLookup[field_type] | |||
| elif type(field_type) is ScalarWrapper and field_type._scalar_definition.name in ("Point", "LineString", "LinearRing", "Polygon", "MultiPoint", "MultilineString", "MultiPolygon", "Geometry"): | |||
There was a problem hiding this comment.
suggestion: Consider using isinstance for type checking of ScalarWrapper.
Using 'type(field_type) is ScalarWrapper' might be too strict if subclasses of ScalarWrapper should also match. Switching to isinstance(field_type, ScalarWrapper) could provide a more flexible and robust check.
Suggested change
| elif type(field_type) is ScalarWrapper and field_type._scalar_definition.name in ("Point", "LineString", "LinearRing", "Polygon", "MultiPoint", "MultilineString", "MultiPolygon", "Geometry"): | |
| elif isinstance(field_type, ScalarWrapper) and field_type._scalar_definition.name in ("Point", "LineString", "LinearRing", "Polygon", "MultiPoint", "MultilineString", "MultiPolygon", "Geometry"): |
| pass | ||
| else: | ||
| @strawberry.input | ||
| class GeometryFilterLookup(Generic[T]): |
There was a problem hiding this comment.
issue (complexity): Consider dynamically generating the geometry fields to reduce code duplication.
Consider reducing the repetitive field definitions by generating the geometry fields dynamically. For example, you can define a list of method names and then use a helper to build your fields. This will reduce the nesting and repetitive code without changing functionality. For instance:
try:
from django.contrib.gis.geos import GEOSGeometry
except ImproperlyConfigured:
# If gdal is not available, skip.
pass
else:
GEO_FIELD_TYPE = Optional[Annotated["Geometry", strawberry.lazy(".types")]]
geometry_methods = [
"bbcontains", "bboverlaps", "contained", "contains", "contains_properly",
"coveredby", "covers", "crosses", "disjoint", "equals", "exacts",
"intersects", "overlaps", "touches", "within", "left", "right",
"overlaps_left", "overlaps_right", "overlaps_above", "overlaps_below",
"strictly_above", "strictly_below",
]
def _build_geometry_fields():
fields = {name: UNSET for name in geometry_methods}
fields.update({
"isempty": filter_field(description=f"Test whether it's empty. {_SKIP_MSG}"),
"isvalid": filter_field(description=f"Test whether it's valid. {_SKIP_MSG}"),
})
return fields
GeometryFields = _build_geometry_fields()
GeometryFilterLookup = strawberry.input(
type("GeometryFilterLookup", (Generic[T],), GeometryFields)
)This refactoring maintains all functionality while reducing the duplication and nesting in your class definition.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #710 +/- ##
==========================================
- Coverage 88.11% 88.10% -0.01%
==========================================
Files 42 42
Lines 3853 3894 +41
==========================================
+ Hits 3395 3431 +36
- Misses 458 463 +5 ☔ View full report in Codecov by Sentry. |
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.
Description
Added GeometryLookupFilter type so that spatial filters available in GeoDjango can be used in strawberry_django.
Types of Changes
Issues Fixed or Closed by This PR
Checklist
Summary by Sourcery
Adds support for spatial filters from GeoDjango within strawberry-django. It introduces a new GeometryFilterLookup type and integrates it into the existing filter system, allowing users to filter data based on geographical relationships.
New Features:
Enhancements: