INTPYTHON-835 Add support for GIS lookups

django_mongodb_backend/gis/features.py

@@ -4,8 +4,8 @@
 
 class GISFeatures(BaseSpatialFeatures):
     has_spatialrefsys_table = False
-    supports_transform = False
     supports_distance_geodetic = False
+    supports_transform = False
 
     @cached_property
     def django_test_expected_failures(self):

django_mongodb_backend/gis/lookups.py

@@ -4,7 +4,7 @@
 from django_mongodb_backend.query_utils import process_lhs, process_rhs
 
 
-def _gis_lookup(self, compiler, connection, as_expr=False):
+def gis_lookup(self, compiler, connection, as_expr=False):
     lhs_mql = process_lhs(self, compiler, connection, as_expr=as_expr)
     rhs_mql = process_rhs(self, compiler, connection, as_expr=as_expr)
     try:
@@ -15,5 +15,5 @@ def _gis_lookup(self, compiler, connection, as_expr=False):
 
 
 def register_lookups():
-    GISLookup.as_mql = _gis_lookup
-    DistanceLookupFromFunction.as_mql = _gis_lookup
+    GISLookup.as_mql = gis_lookup
+    DistanceLookupFromFunction.as_mql = gis_lookup

django_mongodb_backend/gis/operations.py

@@ -205,7 +205,7 @@ def get_distance(self, f, value, lookup_type):
         if isinstance(value, Distance):
             if f.geodetic(self.connection):
                 raise ValueError(
-                    "Only numeric values of degree units are allowed on geodetic distance queries."
+                    "Only numeric values of radian units are allowed on geodetic distance queries."
                 )
             dist_param = getattr(value, Distance.unit_attname(f.units_name(self.connection)))
         else:

tests/gis_tests_/fixtures/initial.json

@@ -0,0 +1,98 @@
+[
+  {
+    "pk": "000000000000000000000001",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Houston",
+      "point": "POINT (-95.363151 29.763374)"
+    }
+  },
+  {
+    "pk": "000000000000000000000002",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Dallas",
+      "point": "POINT (-96.801611 32.782057)"
+    }
+  },
+  {
+    "pk": "000000000000000000000003",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Oklahoma City",
+      "point": "POINT (-97.521157 34.464642)"
+    }
+  },
+  {
+    "pk": "000000000000000000000004",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Wellington",
+      "point": "POINT (174.783117 -41.315268)"
+    }
+  },
+  {
+    "pk": "000000000000000000000005",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Pueblo",
+      "point": "POINT (-104.609252 38.255001)"
+    }
+  },
+  {
+    "pk": "000000000000000000000006",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Lawrence",
+      "point": "POINT (-95.235060 38.971823)"
+    }
+  },
+  {
+    "pk": "000000000000000000000007",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Chicago",
+      "point": "POINT (-87.650175 41.850385)"
+    }
+  },
+  {
+    "pk": "000000000000000000000008",
+    "model": "gis_tests_.city",
+    "fields": {
+      "name": "Victoria",
+      "point": "POINT (-123.305196 48.462611)"
+    }
+  },
+  {
+    "pk": "000000000000000000000001",
+    "model": "gis_tests_.zipcode",
+    "fields" : {
+       "code" : "77002",
+       "poly" : "POLYGON ((-95.365015 29.772327, -95.362415 29.772327, -95.360915 29.771827, -95.354615 29.771827, -95.351515 29.772527, -95.350915 29.765327, -95.351015 29.762436, -95.350115 29.760328, -95.347515 29.758528, -95.352315 29.753928, -95.356415 29.756328, -95.358215 29.754028, -95.360215 29.756328, -95.363415 29.757128, -95.364014 29.75638, -95.363415 29.753928, -95.360015 29.751828, -95.361815 29.749528, -95.362715 29.750028, -95.367516 29.744128, -95.369316 29.745128, -95.373916 29.744128, -95.380116 29.738028, -95.387916 29.727929, -95.388516 29.729629, -95.387916 29.732129, -95.382916 29.737428, -95.376616 29.742228, -95.372616 29.747228, -95.378601 29.750846, -95.378616 29.752028, -95.378616 29.754428, -95.376016 29.754528, -95.374616 29.759828, -95.373616 29.761128, -95.371916 29.763928, -95.372316 29.768727, -95.365884 29.76791, -95.366015 29.767127, -95.358715 29.765327, -95.358615 29.766327, -95.359115 29.767227, -95.360215 29.767027, -95.362783 29.768267, -95.365315 29.770527, -95.365015 29.772327))"
+       }
+  },
+  {
+    "pk": "000000000000000000000002",
+    "model": "gis_tests_.zipcode",
+    "fields" : {
+       "code" : "77005",
+       "poly" : "POLYGON ((-95.447918 29.727275, -95.428017 29.728729, -95.421117 29.729029, -95.418617 29.727629, -95.418517 29.726429, -95.402117 29.726629, -95.402117 29.725729, -95.395316 29.725729, -95.391916 29.726229, -95.389716 29.725829, -95.396517 29.715429, -95.397517 29.715929, -95.400917 29.711429, -95.411417 29.715029, -95.418417 29.714729, -95.418317 29.70623, -95.440818 29.70593, -95.445018 29.70683, -95.446618 29.70763, -95.447418 29.71003, -95.447918 29.727275))"
+    }
+  },
+  {
+    "pk": "000000000000000000000003",
+    "model": "gis_tests_.zipcode",
+    "fields" : {
+       "code" : "77025",
+       "poly" : "POLYGON ((-95.418317 29.70623, -95.414717 29.706129, -95.414617 29.70533, -95.418217 29.70533, -95.419817 29.69533, -95.419484 29.694196, -95.417166 29.690901, -95.414517 29.69433, -95.413317 29.69263, -95.412617 29.68973, -95.412817 29.68753, -95.414087 29.685055, -95.419165 29.685428, -95.421617 29.68513, -95.425717 29.67983, -95.425017 29.67923, -95.424517 29.67763, -95.427418 29.67763, -95.438018 29.664631, -95.436713 29.664411, -95.440118 29.662231, -95.439218 29.661031, -95.437718 29.660131, -95.435718 29.659731, -95.431818 29.660331, -95.441418 29.656631, -95.441318 29.656331, -95.441818 29.656131, -95.441718 29.659031, -95.441118 29.661031, -95.446718 29.656431, -95.446518 29.673431, -95.446918 29.69013, -95.447418 29.71003, -95.446618 29.70763, -95.445018 29.70683, -95.440818 29.70593, -95.418317 29.70623))"
+    }
+  },
+  {
+    "pk": "000000000000000000000004",
+    "model": "gis_tests_.zipcode",
+    "fields" : {
+       "code" : "77401",
+       "poly" : "POLYGON ((-95.447918 29.727275, -95.447418 29.71003, -95.446918 29.69013, -95.454318 29.68893, -95.475819 29.68903, -95.475819 29.69113, -95.484419 29.69103, -95.484519 29.69903, -95.480419 29.70133, -95.480419 29.69833, -95.474119 29.69833, -95.474119 29.70453, -95.472719 29.71283, -95.468019 29.71293, -95.468219 29.720229, -95.464018 29.720229, -95.464118 29.724529, -95.463018 29.725929, -95.459818 29.726129, -95.459918 29.720329, -95.451418 29.720429, -95.451775 29.726303, -95.451318 29.727029, -95.447918 29.727275))"
+    }
+  }
+]

tests/gis_tests_/models.py

@@ -2,4 +2,10 @@
 
 
 class City(models.Model):
+    name = models.CharField(max_length=30)
     point = models.PointField()
+
+
+class Zipcode(models.Model):
+    code = models.CharField(max_length=10)
+    poly = models.PolygonField(geography=True)

tests/gis_tests_/tests.py

@@ -1,58 +1,88 @@
 from django.contrib.gis.geos import Point
+from django.contrib.gis.measure import Distance
 from django.db import NotSupportedError
 from django.test import TestCase, skipUnlessDBFeature
 
-from .models import City
+from .models import City, Zipcode
 
 
 @skipUnlessDBFeature("gis_enabled")
 class LookupTests(TestCase):
-    def test_unsupported_lookups(self):
+    fixtures = ["initial"]
+
+    def test_unsupported(self):
         msg = "MongoDB does not support the 'same_as' lookup."
         with self.assertRaisesMessage(NotSupportedError, msg):
             City.objects.get(point__same_as=Point(95, 30))
 
-    def test_within_lookup(self):
-        city = City.objects.create(point=Point(95, 30))
-        qs = City.objects.filter(point__within=Point(95, 30).buffer(10))
-        self.assertIn(city, qs)
+    def test_contains(self):
+        houston = City.objects.get(name="Houston")
+        qs = City.objects.filter(point__contains=Point(-95.363151, 29.763374))
+        self.assertEqual(qs.count(), 1)
+        self.assertEqual(houston, qs.first())
 
-    def test_intersects_lookup(self):
-        city = City.objects.create(point=Point(95, 30))
-        qs = City.objects.filter(point__intersects=Point(95, 30).buffer(10))
-        self.assertIn(city, qs)
-
-    def test_disjoint_lookup(self):
-        city = City.objects.create(point=Point(50, 30))
+    def test_disjoint(self):
+        houston = City.objects.get(name="Houston")
         qs = City.objects.filter(point__disjoint=Point(100, 50))
-        self.assertIn(city, qs)
+        self.assertIn(houston, qs)
 
-    def test_contains_lookup(self):
-        city = City.objects.create(point=Point(95, 30))
-        qs = City.objects.filter(point__contains=Point(95, 30))
-        self.assertIn(city, qs)
+    def test_distance_gt(self):
+        houston = City.objects.get(name="Houston")
+        dallas = City.objects.get(name="Dallas")  # Roughly ~363 km from Houston
+        qs = City.objects.filter(point__distance_gt=(houston.point, 362826))
+        self.assertEqual(qs.count(), 6)
+        self.assertNotIn(dallas, list(qs))
 
-    def test_distance_gt_lookup(self):
-        city = City.objects.create(point=Point(95, 30))
-        qs = City.objects.filter(point__distance_gt=(Point(0, 0), 100))
-        self.assertIn(city, qs)
+    def test_distance_gte(self):
+        houston = City.objects.get(name="Houston")
+        dallas = City.objects.get(name="Dallas")  # Roughly ~363 km from Houston
+        qs = City.objects.filter(point__distance_gte=(houston.point, 362825))
+        self.assertEqual(qs.count(), 7)
+        self.assertIn(dallas, list(qs))
 
-    def test_distance_lt_lookup(self):
-        city = City.objects.create(point=Point(40.7589, -73.9851))
-        qs = City.objects.filter(point__distance_lt=(Point(40.7670, -73.9820), 1000))
-        self.assertIn(city, qs)
+    def test_distance_lt(self):
+        houston = City.objects.get(name="Houston")
+        qs = City.objects.filter(point__distance_lt=(houston.point, 362825))
+        self.assertEqual(qs.count(), 1)
+        self.assertEqual(houston, qs.first())
 
-    def test_distance_gte_lookup(self):
-        city = City.objects.create(point=Point(95, 30))
-        qs = City.objects.filter(point__distance_gt=(Point(0, 0), 100))
-        self.assertIn(city, qs)
+    def test_distance_lte(self):
+        houston = City.objects.get(name="Houston")
+        dallas = City.objects.get(name="Dallas")  # Roughly ~363 km from Houston
+        qs = City.objects.filter(point__distance_lte=(houston.point, 362826))
+        self.assertEqual(qs.count(), 2)
+        self.assertEqual([houston, dallas], list(qs))
 
-    def test_distance_lte_lookup(self):
-        city = City.objects.create(point=Point(40.7589, -73.9851))
-        qs = City.objects.filter(point__distance_lt=(Point(40.7670, -73.9820), 1000))
-        self.assertIn(city, qs)
+    def test_distance_units(self):
+        chicago = City.objects.get(name="Chicago")
+        lawrence = City.objects.get(name="Lawrence")
+        qs = City.objects.filter(point__distance_lt=(chicago.point, Distance(km=720)))
+        self.assertEqual(qs.count(), 2)
+        self.assertEqual([lawrence, chicago], list(qs))
+        qs = City.objects.filter(point__distance_lt=(chicago.point, Distance(mi=447)))
+        self.assertEqual(qs.count(), 2)
+        self.assertEqual([lawrence, chicago], list(qs))
 
-    def test_dwithin_lookup(self):
-        city = City.objects.create(point=Point(40.7589, -73.9851))
-        qs = City.objects.filter(point__dwithin=(Point(40.7670, -73.9820), 1000))
+    def test_dwithin(self):
+        houston = City.objects.get(name="Houston")
+        qs = City.objects.filter(point__dwithin=(houston.point, 0.2))
+        self.assertEqual(qs.count(), 5)
+
+    def test_dwithin_unsupported_units(self):
+        qs = City.objects.filter(point__dwithin=(Point(40.7670, -73.9820), Distance(km=1)))
+        with self.assertRaisesMessage(
+            ValueError,
+            "Only numeric values of radian units are allowed on geodetic distance queries.",
+        ):
+            qs.first()
+
+    def test_intersects(self):
+        city = City.objects.create(point=Point(95, 30))
+        qs = City.objects.filter(point__intersects=Point(95, 30).buffer(10))
+        self.assertEqual(qs.count(), 1)
         self.assertIn(city, qs)
+
+    def test_within(self):
+        zipcode = Zipcode.objects.get(code="77002")
+        qs = City.objects.filter(point__within=zipcode.poly).values_list("name", flat=True)
+        self.assertEqual(["Houston"], list(qs))