| 1 |
from datetime import datetime |
| 2 |
|
| 3 |
from django.core.exceptions import ValidationError |
| 4 |
from django.forms import ( |
| 5 |
CharField, |
| 6 |
Form, |
| 7 |
MultipleChoiceField, |
| 8 |
MultiValueField, |
| 9 |
MultiWidget, |
| 10 |
SelectMultiple, |
| 11 |
SplitDateTimeField, |
| 12 |
SplitDateTimeWidget, |
| 13 |
TextInput, |
| 14 |
) |
| 15 |
from django.test import SimpleTestCase |
| 16 |
|
| 17 |
beatles = (("J", "John"), ("P", "Paul"), ("G", "George"), ("R", "Ringo")) |
| 18 |
|
| 19 |
|
| 20 |
class PartiallyRequiredField(MultiValueField): |
| 21 |
def compress(self, data_list): |
| 22 |
return ",".join(data_list) if data_list else None |
| 23 |
|
| 24 |
|
| 25 |
class PartiallyRequiredForm(Form): |
| 26 |
f = PartiallyRequiredField( |
| 27 |
fields=(CharField(required=True), CharField(required=False)), |
| 28 |
required=True, |
| 29 |
require_all_fields=False, |
| 30 |
widget=MultiWidget(widgets=[TextInput(), TextInput()]), |
| 31 |
) |
| 32 |
|
| 33 |
|
| 34 |
class ComplexMultiWidget(MultiWidget): |
| 35 |
def __init__(self, attrs=None): |
| 36 |
widgets = ( |
| 37 |
TextInput(), |
| 38 |
SelectMultiple(choices=beatles), |
| 39 |
SplitDateTimeWidget(), |
| 40 |
) |
| 41 |
super().__init__(widgets, attrs) |
| 42 |
|
| 43 |
def decompress(self, value): |
| 44 |
if value: |
| 45 |
data = value.split(",") |
| 46 |
return [ |
| 47 |
data[0], |
| 48 |
list(data[1]), |
| 49 |
datetime.strptime(data[2], "%Y-%m-%d %H:%M:%S"), |
| 50 |
] |
| 51 |
return [None, None, None] |
| 52 |
|
| 53 |
|
| 54 |
class ComplexField(MultiValueField): |
| 55 |
def __init__(self, **kwargs): |
| 56 |
fields = ( |
| 57 |
CharField(), |
| 58 |
MultipleChoiceField(choices=beatles), |
| 59 |
SplitDateTimeField(), |
| 60 |
) |
| 61 |
super().__init__(fields, **kwargs) |
| 62 |
|
| 63 |
def compress(self, data_list): |
| 64 |
if data_list: |
| 65 |
return "%s,%s,%s" % (data_list[0], "".join(data_list[1]), data_list[2]) |
| 66 |
return None |
| 67 |
|
| 68 |
|
| 69 |
class ComplexFieldForm(Form): |
| 70 |
field1 = ComplexField(widget=ComplexMultiWidget()) |
| 71 |
|
| 72 |
|
| 73 |
class MultiValueFieldTest(SimpleTestCase): |
| 74 |
@classmethod |
| 75 |
def setUpClass(cls): |
| 76 |
cls.field = ComplexField(widget=ComplexMultiWidget()) |
| 77 |
super().setUpClass() |
| 78 |
|
| 79 |
def test_clean(self): |
| 80 |
self.assertEqual( |
| 81 |
self.field.clean(["some text", ["J", "P"], ["2007-04-25", "6:24:00"]]), |
| 82 |
"some text,JP,2007-04-25 06:24:00", |
| 83 |
) |
| 84 |
|
| 85 |
def test_clean_disabled_multivalue(self): |
| 86 |
class ComplexFieldForm(Form): |
| 87 |
f = ComplexField(disabled=True, widget=ComplexMultiWidget) |
| 88 |
|
| 89 |
inputs = ( |
| 90 |
"some text,JP,2007-04-25 06:24:00", |
| 91 |
["some text", ["J", "P"], ["2007-04-25", "6:24:00"]], |
| 92 |
) |
| 93 |
for data in inputs: |
| 94 |
with self.subTest(data=data): |
| 95 |
form = ComplexFieldForm({}, initial={"f": data}) |
| 96 |
form.full_clean() |
| 97 |
self.assertEqual(form.errors, {}) |
| 98 |
self.assertEqual(form.cleaned_data, {"f": inputs[0]}) |
| 99 |
|
| 100 |
def test_bad_choice(self): |
| 101 |
msg = "'Select a valid choice. X is not one of the available choices.'" |
| 102 |
with self.assertRaisesMessage(ValidationError, msg): |
| 103 |
self.field.clean(["some text", ["X"], ["2007-04-25", "6:24:00"]]) |
| 104 |
|
| 105 |
def test_no_value(self): |
| 106 |
""" |
| 107 |
If insufficient data is provided, None is substituted. |
| 108 |
""" |
| 109 |
msg = "'This field is required.'" |
| 110 |
with self.assertRaisesMessage(ValidationError, msg): |
| 111 |
self.field.clean(["some text", ["JP"]]) |
| 112 |
|
| 113 |
def test_has_changed_no_initial(self): |
| 114 |
self.assertTrue( |
| 115 |
self.field.has_changed( |
| 116 |
None, ["some text", ["J", "P"], ["2007-04-25", "6:24:00"]] |
| 117 |
) |
| 118 |
) |
| 119 |
|
| 120 |
def test_has_changed_same(self): |
| 121 |
self.assertFalse( |
| 122 |
self.field.has_changed( |
| 123 |
"some text,JP,2007-04-25 06:24:00", |
| 124 |
["some text", ["J", "P"], ["2007-04-25", "6:24:00"]], |
| 125 |
) |
| 126 |
) |
| 127 |
|
| 128 |
def test_has_changed_first_widget(self): |
| 129 |
""" |
| 130 |
Test when the first widget's data has changed. |
| 131 |
""" |
| 132 |
self.assertTrue( |
| 133 |
self.field.has_changed( |
| 134 |
"some text,JP,2007-04-25 06:24:00", |
| 135 |
["other text", ["J", "P"], ["2007-04-25", "6:24:00"]], |
| 136 |
) |
| 137 |
) |
| 138 |
|
| 139 |
def test_has_changed_last_widget(self): |
| 140 |
""" |
| 141 |
Test when the last widget's data has changed. This ensures that it is |
| 142 |
not short circuiting while testing the widgets. |
| 143 |
""" |
| 144 |
self.assertTrue( |
| 145 |
self.field.has_changed( |
| 146 |
"some text,JP,2007-04-25 06:24:00", |
| 147 |
["some text", ["J", "P"], ["2009-04-25", "11:44:00"]], |
| 148 |
) |
| 149 |
) |
| 150 |
|
| 151 |
def test_disabled_has_changed(self): |
| 152 |
f = MultiValueField(fields=(CharField(), CharField()), disabled=True) |
| 153 |
self.assertIs(f.has_changed(["x", "x"], ["y", "y"]), False) |
| 154 |
|
| 155 |
def test_form_as_table(self): |
| 156 |
form = ComplexFieldForm() |
| 157 |
self.assertHTMLEqual( |
| 158 |
form.as_table(), |
| 159 |
""" |
| 160 |
<tr><th><label>Field1:</label></th> |
| 161 |
<td><input type="text" name="field1_0" id="id_field1_0" required> |
| 162 |
<select multiple name="field1_1" id="id_field1_1" required> |
| 163 |
<option value="J">John</option> |
| 164 |
<option value="P">Paul</option> |
| 165 |
<option value="G">George</option> |
| 166 |
<option value="R">Ringo</option> |
| 167 |
</select> |
| 168 |
<input type="text" name="field1_2_0" id="id_field1_2_0" required> |
| 169 |
<input type="text" name="field1_2_1" id="id_field1_2_1" required></td></tr> |
| 170 |
""", |
| 171 |
) |
| 172 |
|
| 173 |
def test_form_as_table_data(self): |
| 174 |
form = ComplexFieldForm( |
| 175 |
{ |
| 176 |
"field1_0": "some text", |
| 177 |
"field1_1": ["J", "P"], |
| 178 |
"field1_2_0": "2007-04-25", |
| 179 |
"field1_2_1": "06:24:00", |
| 180 |
} |
| 181 |
) |
| 182 |
self.assertHTMLEqual( |
| 183 |
form.as_table(), |
| 184 |
""" |
| 185 |
<tr><th><label>Field1:</label></th> |
| 186 |
<td><input type="text" name="field1_0" value="some text" id="id_field1_0" |
| 187 |
required> |
| 188 |
<select multiple name="field1_1" id="id_field1_1" required> |
| 189 |
<option value="J" selected>John</option> |
| 190 |
<option value="P" selected>Paul</option> |
| 191 |
<option value="G">George</option> |
| 192 |
<option value="R">Ringo</option> |
| 193 |
</select> |
| 194 |
<input type="text" name="field1_2_0" value="2007-04-25" id="id_field1_2_0" |
| 195 |
required> |
| 196 |
<input type="text" name="field1_2_1" value="06:24:00" id="id_field1_2_1" |
| 197 |
required></td></tr> |
| 198 |
""", |
| 199 |
) |
| 200 |
|
| 201 |
def test_form_cleaned_data(self): |
| 202 |
form = ComplexFieldForm( |
| 203 |
{ |
| 204 |
"field1_0": "some text", |
| 205 |
"field1_1": ["J", "P"], |
| 206 |
"field1_2_0": "2007-04-25", |
| 207 |
"field1_2_1": "06:24:00", |
| 208 |
} |
| 209 |
) |
| 210 |
form.is_valid() |
| 211 |
self.assertEqual( |
| 212 |
form.cleaned_data["field1"], "some text,JP,2007-04-25 06:24:00" |
| 213 |
) |
| 214 |
|
| 215 |
def test_render_required_attributes(self): |
| 216 |
form = PartiallyRequiredForm({"f_0": "Hello", "f_1": ""}) |
| 217 |
self.assertTrue(form.is_valid()) |
| 218 |
self.assertInHTML( |
| 219 |
'<input type="text" name="f_0" value="Hello" required id="id_f_0">', |
| 220 |
form.as_p(), |
| 221 |
) |
| 222 |
self.assertInHTML('<input type="text" name="f_1" id="id_f_1">', form.as_p()) |
| 223 |
form = PartiallyRequiredForm({"f_0": "", "f_1": ""}) |
| 224 |
self.assertFalse(form.is_valid()) |