Skip to content

Forms

hypha.apply.funds.forms

ApplicationSubmissionModelForm

Bases: ModelForm

Application Submission model's save method performs several operations which are not required in forms which update fields like status, partners etc. It also has a side effect of creating a new file uploads every time with long filenames (#1572).

save 

save(commit=True)

Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance. https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444

Source code in hypha/apply/funds/forms.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def save(self, commit=True):
    """
    Save this form's self.instance object if commit=True. Otherwise, add
    a save_m2m() method to the form which can be called after the instance
    is saved manually at a later time. Return the model instance.
    https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444
    """
    if self.errors:
        raise ValueError(
            "The %s could not be %s because the data didn't validate."
            % (
                self.instance._meta.object_name,
                "created" if self.instance._state.adding else "changed",
            )
        )
    if commit:
        # If committing, save the instance and the m2m data immediately.
        self.instance.save(skip_custom=True)
        self._save_m2m()
    else:
        # If not committing, add a method to the form to allow deferred
        # saving of m2m data.
        self.save_m2m = self._save_m2m
    return self.instance

ProgressSubmissionForm 

ProgressSubmissionForm(*args, **kwargs)

Bases: ApplicationSubmissionModelForm

Source code in hypha/apply/funds/forms.py 
70
71
72
73
74
75
76
77
78
def __init__(self, *args, **kwargs):
    self.user = kwargs.pop("user")
    super().__init__(*args, **kwargs)
    choices = list(self.instance.get_actions_for_user(self.user))
    # Sort the transitions by the order they are listed.
    sort_by = list(self.instance.phase.transitions.keys())
    choices.sort(key=lambda k: sort_by.index(k[0]))
    action_field = self.fields["action"]
    action_field.choices = choices

action class-attribute instance-attribute 

action = ChoiceField(label=gettext_lazy('Take action'))

user instance-attribute 

user = pop('user')

Meta

model class-attribute instance-attribute 
model = ApplicationSubmission
fields class-attribute instance-attribute 
fields = []

save 

save(commit=True)

Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance. https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444

Source code in hypha/apply/funds/forms.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def save(self, commit=True):
    """
    Save this form's self.instance object if commit=True. Otherwise, add
    a save_m2m() method to the form which can be called after the instance
    is saved manually at a later time. Return the model instance.
    https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444
    """
    if self.errors:
        raise ValueError(
            "The %s could not be %s because the data didn't validate."
            % (
                self.instance._meta.object_name,
                "created" if self.instance._state.adding else "changed",
            )
        )
    if commit:
        # If committing, save the instance and the m2m data immediately.
        self.instance.save(skip_custom=True)
        self._save_m2m()
    else:
        # If not committing, add a method to the form to allow deferred
        # saving of m2m data.
        self.save_m2m = self._save_m2m
    return self.instance

UpdateSubmissionLeadForm 

UpdateSubmissionLeadForm(*args, **kwargs)

Bases: ApplicationSubmissionModelForm

Source code in hypha/apply/funds/forms.py 
86
87
88
89
90
91
92
93
def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    lead_field = self.fields["lead"]
    lead_field.label = _("Update lead from {lead} to").format(
        lead=self.instance.lead
    )
    lead_field.queryset = lead_field.queryset.exclude(id=self.instance.lead.id)
    lead_field.widget.attrs.update({"data-js-choices": ""})

Meta

model class-attribute instance-attribute 
model = ApplicationSubmission
fields class-attribute instance-attribute 
fields = ('lead',)

save 

save(commit=True)

Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance. https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444

Source code in hypha/apply/funds/forms.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def save(self, commit=True):
    """
    Save this form's self.instance object if commit=True. Otherwise, add
    a save_m2m() method to the form which can be called after the instance
    is saved manually at a later time. Return the model instance.
    https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444
    """
    if self.errors:
        raise ValueError(
            "The %s could not be %s because the data didn't validate."
            % (
                self.instance._meta.object_name,
                "created" if self.instance._state.adding else "changed",
            )
        )
    if commit:
        # If committing, save the instance and the m2m data immediately.
        self.instance.save(skip_custom=True)
        self._save_m2m()
    else:
        # If not committing, add a method to the form to allow deferred
        # saving of m2m data.
        self.save_m2m = self._save_m2m
    return self.instance

UpdateReviewersForm 

UpdateReviewersForm(*args, **kwargs)

Bases: ApplicationSubmissionModelForm

Source code in hypha/apply/funds/forms.py 
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
def __init__(self, *args, **kwargs):
    self.user = kwargs.pop("user")
    if kwargs.get("instance"):
        # Providing initials(from model's instance) to BaseModelForm
        kwargs["initial"] = model_form_initial(
            kwargs.get("instance"), self._meta.fields, self._meta.exclude
        )
    super().__init__(*args, **kwargs)

    # convert a python dict to orderedDict, to use move_to_end method
    self.fields = OrderedDict(self.fields)

    assigned_roles = {
        assigned.role: assigned.reviewer
        for assigned in self.instance.assigned.filter(role__isnull=False)
    }

    self.role_fields = {}
    field_data = make_role_reviewer_fields()

    for data in field_data:
        field_name = data["field_name"]
        self.fields[field_name] = data["field"]
        self.role_fields[field_name] = data["role"]
        self.fields[field_name].initial = assigned_roles.get(data["role"])
        self.fields[field_name].widget.attrs.update({"data-js-choices": ""})

    self.submitted_reviewers = User.objects.filter(
        id__in=self.instance.assigned.reviewed().values("reviewer"),
    )

    if can_change_external_reviewers(user=self.user, submission=self.instance):
        reviewers = self.instance.reviewers.all().only("pk")
        self.prepare_field(
            "reviewer_reviewers",
            initial=reviewers,
            excluded=self.submitted_reviewers,
        )

        # Move the non-role reviewers field to the end of the field list
        self.fields.move_to_end("reviewer_reviewers")
    else:
        self.fields.pop("reviewer_reviewers")

reviewer_reviewers class-attribute instance-attribute 

reviewer_reviewers = ModelMultipleChoiceField(queryset=only('pk', 'full_name'), label=gettext_lazy('External Reviewers'), required=False)

user instance-attribute 

user = pop('user')

fields instance-attribute 

fields = OrderedDict(fields)

role_fields instance-attribute 

role_fields = {}

submitted_reviewers instance-attribute 

submitted_reviewers = filter(id__in=values('reviewer'))

Meta

model class-attribute instance-attribute 
model = ApplicationSubmission
fields class-attribute instance-attribute 
fields = []

prepare_field 

prepare_field(field_name, initial, excluded)
Source code in hypha/apply/funds/forms.py 
154
155
156
157
def prepare_field(self, field_name, initial, excluded):
    field = self.fields[field_name]
    field.queryset = field.queryset.exclude(id__in=excluded)
    field.initial = initial

clean 

clean()
Source code in hypha/apply/funds/forms.py 
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
def clean(self):
    cleaned_data = super().clean()
    role_reviewers = [
        user
        for field, user in self.cleaned_data.items()
        if field in self.role_fields and user
    ]

    for field, role in self.role_fields.items():
        assigned_reviewer = AssignedReviewers.objects.filter(
            role=role, submission=self.instance
        ).last()
        if (
            assigned_reviewer
            and (not cleaned_data[field] and assigned_reviewer.reviewer.is_active)
            and assigned_reviewer.reviewer in self.submitted_reviewers
        ):
            self.add_error(
                field,
                _("Can't unassign, just change, because review already submitted"),
            )
            break

    # If any of the users match and are set to multiple roles, throw an error
    if len(role_reviewers) != len(set(role_reviewers)) and any(role_reviewers):
        self.add_error(None, _("Users cannot be assigned to multiple roles."))

    return cleaned_data

save 

save(*args, **kwargs)
  1. Update role reviewers
  2. Update non-role reviewers 2a. Remove those not on form 2b. Add in any new non-role reviewers selected
Source code in hypha/apply/funds/forms.py 
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
def save(self, *args, **kwargs):
    """
    1. Update role reviewers
    2. Update non-role reviewers
        2a. Remove those not on form
        2b. Add in any new non-role reviewers selected
    """
    with disable_reference_index_auto_update():
        instance = super().save(*args, **kwargs)

        # 1. Update role reviewers
        assigned_roles = {
            role: self.cleaned_data[field]
            for field, role in self.role_fields.items()
        }
        for role, reviewer in assigned_roles.items():
            if reviewer:
                AssignedReviewers.objects.update_role(role, reviewer, instance)
            else:
                AssignedReviewers.objects.filter(
                    role=role, submission=instance, review__isnull=True
                ).delete()

        # 2. Update non-role reviewers
        # 2a. Remove those not on form
        if can_change_external_reviewers(submission=self.instance, user=self.user):
            reviewers = self.cleaned_data.get("reviewer_reviewers")
            assigned_reviewers = instance.assigned.without_roles()
            assigned_reviewers.never_tried_to_review().exclude(
                reviewer__in=reviewers
            ).delete()

            remaining_reviewers = assigned_reviewers.values_list(
                "reviewer_id", flat=True
            )

            # 2b. Add in any new non-role reviewers selected
            AssignedReviewers.objects.bulk_create_reviewers(
                [
                    reviewer
                    for reviewer in reviewers
                    if reviewer.id not in remaining_reviewers
                ],
                instance,
            )

        return instance

BatchUpdateReviewersForm 

BatchUpdateReviewersForm(*args, user=None, round=None, **kwargs)

Bases: Form

Source code in hypha/apply/funds/forms.py 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def __init__(self, *args, user=None, round=None, **kwargs):
    super().__init__(*args, **kwargs)
    self.request = kwargs.pop("request", None)
    self.user = user
    self.fields = OrderedDict(self.fields)

    self.role_fields = {}
    field_data = make_role_reviewer_fields()

    for data in field_data:
        field_name = data["field_name"]
        self.fields[field_name] = data["field"]
        self.role_fields[field_name] = data["role"]
        self.fields[field_name].widget.attrs.update({"data-js-choices": ""})

    self.fields.move_to_end("external_reviewers")

submissions class-attribute instance-attribute 

submissions = CharField(widget=HiddenInput(attrs={'class': 'js-submissions-id'}))

external_reviewers class-attribute instance-attribute 

external_reviewers = ModelMultipleChoiceField(queryset=only('pk', 'full_name'), widget=MultiCheckboxesWidget(attrs={'data-placeholder': gettext_lazy('Select...')}), label=gettext_lazy('External Reviewers'), required=False)

request instance-attribute 

request = pop('request', None)

user instance-attribute 

user = user

fields instance-attribute 

fields = OrderedDict(fields)

role_fields instance-attribute 

role_fields = {}

clean_submissions 

clean_submissions()
Source code in hypha/apply/funds/forms.py 
265
266
267
268
def clean_submissions(self):
    value = self.cleaned_data["submissions"]
    submission_ids = [int(submission) for submission in value.split(",")]
    return ApplicationSubmission.objects.filter(id__in=submission_ids)

clean 

clean()
Source code in hypha/apply/funds/forms.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
def clean(self):
    cleaned_data = super().clean()
    external_reviewers = self.cleaned_data["external_reviewers"]
    submissions = self.cleaned_data["submissions"]
    if external_reviewers:
        # User needs to be superuser or lead of all selected submissions.

        if not all(
            can_change_external_reviewers(submission=s, user=self.user)
            for s in submissions
        ):
            self.add_error(
                "external_reviewers",
                _(
                    "Make sure all submissions support external reviewers and you are lead for all the selected submissions."
                ),
            )

    role_reviewers = [
        user
        for field, user in self.cleaned_data.items()
        if field in self.role_fields and user
    ]

    # If any of the users match and are set to multiple roles, throw an error
    if len(role_reviewers) != len(set(role_reviewers)) and any(role_reviewers):
        self.add_error(None, _("Users cannot be assigned to multiple roles."))

    return cleaned_data

submissions_cant_have_external_reviewers 

submissions_cant_have_external_reviewers(submissions)
Source code in hypha/apply/funds/forms.py 
300
301
302
303
304
def submissions_cant_have_external_reviewers(self, submissions):
    for submission in submissions:
        if not submission.stage.has_external_review:
            return True
    return False

UpdatePartnersForm 

UpdatePartnersForm(*args, **kwargs)

Bases: ApplicationSubmissionModelForm

Source code in hypha/apply/funds/forms.py 
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def __init__(self, *args, **kwargs):
    kwargs.pop("user")
    super().__init__(*args, **kwargs)
    partners = self.instance.partners.all()
    self.submitted_partners = User.objects.partners().filter(
        id__in=self.instance.reviews.values("author")
    )

    partner_field = self.fields["partner_reviewers"]

    # If applicant is also a partner, they should not be allowed to be a partner on their own application
    partner_field.queryset = partner_field.queryset.exclude(
        Q(id__in=self.submitted_partners) | Q(id=self.instance.user.id)
    )
    partner_field.initial = partners

partner_reviewers class-attribute instance-attribute 

partner_reviewers = ModelMultipleChoiceField(queryset=partners(), label=gettext_lazy('Partners'), required=False)

submitted_partners instance-attribute 

submitted_partners = filter(id__in=values('author'))

Meta

model class-attribute instance-attribute 
model = ApplicationSubmission
fields class-attribute instance-attribute 
fields = []

save 

save(*args, **kwargs)
Source code in hypha/apply/funds/forms.py 
364
365
366
367
368
369
370
def save(self, *args, **kwargs):
    instance = super().save(*args, **kwargs)

    instance.partners.set(
        self.cleaned_data["partner_reviewers"] | self.submitted_partners
    )
    return instance

GroupedModelChoiceIterator 

GroupedModelChoiceIterator(field, groupby)

Bases: ModelChoiceIterator

Source code in hypha/apply/funds/forms.py 
374
375
376
def __init__(self, field, groupby):
    self.groupby = groupby
    super().__init__(field)

groupby instance-attribute 

groupby = groupby

GroupedModelMultipleChoiceField 

GroupedModelMultipleChoiceField(*args, choices_groupby, **kwargs)

Bases: ModelMultipleChoiceField

Source code in hypha/apply/funds/forms.py 
390
391
392
393
394
395
396
397
398
def __init__(self, *args, choices_groupby, **kwargs):
    if isinstance(choices_groupby, str):
        choices_groupby = methodcaller(choices_groupby)
    elif not callable(choices_groupby):
        raise TypeError(
            "choices_groupby must either be a str or a callable accepting a single argument"
        )
    self.iterator = partial(GroupedModelChoiceIterator, groupby=choices_groupby)
    super().__init__(*args, **kwargs)

iterator instance-attribute 

iterator = partial(GroupedModelChoiceIterator, groupby=choices_groupby)

label_from_instance 

label_from_instance(obj)
Source code in hypha/apply/funds/forms.py 
400
401
402
403
404
def label_from_instance(self, obj):
    return {
        "label": super().label_from_instance(obj),
        "disabled": not obj.is_leaf(),
    }

UpdateMetaTermsForm 

UpdateMetaTermsForm(*args, **kwargs)

Bases: ApplicationSubmissionModelForm

Source code in hypha/apply/funds/forms.py 
423
424
425
426
427
428
429
430
431
432
433
def __init__(self, *args, **kwargs):
    kwargs.pop("user")
    super().__init__(*args, **kwargs)
    self.fields["meta_terms"].queryset = MetaTerm.get_root_descendants().exclude(
        depth=2
    )
    # Set initial values for meta_terms based on the instance if available
    if self.instance.pk:
        self.fields["meta_terms"].initial = self.instance.meta_terms.values_list(
            "id", flat=True
        )

meta_terms class-attribute instance-attribute 

meta_terms = GroupedModelMultipleChoiceField(queryset=None, widget=MetaTermWidget(attrs={'data-placeholder': 'Select...', 'data-js-choices': ''}), label=gettext_lazy('Tags'), choices_groupby='get_parent', required=False, help_text=gettext_lazy('Tags are hierarchical in nature.'))

Meta

model class-attribute instance-attribute 
model = ApplicationSubmission
fields class-attribute instance-attribute 
fields = []

save 

save(commit=True)

Save this form's self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance. https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444

Source code in hypha/apply/funds/forms.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def save(self, commit=True):
    """
    Save this form's self.instance object if commit=True. Otherwise, add
    a save_m2m() method to the form which can be called after the instance
    is saved manually at a later time. Return the model instance.
    https://github.com/django/django/blob/5d9cf79baf07fc4aed7ad1b06990532a65378155/django/forms/models.py#L444
    """
    if self.errors:
        raise ValueError(
            "The %s could not be %s because the data didn't validate."
            % (
                self.instance._meta.object_name,
                "created" if self.instance._state.adding else "changed",
            )
        )
    if commit:
        # If committing, save the instance and the m2m data immediately.
        self.instance.save(skip_custom=True)
        self._save_m2m()
    else:
        # If not committing, add a method to the form to allow deferred
        # saving of m2m data.
        self.save_m2m = self._save_m2m
    return self.instance

CreateReminderForm 

CreateReminderForm(*args, instance=None, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/funds/forms.py 
443
444
445
446
447
448
def __init__(self, *args, instance=None, user=None, **kwargs):
    super().__init__(*args, **kwargs)
    self.user = user

    if instance:
        self.fields["submission"].initial = instance.id

submission class-attribute instance-attribute 

submission = ModelChoiceField(queryset=filter(), widget=HiddenInput())

time class-attribute instance-attribute 

time = DateField()

user instance-attribute 

user = user

Meta

model class-attribute instance-attribute 
model = Reminder
fields class-attribute instance-attribute 
fields = ['title', 'description', 'time', 'action']

save 

save(*args, **kwargs)
Source code in hypha/apply/funds/forms.py 
450
451
452
453
454
455
456
457
def save(self, *args, **kwargs):
    return Reminder.objects.create(
        title=self.cleaned_data["title"],
        description=self.cleaned_data["description"],
        time=self.cleaned_data["time"],
        submission=self.cleaned_data["submission"],
        user=self.user,
    )

InviteCoApplicantForm 

InviteCoApplicantForm(*args, submission, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/funds/forms.py 
484
485
486
487
488
489
490
491
def __init__(self, *args, submission, user=None, **kwargs):
    super().__init__(*args, **kwargs)
    self.invited_by = user

    if submission:
        self.fields["submission"].initial = submission.id
        if not hasattr(submission, "project"):
            self.fields.pop("project_permission", None)

invited_user_email class-attribute instance-attribute 

invited_user_email = EmailField(required=True, label='Email')

role class-attribute instance-attribute 

role = ChoiceField(choices=choices, label='Role', required=False)

project_permission class-attribute instance-attribute 

project_permission = MultipleChoiceField(choices=choices, required=False, widget=CheckboxSelectMultiple, label=gettext_lazy('Project permissions'), help_text=gettext_lazy('Enable same access level to these sections. Example: View role + Contracting = read-only contracting access.'))

submission class-attribute instance-attribute 

submission = ModelChoiceField(queryset=filter(), widget=HiddenInput())

invited_by instance-attribute 

invited_by = user

Meta

model class-attribute instance-attribute 
model = CoApplicantInvite
fields class-attribute instance-attribute 
fields = ['invited_user_email', 'submission']

EditCoApplicantForm 

EditCoApplicantForm(*args, **kwargs)

Bases: ModelForm

Source code in hypha/apply/funds/forms.py 
512
513
514
515
516
def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    instance = kwargs.get("instance", None)
    if not hasattr(instance.submission, "project"):
        self.fields.pop("project_permission", None)

role class-attribute instance-attribute 

role = ChoiceField(choices=choices, label='Role', required=False)

project_permission class-attribute instance-attribute 

project_permission = MultipleChoiceField(choices=choices, required=False, widget=CheckboxSelectMultiple, label=gettext_lazy('Project permissions'), help_text=gettext_lazy('Enable same access level to these sections. Example: View role + Contracting = read-only contracting access.'))

Meta

model class-attribute instance-attribute 
model = CoApplicant
fields class-attribute instance-attribute 
fields = ('role', 'project_permission')

make_role_reviewer_fields 

make_role_reviewer_fields()
Source code in hypha/apply/funds/forms.py 
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
def make_role_reviewer_fields():
    role_fields = []
    staff_reviewers = User.objects.staff().only("full_name", "pk")

    for role in ReviewerRole.objects.all().order_by("order"):
        role_name = nh3.clean(role.name, tags=set())
        field_name = f"role_reviewer_{role.id}"
        field = forms.ModelChoiceField(
            queryset=staff_reviewers,
            empty_label=_("---"),
            required=False,
            label=mark_safe(
                render_icon(role.icon)
                + _("{role_name} Reviewer").format(role_name=role_name)
            ),
        )
        role_fields.append(
            {
                "role": role,
                "field": field,
                "field_name": field_name,
            }
        )

    return role_fields