Debian Codegraph @

django/contrib/postgres/forms/ranges.py

raw
1 from django import forms
2 from django.core import exceptions
3 from django.db.backends.postgresql.psycopg_any import (
4 DateRange,
5 DateTimeTZRange,
6 NumericRange,
7 )
8 from django.forms.widgets import HiddenInput, MultiWidget
9 from django.utils.translation import gettext_lazy as _
10
11 __all__ = [
12 "BaseRangeField",
13 "IntegerRangeField",
14 "DecimalRangeField",
15 "DateTimeRangeField",
16 "DateRangeField",
17 "HiddenRangeWidget",
18 "RangeWidget",
19 ]
20
21
22 class RangeWidget(MultiWidget):
23 def __init__(self, base_widget, attrs=None):
24 widgets = (base_widget, base_widget)
25 super().__init__(widgets, attrs)
26
27 def decompress(self, value):
28 if value:
29 return (value.lower, value.upper)
30 return (None, None)
31
32
33 class HiddenRangeWidget(RangeWidget):
34 """A widget that splits input into two <input type="hidden"> inputs."""
35
36 def __init__(self, attrs=None):
37 super().__init__(HiddenInput, attrs)
38
39
40 class BaseRangeField(forms.MultiValueField):
41 default_error_messages = {
42 "invalid": _("Enter two valid values."),
43 "bound_ordering": _(
44 "The start of the range must not exceed the end of the range."
45 ),
46 }
47 hidden_widget = HiddenRangeWidget
48
49 def __init__(self, **kwargs):
50 if "widget" not in kwargs:
51 kwargs["widget"] = RangeWidget(self.base_field.widget)
52 if "fields" not in kwargs:
53 kwargs["fields"] = [
54 self.base_field(required=False),
55 self.base_field(required=False),
56 ]
57 kwargs.setdefault("required", False)
58 kwargs.setdefault("require_all_fields", False)
59 self.range_kwargs = {}
60 if default_bounds := kwargs.pop("default_bounds", None):
61 self.range_kwargs = {"bounds": default_bounds}
62 super().__init__(**kwargs)
63
64 def prepare_value(self, value):
65 lower_base, upper_base = self.fields
66 if isinstance(value, self.range_type):
67 return [
68 lower_base.prepare_value(value.lower),
69 upper_base.prepare_value(value.upper),
70 ]
71 if value is None:
72 return [
73 lower_base.prepare_value(None),
74 upper_base.prepare_value(None),
75 ]
76 return value
77
78 def compress(self, values):
79 if not values:
80 return None
81 lower, upper = values
82 if lower is not None and upper is not None and lower > upper:
83 raise exceptions.ValidationError(
84 self.error_messages["bound_ordering"],
85 code="bound_ordering",
86 )
87 try:
88 range_value = self.range_type(lower, upper, **self.range_kwargs)
89 except TypeError:
90 raise exceptions.ValidationError(
91 self.error_messages["invalid"],
92 code="invalid",
93 )
94 else:
95 return range_value
96
97
98 class IntegerRangeField(BaseRangeField):
99 default_error_messages = {"invalid": _("Enter two whole numbers.")}
100 base_field = forms.IntegerField
101 range_type = NumericRange
102
103
104 class DecimalRangeField(BaseRangeField):
105 default_error_messages = {"invalid": _("Enter two numbers.")}
106 base_field = forms.DecimalField
107 range_type = NumericRange
108
109
110 class DateTimeRangeField(BaseRangeField):
111 default_error_messages = {"invalid": _("Enter two valid date/times.")}
112 base_field = forms.DateTimeField
113 range_type = DateTimeTZRange
114
115
116 class DateRangeField(BaseRangeField):
117 default_error_messages = {"invalid": _("Enter two valid dates.")}
118 base_field = forms.DateField
119 range_type = DateRange