Skip to content

Tasks

hypha.apply.funds.tasks

generate_submission_csv 

generate_submission_csv(qs_ids, request_user_id, base_uri)

Celery task to generate a CSV file containing the given submission IDs

Integer IDs have to be used as QuerySets are not simple data types & can't be passed to workers.

Updates the user's SubmissionExportManager object with status/final data, then adds a download task to the user's My Tasks when completed.

Parameters:

  • qs_ids (List[int]) –

    A list of application IDs to generate the CSV export for

  • request_user_id (int) –

    The ID of the user issuing the export request

Source code in hypha/apply/funds/tasks.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@shared_task
def generate_submission_csv(
    qs_ids: List[int], request_user_id: int, base_uri: str
) -> None:
    """Celery task to generate a CSV file containing the given submission IDs

    Integer IDs have to be used as QuerySets are not simple data types & can't be
    passed to workers.

    Updates the user's SubmissionExportManager object with status/final data, then
    adds a download task to the user's `My Tasks` when completed.

    Args:
        qs_ids: A list of application IDs to generate the CSV export for
        request_user_id: The ID of the user issuing the export request
    """
    try:
        qs = ApplicationSubmission.objects.filter(id__in=qs_ids)
        request_user = User.objects.get(pk=request_user_id)

        # If the user already has an existing export, delete it to begin the new one
        if current := SubmissionExportManager.objects.filter(user=request_user):
            current.delete()

        export_manager = SubmissionExportManager.objects.create(
            user=request_user, total_export=len(qs_ids)
        )
        csv_string = export_submissions_to_csv(qs, base_uri)
        export_manager.export_data = "".join(csv_string.readlines())
        export_manager.set_completed_and_save()

        user_task = DOWNLOAD_SUBMISSIONS_EXPORT

    except Exception as exc:
        # Update the status to failed
        export_manager.set_failed_and_save()
        user_task = FAILED_SUBMISSIONS_EXPORT

        if settings.SENTRY_DSN:
            # If sentry is enabled, pass the exception to sentry
            from sentry_sdk import capture_exception

            capture_exception(exc)
        else:
            # Otherwise re-raise it
            raise exc
    finally:
        # When the generation is complete or failed, add a task to the user's dashboard (only if async)
        if not settings.CELERY_TASK_ALWAYS_EAGER:
            add_task_to_user(
                code=user_task,
                user=request_user,
                related_obj=export_manager,
            )