1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
from django import forms
from django.test import TestCase, override_settings
from django_filters.filters import CharFilter, ChoiceFilter
from django_filters.filterset import FilterSet
from .models import MANAGER, REGULAR, STATUS_CHOICES, Book, ManagerGroup, User
class FilterSetFormTests(TestCase):
def test_form_from_empty_filterset(self):
class F(FilterSet):
pass
f = F(queryset=Book.objects.all()).form
self.assertIsInstance(f, forms.Form)
def test_form(self):
class F(FilterSet):
class Meta:
model = Book
fields = ("title",)
f = F().form
self.assertIsInstance(f, forms.Form)
self.assertEqual(list(f.fields), ["title"])
def test_custom_form(self):
class MyForm(forms.Form):
pass
class F(FilterSet):
class Meta:
model = Book
fields = "__all__"
form = MyForm
f = F().form
self.assertIsInstance(f, MyForm)
def test_form_prefix(self):
class F(FilterSet):
class Meta:
model = Book
fields = ("title",)
f = F().form
self.assertIsNone(f.prefix)
f = F(prefix="prefix").form
self.assertEqual(f.prefix, "prefix")
def test_form_fields(self):
class F(FilterSet):
class Meta:
model = User
fields = ["status"]
f = F().form
self.assertEqual(len(f.fields), 1)
self.assertIn("status", f.fields)
self.assertSequenceEqual(
list(f.fields["status"].choices), (("", "---------"),) + STATUS_CHOICES
)
def test_form_fields_exclusion(self):
class F(FilterSet):
title = CharFilter(exclude=True)
class Meta:
model = Book
fields = ("title",)
f = F().form
self.assertEqual(f.fields["title"].label, "Exclude title")
def test_complex_form_fields(self):
class F(FilterSet):
username = CharFilter(label="Filter for users with username")
exclude_username = CharFilter(
field_name="username", lookup_expr="iexact", exclude=True
)
class Meta:
model = User
fields = {
"status": ["exact", "lt", "gt"],
"favorite_books__title": ["iexact", "in"],
"manager_of__users__username": ["exact"],
}
fields = F().form.fields
self.assertEqual(fields["username"].label, "Filter for users with username")
self.assertEqual(fields["exclude_username"].label, "Exclude username")
self.assertEqual(fields["status"].label, "Status")
self.assertEqual(fields["status__lt"].label, "Status is less than")
self.assertEqual(fields["status__gt"].label, "Status is greater than")
self.assertEqual(
fields["favorite_books__title__iexact"].label, "Favorite books title"
)
self.assertEqual(
fields["favorite_books__title__in"].label, "Favorite books title is in"
)
self.assertEqual(
fields["manager_of__users__username"].label, "Manager of users username"
)
def test_form_fields_using_widget(self):
class F(FilterSet):
status = ChoiceFilter(
widget=forms.RadioSelect, choices=STATUS_CHOICES, empty_label=None
)
class Meta:
model = User
fields = ["status", "username"]
f = F().form
self.assertEqual(len(f.fields), 2)
self.assertIn("status", f.fields)
self.assertIn("username", f.fields)
self.assertSequenceEqual(list(f.fields["status"].choices), STATUS_CHOICES)
self.assertIsInstance(f.fields["status"].widget, forms.RadioSelect)
def test_form_field_with_custom_label(self):
class F(FilterSet):
title = CharFilter(label="Book title")
class Meta:
model = Book
fields = ("title",)
f = F().form
self.assertEqual(f.fields["title"].label, "Book title")
self.assertEqual(f["title"].label, "Book title")
def test_form_field_with_manual_name(self):
class F(FilterSet):
book_title = CharFilter(field_name="title")
class Meta:
model = Book
fields = ("book_title",)
f = F().form
self.assertEqual(f.fields["book_title"].label, "Title")
self.assertEqual(f["book_title"].label, "Title")
def test_form_field_with_manual_name_and_label(self):
class F(FilterSet):
f1 = CharFilter(field_name="title", label="Book title")
class Meta:
model = Book
fields = ("f1",)
f = F().form
self.assertEqual(f.fields["f1"].label, "Book title")
self.assertEqual(f["f1"].label, "Book title")
def test_filter_with_initial(self):
class F(FilterSet):
status = ChoiceFilter(choices=STATUS_CHOICES, initial=1)
class Meta:
model = User
fields = ["status"]
f = F().form
self.assertEqual(f.fields["status"].initial, 1)
def test_form_is_not_bound(self):
class F(FilterSet):
class Meta:
model = Book
fields = ("title",)
f = F().form
self.assertFalse(f.is_bound)
self.assertEqual(f.data, {})
def test_form_is_bound(self):
class F(FilterSet):
class Meta:
model = Book
fields = ("title",)
f = F({"title": "Some book"}).form
self.assertTrue(f.is_bound)
self.assertEqual(f.data, {"title": "Some book"})
def test_limit_choices_to(self):
User.objects.create(username="inactive", is_active=False, status=REGULAR)
u2 = User.objects.create(username="active", is_active=True, status=REGULAR)
u3 = User.objects.create(username="manager", is_active=False, status=MANAGER)
class F(FilterSet):
class Meta:
model = ManagerGroup
fields = ["users", "manager"]
f = F().form
self.assertEqual(list(f.fields["users"].choices), [(u2.pk, "active")])
self.assertEqual(
list(f.fields["manager"].choices), [("", "---------"), (u3.pk, "manager")]
)
def test_disabled_help_text(self):
class F(FilterSet):
class Meta:
model = Book
fields = {
# 'in' lookups are CSV-based, which have a `help_text`.
"title": ["in"]
}
self.assertEqual(
F().form.fields["title__in"].help_text,
"Multiple values may be separated by commas.",
)
with override_settings(FILTERS_DISABLE_HELP_TEXT=True):
self.assertEqual(F().form.fields["title__in"].help_text, "")
class FilterSetValidityTests(TestCase):
class F(FilterSet):
class Meta:
model = Book
fields = ["title", "price"]
def test_not_bound(self):
f = self.F()
self.assertFalse(f.is_bound)
self.assertFalse(f.is_valid())
self.assertEqual(f.data, {})
self.assertEqual(f.errors, {})
def test_is_bound_and_valid(self):
f = self.F({"title": "Some book"})
self.assertTrue(f.is_bound)
self.assertTrue(f.is_valid())
self.assertEqual(f.data, {"title": "Some book"})
self.assertEqual(f.errors, {})
def test_is_bound_and_not_valid(self):
f = self.F({"price": "four dollars"})
self.assertTrue(f.is_bound)
self.assertFalse(f.is_valid())
self.assertEqual(f.data, {"price": "four dollars"})
self.assertEqual(f.errors, {"price": ["Enter a number."]})
def test_number_filter_max_value_validation(self):
class F(FilterSet):
class Meta:
model = Book
fields = ["average_rating"]
f = F({"average_rating": "1E1001"})
self.assertTrue(f.is_bound)
self.assertFalse(f.is_valid())
self.assertEqual(
f.errors,
{"average_rating": ["Ensure this value is less than or equal to 1e+50."]},
)
|
