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

def get_project_title(project):
    return format_html(
        PROJECT_TITLE_TEMPLATE,
        text=project.title,
        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

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

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

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

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

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

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

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

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

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

export_invoices_to_csv

export_invoices_to_csv(invoices_iter)

Generate a CSV string from an invoice queryset iterator.

Columns match those shown in the invoice list table. Add more fields here as needed.

Source code in hypha/apply/projects/utils.py

def export_invoices_to_csv(invoices_iter) -> str:
    """Generate a CSV string from an invoice queryset iterator.

    Columns match those shown in the invoice list table. Add more fields here
    as needed.
    """
    output = io.StringIO()
    fieldnames = [
        "Invoice #",
        "Invoice Date",
        "Status",
        "Submitted",
        "Project Title",
        "Project #",
        "Vendor Name",
        "Invoice Amount",
        "Tags",
    ]
    writer = csv.DictWriter(output, fieldnames=fieldnames)
    writer.writeheader()

    for invoice in invoices_iter:
        writer.writerow(
            {
                "Invoice #": invoice.invoice_number or "",
                "Invoice Date": invoice.invoice_date.isoformat()
                if invoice.invoice_date
                else "",
                "Status": invoice.get_status_display(),
                "Submitted": invoice.requested_at.strftime("%Y-%m-%d %H:%M")
                if invoice.requested_at
                else "",
                "Project Title": invoice.project.title,
                "Project #": invoice.project.application_id,
                "Vendor Name": str(invoice.project.user),
                "Invoice Amount": str(invoice.invoice_amount)
                if invoice.invoice_amount is not None
                else "",
                "Tags": ", ".join(tag.name for tag in invoice.tags.all()),
            }
        )

    return output.getvalue()

get_placeholder_file

get_placeholder_file(initial_file)

Source code in hypha/apply/projects/utils.py

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
    ]