Project

hypha.apply.projects.forms.project

User module-attribute

User = get_user_model()

ApproveContractForm

ApproveContractForm(*args, instance, **kwargs)

Bases: Form

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, instance, **kwargs):
    super().__init__(*args, **kwargs)
    self.instance = instance
    if instance:
        self.fields["id"].initial = instance.id

id class-attribute instance-attribute

id = forms.IntegerField(widget=forms.HiddenInput())

instance instance-attribute

instance = instance

clean_id

clean_id()

Source code in hypha/apply/projects/forms/project.py

def clean_id(self):
    if self.has_changed():
        raise forms.ValidationError(
            _("Something changed before your approval please re-review")
        )

clean

clean()

Source code in hypha/apply/projects/forms/project.py

def clean(self):
    if not self.instance:
        raise forms.ValidationError(
            _("The contract you were trying to approve has already been approved")
        )

    if not self.instance.signed_by_applicant:
        raise forms.ValidationError(_("You can only approve a signed contract"))

    super().clean()

save

save(*args, **kwargs)

Source code in hypha/apply/projects/forms/project.py

def save(self, *args, **kwargs):
    self.instance.save()
    return self.instance

ProjectCreateForm

ProjectCreateForm(*args, instance=None, **kwargs)

Bases: Form

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, instance=None, **kwargs):
    super().__init__(*args, **kwargs)

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

    # Update lead field queryset
    lead_field = self.fields["project_lead"]
    qwargs = Q(groups__name=STAFF_GROUP_NAME) | Q(is_superuser=True)
    lead_field.queryset = lead_field.queryset.filter(qwargs).distinct()
    if instance:
        lead_field.initial = instance.lead

submission class-attribute instance-attribute

submission = forms.ModelChoiceField(queryset=ApplicationSubmission.objects.all(), widget=forms.HiddenInput())

title class-attribute instance-attribute

title = forms.CharField(label=_('Project title'), help_text=_('A submission can have several projects. Give this one a name so it can be told apart from the others.'))

project_lead class-attribute instance-attribute

project_lead = forms.ModelChoiceField(label=_('Select project lead'), queryset=User.objects.all())

project_initial_status class-attribute instance-attribute

project_initial_status = forms.ChoiceField(label=_('Initial project status'), choices=get_project_status_options(), initial=get_project_default_status())

project_end class-attribute instance-attribute

project_end = forms.DateField(label=_('Project end date'))

clean_project_lead

clean_project_lead()

Source code in hypha/apply/projects/forms/project.py

def clean_project_lead(self):
    project_lead = self.cleaned_data["project_lead"]
    if not project_lead:
        raise forms.ValidationError(_("Project lead is a required field"))
    return project_lead

save

save(*args, **kwargs)

Source code in hypha/apply/projects/forms/project.py

def save(self, *args, **kwargs):
    submission = self.cleaned_data["submission"]
    lead = self.cleaned_data["project_lead"]
    status = self.cleaned_data["project_initial_status"]
    end_date = self.cleaned_data["project_end"]

    start_date = None

    if not settings.PROJECTS_START_AFTER_CONTRACTING or status in [
        INVOICING_AND_REPORTING,
        CLOSING,
        COMPLETE,
    ]:
        start_date = date.today()

    return Project.create_from_submission(
        submission,
        lead=lead,
        status=status,
        end_date=end_date,
        start_date=start_date,
        title=self.cleaned_data["title"],
    )

MixedMetaClass

Bases: type(StreamBaseForm), type(ModelForm)

ProjectForm

ProjectForm(*args, extra_fields=None, **kwargs)

Bases: StreamBaseForm, ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, extra_fields=None, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['title']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'title': forms.HiddenInput()}

clean

clean()

Source code in hypha/apply/projects/forms/project.py

def clean(self):
    cleaned_data = super().clean()
    cleaned_data["form_data"] = {
        key: value
        for key, value in cleaned_data.items()
        if key not in self._meta.fields
    }
    return cleaned_data

save

save(*args, **kwargs)

Source code in hypha/apply/projects/forms/project.py

def save(self, *args, **kwargs):
    self.instance.form_fields = kwargs.pop("pf_form_fields", {})
    self.instance.form_data = {
        field: self.cleaned_data[field]
        for field in self.instance.question_field_ids
        if field in self.cleaned_data
    }
    self.instance.process_file_data(self.cleaned_data)
    return super().save(*args, **kwargs)

swap_fields_for_display

swap_fields_for_display(func)

Source code in hypha/apply/stream_forms/forms.py

def swap_fields_for_display(func):
    def wrapped(self, *args, **kwargs):
        # Replaces the form fields with the display fields
        # should only add new streamblocks and wont affect validation
        fields = self.fields.copy()
        self.fields = self.display
        yield from func(self, *args, **kwargs)
        self.fields = fields

    return wrapped

hidden_fields

hidden_fields()

Source code in hypha/apply/stream_forms/forms.py

def hidden_fields(self):
    # No hidden fields are returned by default because of MixedFieldMetaclass
    return [self[f] for f in self.fields.keys() if self[f].is_hidden]

delete_temporary_files

delete_temporary_files()

Overridden method of django_file_form's FileFormMixin, to handle multiple forms on the same page.

Source code in hypha/apply/stream_forms/forms.py

def delete_temporary_files(self):
    """
    Overridden method of django_file_form's FileFormMixin, to handle multiple forms on the same page.
    """
    form_id = self.data.getlist(self.add_prefix("form_id"))

    if not form_id:
        return

    form_id = form_id[0]
    for field_name, field in self.fields.items():
        if hasattr(field, "delete_file_data"):
            prefixed_field_name = self.add_prefix(field_name)
            field.delete_file_data(prefixed_field_name, form_id)

ProjectSOWForm

ProjectSOWForm(*args, extra_fields=None, **kwargs)

Bases: StreamBaseForm, ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, extra_fields=None, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['project']

model class-attribute instance-attribute

model = ProjectSOW

widgets class-attribute instance-attribute

widgets = {'project': forms.HiddenInput()}

clean

clean()

Source code in hypha/apply/projects/forms/project.py

def clean(self):
    cleaned_data = super().clean()
    cleaned_data["form_data"] = {
        key: value
        for key, value in cleaned_data.items()
        if key not in self._meta.fields
    }
    return cleaned_data

save

save(*args, **kwargs)

Source code in hypha/apply/projects/forms/project.py

def save(self, *args, **kwargs):
    self.instance, _ = self._meta.model.objects.get_or_create(
        project=kwargs.pop("project", None)
    )
    self.instance.form_fields = kwargs.pop("sow_form_fields", {})
    self.instance.form_data = {
        field: self.cleaned_data[field]
        for field in self.instance.question_field_ids
        if field in self.cleaned_data
    }
    self.instance.process_file_data(self.cleaned_data)
    return super().save(*args, **kwargs)

swap_fields_for_display

swap_fields_for_display(func)

Source code in hypha/apply/stream_forms/forms.py

def swap_fields_for_display(func):
    def wrapped(self, *args, **kwargs):
        # Replaces the form fields with the display fields
        # should only add new streamblocks and wont affect validation
        fields = self.fields.copy()
        self.fields = self.display
        yield from func(self, *args, **kwargs)
        self.fields = fields

    return wrapped

hidden_fields

hidden_fields()

Source code in hypha/apply/stream_forms/forms.py

def hidden_fields(self):
    # No hidden fields are returned by default because of MixedFieldMetaclass
    return [self[f] for f in self.fields.keys() if self[f].is_hidden]

delete_temporary_files

delete_temporary_files()

Overridden method of django_file_form's FileFormMixin, to handle multiple forms on the same page.

Source code in hypha/apply/stream_forms/forms.py

def delete_temporary_files(self):
    """
    Overridden method of django_file_form's FileFormMixin, to handle multiple forms on the same page.
    """
    form_id = self.data.getlist(self.add_prefix("form_id"))

    if not form_id:
        return

    form_id = form_id[0]
    for field_name, field in self.fields.items():
        if hasattr(field, "delete_file_data"):
            prefixed_field_name = self.add_prefix(field_name)
            field.delete_file_data(prefixed_field_name, form_id)

ChangePAFStatusForm

Bases: ModelForm

name_prefix class-attribute instance-attribute

name_prefix = 'change_paf_status_form'

paf_status class-attribute instance-attribute

paf_status = forms.ChoiceField(label=_('Project form status'), choices=PAF_STATUS_CHOICES, widget=forms.RadioSelect())

comment class-attribute instance-attribute

comment = forms.CharField(required=False, widget=forms.Textarea)

Meta

fields class-attribute instance-attribute

fields = ['paf_status', 'comment']

model class-attribute instance-attribute

model = Project

ChangeProjectStatusForm

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

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, instance=None, user=None, **kwargs):
    super().__init__(*args, **kwargs, instance=instance)
    status_field = self.fields["status"]
    possible_status_transitions = {
        INVOICING_AND_REPORTING: filter_request_choices([CLOSING, COMPLETE]),
        CLOSING: filter_request_choices([INVOICING_AND_REPORTING, COMPLETE]),
        COMPLETE: filter_request_choices([INVOICING_AND_REPORTING, CLOSING]),
    }
    status_field.choices = possible_status_transitions.get(instance.status, [])

name_prefix class-attribute instance-attribute

name_prefix = 'change_project_status_form'

comment class-attribute instance-attribute

comment = forms.CharField(required=False, widget=forms.Textarea)

Meta

fields class-attribute instance-attribute

fields = ['status', 'comment']

model class-attribute instance-attribute

model = Project

ApproversForm

ApproversForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    from hypha.apply.activity.adapters.utils import get_users_for_groups

    super().__init__(*args, **kwargs)

    for paf_reviewer_role in PAFReviewersRole.objects.all():
        users = get_users_for_groups(
            list(paf_reviewer_role.user_roles.all()), exact_match=True
        )
        approval = PAFApprovals.objects.filter(
            project=self.instance, paf_reviewer_role=paf_reviewer_role
        )
        if approval:
            initial_user = approval.first().user
        self.fields[slugify(paf_reviewer_role.label)] = forms.ModelChoiceField(
            queryset=users,
            required=False,
            blank=True,
            label=paf_reviewer_role.label,
            initial=initial_user if approval else None,
            disabled=approval.first().approved if approval.first() else False,
            # using approval.first() as condition for existing projects
        )

Meta

fields class-attribute instance-attribute

fields = ['id']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'id': forms.HiddenInput()}

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    # add users as PAFApprovals
    for paf_reviewer_role in PAFReviewersRole.objects.all():
        assigned_user = self.cleaned_data[slugify(paf_reviewer_role.label)]
        paf_approvals = PAFApprovals.objects.filter(
            project=self.instance, paf_reviewer_role=paf_reviewer_role
        )
        if not paf_approvals.exists():
            PAFApprovals.objects.create(
                project=self.instance,
                paf_reviewer_role=paf_reviewer_role,
                user=assigned_user if assigned_user else None,
                approved=False,
            )
        elif not paf_approvals.first().approved:
            paf_approval = paf_approvals.first()
            paf_approval.user = assigned_user if assigned_user else None
            paf_approval.save()
    return super().save(commit=True)

SetPendingForm

SetPendingForm(*args, user=None, **kwargs)

Bases: ApproversForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    from hypha.apply.activity.adapters.utils import get_users_for_groups

    super().__init__(*args, **kwargs)

    for paf_reviewer_role in PAFReviewersRole.objects.all():
        users = get_users_for_groups(
            list(paf_reviewer_role.user_roles.all()), exact_match=True
        )
        approval = PAFApprovals.objects.filter(
            project=self.instance, paf_reviewer_role=paf_reviewer_role
        )
        if approval:
            initial_user = approval.first().user
        self.fields[slugify(paf_reviewer_role.label)] = forms.ModelChoiceField(
            queryset=users,
            required=False,
            blank=True,
            label=paf_reviewer_role.label,
            initial=initial_user if approval else None,
            disabled=approval.first().approved if approval.first() else False,
            # using approval.first() as condition for existing projects
        )

Meta

fields class-attribute instance-attribute

fields = ['id']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'id': forms.HiddenInput()}

clean

clean()

Source code in hypha/apply/projects/forms/project.py

def clean(self):
    if self.instance.status != DRAFT:
        raise forms.ValidationError(
            _("A Project can only be sent for Approval when Drafted.")
        )

    # :todo: we should have a check form contains enough data to create PAF Approvals
    cleaned_data = super().clean()
    return cleaned_data

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    # add users as PAFApprovals
    for paf_reviewer_role in PAFReviewersRole.objects.all():
        assigned_user = self.cleaned_data[slugify(paf_reviewer_role.label)]
        paf_approvals = PAFApprovals.objects.filter(
            project=self.instance, paf_reviewer_role=paf_reviewer_role
        )
        if not paf_approvals.exists():
            PAFApprovals.objects.create(
                project=self.instance,
                paf_reviewer_role=paf_reviewer_role,
                user=assigned_user if assigned_user else None,
                approved=False,
            )
        elif not paf_approvals.first().approved:
            paf_approval = paf_approvals.first()
            paf_approval.user = assigned_user if assigned_user else None
            paf_approval.save()
    return super().save(commit=True)

AssignApproversForm

AssignApproversForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    from hypha.apply.activity.adapters.utils import get_users_for_groups

    super().__init__(*args, **kwargs)
    self.user = user

    paf_approval = get_latest_project_paf_approval_via_roles(
        project=self.instance, roles=user.groups.all()
    )

    if paf_approval:
        current_paf_reviewer_role = paf_approval.paf_reviewer_role

        users = get_users_for_groups(
            list(current_paf_reviewer_role.user_roles.all()), exact_match=True
        )

        self.fields[slugify(current_paf_reviewer_role.label)] = (
            forms.ModelChoiceField(
                queryset=users,
                required=False,
                blank=True,
                label=current_paf_reviewer_role.label,
                initial=paf_approval.user,
                disabled=paf_approval.approved,
            )
        )

user instance-attribute

user = user

Meta

fields class-attribute instance-attribute

fields = ['id']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'id': forms.HiddenInput()}

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    paf_approval = get_latest_project_paf_approval_via_roles(
        project=self.instance, roles=self.user.groups.all()
    )

    current_paf_reviewer_role = paf_approval.paf_reviewer_role
    assigned_user = self.cleaned_data[slugify(current_paf_reviewer_role.label)]

    if not paf_approval.approved:
        paf_approval.user = assigned_user if assigned_user else None
        paf_approval.save()

    return super().save(commit=True)

SubmitContractDocumentsForm

SubmitContractDocumentsForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['id']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'id': forms.HiddenInput()}

SkipPAFApprovalProcessForm

SkipPAFApprovalProcessForm(user=None, *args, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, user=None, *args, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['id']

model class-attribute instance-attribute

model = Project

widgets class-attribute instance-attribute

widgets = {'id': forms.HiddenInput()}

UploadContractForm

Bases: FileFormMixin, ModelForm

file class-attribute instance-attribute

file = SingleFileField(label=_('Contract'), required=True)

signed_and_approved class-attribute instance-attribute

signed_and_approved = forms.BooleanField(label=_('Signed and approved'), required=False)

Meta

fields class-attribute instance-attribute

fields = ['file', 'signed_and_approved']

model class-attribute instance-attribute

model = Contract

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    self.instance.file = self.cleaned_data.get("file")
    return super().save(commit=True)

StaffUploadContractForm

Bases: FileFormMixin, ModelForm

file class-attribute instance-attribute

file = SingleFileField(label=_('Contract'), required=True)

Meta

fields class-attribute instance-attribute

fields = ['file', 'signed_by_applicant']

model class-attribute instance-attribute

model = Contract

UploadDocumentForm

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

Bases: FileFormMixin, ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, instance=None, **kwargs):
    super().__init__(*args, **kwargs)

document class-attribute instance-attribute

document = SingleFileField(label=_('Document'), required=True)

Meta

fields class-attribute instance-attribute

fields = ['category', 'document']

model class-attribute instance-attribute

model = PacketFile

widgets class-attribute instance-attribute

widgets = {'category': forms.HiddenInput()}

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    self.instance.title = self.instance.document
    return super().save(commit=True)

UploadContractDocumentForm

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

Bases: FileFormMixin, ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, instance=None, **kwargs):
    super().__init__(*args, **kwargs)

document class-attribute instance-attribute

document = SingleFileField(label=_('Contract Document'), required=True)

Meta

fields class-attribute instance-attribute

fields = ['category', 'document']

model class-attribute instance-attribute

model = ContractPacketFile

widgets class-attribute instance-attribute

widgets = {'category': forms.HiddenInput()}

save

save(commit=True)

Source code in hypha/apply/projects/forms/project.py

def save(self, commit=True):
    self.instance.title = self.instance.document
    return super().save(commit=True)

UpdateProjectLeadForm

UpdateProjectLeadForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **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.widget.attrs.update({"data-js-choices": ""})

    qwargs = Q(groups__name=STAFF_GROUP_NAME) | Q(is_superuser=True)
    lead_field.queryset = (
        lead_field.queryset.exclude(pk=self.instance.lead_id)
        .filter(qwargs)
        .distinct()
    )

Meta

fields class-attribute instance-attribute

fields = ['lead']

model class-attribute instance-attribute

model = Project

UpdateProjectTitleForm

UpdateProjectTitleForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['title']

model class-attribute instance-attribute

model = Project

UpdateProjectDatesForm

UpdateProjectDatesForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    super().__init__(*args, **kwargs)
    # Only show the start date field if relevant
    if not show_start_date(self.instance):
        proposed_start = self.fields["proposed_start"]
        proposed_start.disabled = True
        proposed_start.required = False
        proposed_start.widget = proposed_start.hidden_widget()

Meta

fields class-attribute instance-attribute

fields = ['proposed_start', 'proposed_end']

model class-attribute instance-attribute

model = Project

clean

clean()

Source code in hypha/apply/projects/forms/project.py

def clean(self):
    cleaned_data = super().clean()
    if (
        show_start_date(self.instance)
        and cleaned_data["proposed_start"] >= cleaned_data["proposed_end"]
    ):
        self.add_error(
            "proposed_end", _("The end date must be after the start date.")
        )

UpdateProjectContractNumberForm

UpdateProjectContractNumberForm(*args, user=None, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/project.py

def __init__(self, *args, user=None, **kwargs):
    super().__init__(*args, **kwargs)

Meta

fields class-attribute instance-attribute

fields = ['contract_number']

model class-attribute instance-attribute

model = Project

filter_request_choices

filter_request_choices(choices)

Source code in hypha/apply/projects/forms/project.py

def filter_request_choices(choices):
    return [(k, v) for k, v in PROJECT_STATUS_CHOICES if k in choices]

get_latest_project_paf_approval_via_roles

get_latest_project_paf_approval_via_roles(project, roles)

Source code in hypha/apply/projects/forms/project.py

def get_latest_project_paf_approval_via_roles(project, roles):
    # exact match the roles with paf approval's reviewer roles
    paf_approvals = project.paf_approvals.annotate(
        roles_count=Count("paf_reviewer_role__user_roles")
    ).filter(roles_count=len(list(roles)), approved=False)

    for role in roles:
        paf_approvals = paf_approvals.filter(paf_reviewer_role__user_roles__id=role.id)
    return paf_approvals.first()