Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

array.py 6.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. import copy
  2. from itertools import chain
  3. from django import forms
  4. from django.contrib.postgres.validators import (
  5. ArrayMaxLengthValidator, ArrayMinLengthValidator,
  6. )
  7. from django.core.exceptions import ValidationError
  8. from django.utils.translation import gettext_lazy as _
  9. from ..utils import prefix_validation_error
  10. class SimpleArrayField(forms.CharField):
  11. default_error_messages = {
  12. 'item_invalid': _('Item %(nth)s in the array did not validate: '),
  13. }
  14. def __init__(self, base_field, *, delimiter=',', max_length=None, min_length=None, **kwargs):
  15. self.base_field = base_field
  16. self.delimiter = delimiter
  17. super().__init__(**kwargs)
  18. if min_length is not None:
  19. self.min_length = min_length
  20. self.validators.append(ArrayMinLengthValidator(int(min_length)))
  21. if max_length is not None:
  22. self.max_length = max_length
  23. self.validators.append(ArrayMaxLengthValidator(int(max_length)))
  24. def clean(self, value):
  25. value = super().clean(value)
  26. return [self.base_field.clean(val) for val in value]
  27. def prepare_value(self, value):
  28. if isinstance(value, list):
  29. return self.delimiter.join(str(self.base_field.prepare_value(v)) for v in value)
  30. return value
  31. def to_python(self, value):
  32. if isinstance(value, list):
  33. items = value
  34. elif value:
  35. items = value.split(self.delimiter)
  36. else:
  37. items = []
  38. errors = []
  39. values = []
  40. for index, item in enumerate(items):
  41. try:
  42. values.append(self.base_field.to_python(item))
  43. except ValidationError as error:
  44. errors.append(prefix_validation_error(
  45. error,
  46. prefix=self.error_messages['item_invalid'],
  47. code='item_invalid',
  48. params={'nth': index},
  49. ))
  50. if errors:
  51. raise ValidationError(errors)
  52. return values
  53. def validate(self, value):
  54. super().validate(value)
  55. errors = []
  56. for index, item in enumerate(value):
  57. try:
  58. self.base_field.validate(item)
  59. except ValidationError as error:
  60. errors.append(prefix_validation_error(
  61. error,
  62. prefix=self.error_messages['item_invalid'],
  63. code='item_invalid',
  64. params={'nth': index},
  65. ))
  66. if errors:
  67. raise ValidationError(errors)
  68. def run_validators(self, value):
  69. super().run_validators(value)
  70. errors = []
  71. for index, item in enumerate(value):
  72. try:
  73. self.base_field.run_validators(item)
  74. except ValidationError as error:
  75. errors.append(prefix_validation_error(
  76. error,
  77. prefix=self.error_messages['item_invalid'],
  78. code='item_invalid',
  79. params={'nth': index},
  80. ))
  81. if errors:
  82. raise ValidationError(errors)
  83. class SplitArrayWidget(forms.Widget):
  84. template_name = 'postgres/widgets/split_array.html'
  85. def __init__(self, widget, size, **kwargs):
  86. self.widget = widget() if isinstance(widget, type) else widget
  87. self.size = size
  88. super().__init__(**kwargs)
  89. @property
  90. def is_hidden(self):
  91. return self.widget.is_hidden
  92. def value_from_datadict(self, data, files, name):
  93. return [self.widget.value_from_datadict(data, files, '%s_%s' % (name, index))
  94. for index in range(self.size)]
  95. def value_omitted_from_data(self, data, files, name):
  96. return all(
  97. self.widget.value_omitted_from_data(data, files, '%s_%s' % (name, index))
  98. for index in range(self.size)
  99. )
  100. def id_for_label(self, id_):
  101. # See the comment for RadioSelect.id_for_label()
  102. if id_:
  103. id_ += '_0'
  104. return id_
  105. def get_context(self, name, value, attrs=None):
  106. attrs = {} if attrs is None else attrs
  107. context = super().get_context(name, value, attrs)
  108. if self.is_localized:
  109. self.widget.is_localized = self.is_localized
  110. value = value or []
  111. context['widget']['subwidgets'] = []
  112. final_attrs = self.build_attrs(attrs)
  113. id_ = final_attrs.get('id')
  114. for i in range(max(len(value), self.size)):
  115. try:
  116. widget_value = value[i]
  117. except IndexError:
  118. widget_value = None
  119. if id_:
  120. final_attrs = dict(final_attrs, id='%s_%s' % (id_, i))
  121. context['widget']['subwidgets'].append(
  122. self.widget.get_context(name + '_%s' % i, widget_value, final_attrs)['widget']
  123. )
  124. return context
  125. @property
  126. def media(self):
  127. return self.widget.media
  128. def __deepcopy__(self, memo):
  129. obj = super().__deepcopy__(memo)
  130. obj.widget = copy.deepcopy(self.widget)
  131. return obj
  132. @property
  133. def needs_multipart_form(self):
  134. return self.widget.needs_multipart_form
  135. class SplitArrayField(forms.Field):
  136. default_error_messages = {
  137. 'item_invalid': _('Item %(nth)s in the array did not validate: '),
  138. }
  139. def __init__(self, base_field, size, *, remove_trailing_nulls=False, **kwargs):
  140. self.base_field = base_field
  141. self.size = size
  142. self.remove_trailing_nulls = remove_trailing_nulls
  143. widget = SplitArrayWidget(widget=base_field.widget, size=size)
  144. kwargs.setdefault('widget', widget)
  145. super().__init__(**kwargs)
  146. def clean(self, value):
  147. cleaned_data = []
  148. errors = []
  149. if not any(value) and self.required:
  150. raise ValidationError(self.error_messages['required'])
  151. max_size = max(self.size, len(value))
  152. for index in range(max_size):
  153. item = value[index]
  154. try:
  155. cleaned_data.append(self.base_field.clean(item))
  156. except ValidationError as error:
  157. errors.append(prefix_validation_error(
  158. error,
  159. self.error_messages['item_invalid'],
  160. code='item_invalid',
  161. params={'nth': index},
  162. ))
  163. cleaned_data.append(None)
  164. else:
  165. errors.append(None)
  166. if self.remove_trailing_nulls:
  167. null_index = None
  168. for i, value in reversed(list(enumerate(cleaned_data))):
  169. if value in self.base_field.empty_values:
  170. null_index = i
  171. else:
  172. break
  173. if null_index is not None:
  174. cleaned_data = cleaned_data[:null_index]
  175. errors = errors[:null_index]
  176. errors = list(filter(None, errors))
  177. if errors:
  178. raise ValidationError(list(chain.from_iterable(errors)))
  179. return cleaned_data