Debian Codegraph @

django/contrib/gis/db/models/sql/conversion.py

raw
1 """
2 This module holds simple classes to convert geospatial values from the
3 database.
4 """
5
6 from decimal import Decimal
7
8 from django.contrib.gis.measure import Area, Distance
9 from django.db import models
10
11
12 class AreaField(models.FloatField):
13 "Wrapper for Area values."
14
15 def __init__(self, geo_field):
16 super().__init__()
17 self.geo_field = geo_field
18
19 def get_prep_value(self, value):
20 if not isinstance(value, Area):
21 raise ValueError("AreaField only accepts Area measurement objects.")
22 return value
23
24 def get_db_prep_value(self, value, connection, prepared=False):
25 if value is None:
26 return
27 area_att = connection.ops.get_area_att_for_field(self.geo_field)
28 return getattr(value, area_att) if area_att else value
29
30 def from_db_value(self, value, expression, connection):
31 if value is None:
32 return
33 # If the database returns a Decimal, convert it to a float as expected
34 # by the Python geometric objects.
35 if isinstance(value, Decimal):
36 value = float(value)
37 # If the units are known, convert value into area measure.
38 area_att = connection.ops.get_area_att_for_field(self.geo_field)
39 return Area(**{area_att: value}) if area_att else value
40
41 def get_internal_type(self):
42 return "AreaField"
43
44
45 class DistanceField(models.FloatField):
46 "Wrapper for Distance values."
47
48 def __init__(self, geo_field):
49 super().__init__()
50 self.geo_field = geo_field
51
52 def get_prep_value(self, value):
53 if isinstance(value, Distance):
54 return value
55 return super().get_prep_value(value)
56
57 def get_db_prep_value(self, value, connection, prepared=False):
58 if not isinstance(value, Distance):
59 return value
60 distance_att = connection.ops.get_distance_att_for_field(self.geo_field)
61 if not distance_att:
62 raise ValueError(
63 "Distance measure is supplied, but units are unknown for result."
64 )
65 return getattr(value, distance_att)
66
67 def from_db_value(self, value, expression, connection):
68 if value is None:
69 return
70 distance_att = connection.ops.get_distance_att_for_field(self.geo_field)
71 return Distance(**{distance_att: value}) if distance_att else value
72
73 def get_internal_type(self):
74 return "DistanceField"