Skip to content

Utils

hypha.apply.projects.utils

PROJECT_TITLE_TEMPLATE module-attribute 

PROJECT_TITLE_TEMPLATE = "{text} <span class='text-fg-muted'>#{application_id}</span>"

get_project_title 

get_project_title(project)
Source code in hypha/apply/projects/utils.py 
41
42
43
44
45
46
47
def get_project_title(project):
    text = textwrap.shorten(project.title, width=40, placeholder="…")
    return format_html(
        PROJECT_TITLE_TEMPLATE,
        text=text,
        application_id=project.application_id,
    )

no_pafreviewer_role 

no_pafreviewer_role()

Return True if no PAFReviewerRoles exists

Source code in hypha/apply/projects/utils.py 
50
51
52
53
54
def no_pafreviewer_role():
    """
    Return True if no PAFReviewerRoles exists
    """
    return not (PAFReviewersRole.objects.exists())

get_project_status_choices 

get_project_status_choices()

Return available Project status choices by removing the disabled ones

Source code in hypha/apply/projects/utils.py 
57
58
59
60
61
62
63
64
65
66
67
def get_project_status_choices():
    """
    Return available Project status choices by removing the disabled ones
    """
    if no_pafreviewer_role():
        return [
            (status, label)
            for status, label in PROJECT_STATUS_CHOICES
            if status != INTERNAL_APPROVAL
        ]
    return PROJECT_STATUS_CHOICES

save_project_details 

save_project_details(project_id, data)
Source code in hypha/apply/projects/utils.py 
70
71
72
73
def save_project_details(project_id, data):
    project = Project.objects.get(id=project_id)
    project.external_project_information = data
    project.save()

get_paf_status_display 

get_paf_status_display(paf_status)
Source code in hypha/apply/projects/utils.py 
76
77
def get_paf_status_display(paf_status):
    return dict(PAF_STATUS_CHOICES)[paf_status]

get_invoice_public_status 

get_invoice_public_status(invoice_status)
Source code in hypha/apply/projects/utils.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def get_invoice_public_status(invoice_status):
    if invoice_status in [
        SUBMITTED,
        RESUBMITTED,
        APPROVED_BY_STAFF,
        CHANGES_REQUESTED_BY_FINANCE,
    ]:
        return _("Pending approval")
    if invoice_status == APPROVED_BY_FINANCE:
        return _("Approved")
    if invoice_status == CHANGES_REQUESTED_BY_STAFF:
        return _("Request for change or more information")
    if invoice_status == DECLINED:
        return _("Declined")
    if invoice_status == PAID:
        return _("Paid")
    if invoice_status == PAYMENT_FAILED:
        return _("Payment failed")

get_project_status_display_value 

get_project_status_display_value(project_status)
Source code in hypha/apply/projects/utils.py 
101
102
def get_project_status_display_value(project_status):
    return dict(PROJECT_STATUS_CHOICES)[project_status]

get_project_public_status 

get_project_public_status(project_status)
Source code in hypha/apply/projects/utils.py 
105
106
def get_project_public_status(project_status):
    return dict(PROJECT_PUBLIC_STATUSES)[project_status]

get_invoice_status_display_value 

get_invoice_status_display_value(invoice_status)
Source code in hypha/apply/projects/utils.py 
109
110
def get_invoice_status_display_value(invoice_status):
    return dict(INVOICE_STATUS_CHOICES)[invoice_status]

get_invoice_table_status 

get_invoice_table_status(invoice_status, is_applicant=False)
Source code in hypha/apply/projects/utils.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def get_invoice_table_status(invoice_status, is_applicant=False):
    if invoice_status in [SUBMITTED, RESUBMITTED]:
        if is_applicant:
            return INT_ORG_PENDING
        return INT_STAFF_PENDING
    if invoice_status == CHANGES_REQUESTED_BY_STAFF:
        if is_applicant:
            return INT_REQUEST_FOR_CHANGE
        return INT_VENDOR_PENDING
    if invoice_status in [APPROVED_BY_STAFF, CHANGES_REQUESTED_BY_FINANCE]:
        if is_applicant:
            return INT_ORG_PENDING
        return INT_FINANCE_PENDING
    if invoice_status == PAID:
        return INT_PAID
    if invoice_status == DECLINED:
        return INT_DECLINED
    if invoice_status == PAYMENT_FAILED:
        return INT_PAYMENT_FAILED

get_placeholder_file 

get_placeholder_file(initial_file)
Source code in hypha/apply/projects/utils.py 
134
135
136
137
138
139
140
141
142
def get_placeholder_file(initial_file):
    if not isinstance(initial_file, list):
        return PlaceholderUploadedFile(
            initial_file.filename, size=initial_file.size, file_id=initial_file.name
        )
    return [
        PlaceholderUploadedFile(f.filename, size=f.size, file_id=f.name)
        for f in initial_file
    ]