Skip to content

Utils

hypha.apply.activity.adapters.utils 

link_to(target, request)
Source code in hypha/apply/activity/adapters/utils.py 
27
28
29
def link_to(target, request):
    if target and hasattr(target, "get_absolute_url"):
        return request.scheme + "://" + request.get_host() + target.get_absolute_url()

group_reviewers 

group_reviewers(reviewers)
Source code in hypha/apply/activity/adapters/utils.py 
32
33
34
35
36
def group_reviewers(reviewers):
    groups = defaultdict(list)
    for reviewer in reviewers:
        groups[reviewer.role].append(reviewer.reviewer)
    return groups

reviewers_message 

reviewers_message(reviewers)
Source code in hypha/apply/activity/adapters/utils.py 
39
40
41
42
43
44
45
46
47
def reviewers_message(reviewers):
    messages = []
    for role, reviewers_ in group_reviewers(reviewers).items():
        message = ", ".join(str(reviewer) for reviewer in reviewers_)
        if role:
            message += _(" as {role}").format(role=str(role))
        message += "."
        messages.append(message)
    return messages

is_transition 

is_transition(message_type)
Source code in hypha/apply/activity/adapters/utils.py 
50
51
def is_transition(message_type):
    return message_type in [MESSAGES.TRANSITION, MESSAGES.BATCH_TRANSITION]

is_ready_for_review 

is_ready_for_review(message_type)
Source code in hypha/apply/activity/adapters/utils.py 
54
55
def is_ready_for_review(message_type):
    return message_type in [MESSAGES.READY_FOR_REVIEW, MESSAGES.BATCH_READY_FOR_REVIEW]

is_invoice_public_transition 

is_invoice_public_transition(invoice)
Source code in hypha/apply/activity/adapters/utils.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def is_invoice_public_transition(invoice):
    if invoice.status in [
        SUBMITTED,
        RESUBMITTED,
        CHANGES_REQUESTED_BY_STAFF,
        APPROVED_BY_FINANCE_2,
        DECLINED,
        PAID,
        PAYMENT_FAILED,
    ]:
        return True
    if not settings.INVOICE_EXTENDED_WORKFLOW and invoice.status == APPROVED_BY_FINANCE:
        return True
    return False

is_reviewer_update 

is_reviewer_update(message_type)
Source code in hypha/apply/activity/adapters/utils.py 
74
75
76
77
78
def is_reviewer_update(message_type):
    return message_type in [
        MESSAGES.REVIEWERS_UPDATED,
        MESSAGES.BATCH_REVIEWERS_UPDATED,
    ]

get_compliance_email 

get_compliance_email(target_user_gps=None)
Source code in hypha/apply/activity/adapters/utils.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def get_compliance_email(target_user_gps=None):
    project_settings = ProjectSettings.objects.first()

    if project_settings is None:
        # TODO: what to do when this isn't configured??
        return []
    target_user_emails = []
    if not target_user_gps or not isinstance(target_user_gps, list):
        return [project_settings.staff_gp_email]
    if CONTRACTING_GROUP_NAME in target_user_gps:
        if project_settings.contracting_gp_email:
            target_user_emails.extend([project_settings.contracting_gp_email])
        else:
            contracting_users_email = []
            for user in User.objects.contracting():
                contracting_users_email.append(user.email)
            target_user_emails.extend(contracting_users_email)
    if FINANCE_GROUP_NAME in target_user_gps:
        if project_settings.finance_gp_email:
            target_user_emails.extend([project_settings.finance_gp_email])
        else:
            finance_users_email = []
            for user in User.objects.finances():
                finance_users_email.append(user.email)
            target_user_emails.extend(finance_users_email)
    if STAFF_GROUP_NAME in target_user_gps:
        if project_settings.staff_gp_email:
            target_user_emails.extend([project_settings.staff_gp_email])
        else:
            staff_users_email = []
            for user in User.objects.staff():
                staff_users_email.append(user.email)
            target_user_emails.extend(staff_users_email)
    return target_user_emails

get_users_for_groups 

get_users_for_groups(groups, user_queryset=None, exact_match=False)

It will return the user queryset with the mentioned groups,

**NOTE: exact_match and user_queryset are not working together(for now). Set either one of them.

Source code in hypha/apply/activity/adapters/utils.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def get_users_for_groups(groups, user_queryset=None, exact_match=False):
    """
    It will return the user queryset with the mentioned groups,

    **NOTE: exact_match and user_queryset are not working together(for now). Set either one of them.
    """
    if groups:
        if not user_queryset:
            if exact_match:
                user_queryset = (
                    User.objects.active()
                    .annotate(group_count=Count("groups"))
                    .filter(group_count=len(groups), groups__name=groups.pop().name)
                )
            else:
                user_queryset = User.objects.active().filter(
                    groups__name=groups.pop().name
                )
        else:
            user_queryset = user_queryset.filter(groups__name=groups.pop().name)
        return get_users_for_groups(groups, user_queryset=user_queryset)
    else:
        return user_queryset