Skip to content

Index

hypha.apply.funds.models

ApplicationRevision

Bases: BaseStreamForm, AccessFormData, Model

stream_file_class class-attribute instance-attribute 

stream_file_class = PrivateStreamFieldFile

storage_class class-attribute instance-attribute 

storage_class = PrivateStorage

raw_data property 

raw_data

question_field_ids property 

question_field_ids

file_field_ids property 

file_field_ids

question_text_field_ids property 

question_text_field_ids

first_group_question_text_field_ids property 

first_group_question_text_field_ids

raw_fields property 

raw_fields

fields property 

fields

named_blocks property 

named_blocks

normal_blocks property 

normal_blocks

group_toggle_blocks property 

group_toggle_blocks

first_group_normal_text_blocks property 

first_group_normal_text_blocks

submission_form_class class-attribute instance-attribute 

submission_form_class = PageStreamBaseForm

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

submission class-attribute instance-attribute 

submission = ForeignKey('funds.ApplicationSubmission', related_name='revisions', on_delete=CASCADE)

form_data class-attribute instance-attribute 

form_data = JSONField(encoder=StreamFieldDataEncoder)

timestamp class-attribute instance-attribute 

timestamp = DateTimeField(auto_now=True)

author class-attribute instance-attribute 

author = ForeignKey(AUTH_USER_MODEL, on_delete=SET_NULL, null=True)

is_draft class-attribute instance-attribute 

is_draft = BooleanField(default=False)

form_fields property 

form_fields

Meta

ordering class-attribute instance-attribute 
ordering = ['-timestamp']

stream_file classmethod 

stream_file(instance, field, file)
Source code in hypha/apply/funds/models/mixins.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@classmethod
def stream_file(cls, instance, field, file):
    if not file:
        return []
    if isinstance(file, cls.stream_file_class):
        return file
    if isinstance(file, File):
        return cls.stream_file_class(
            instance, field, file, name=file.name, storage=cls.storage_class()
        )

    if isinstance(file, PlaceholderUploadedFile):
        return cls.stream_file_class(
            instance,
            field,
            None,
            name=file.file_id,
            filename=file.name,
            storage=cls.storage_class(),
        )

    # This fixes a backwards compatibility issue with #507
    # Once every application has been re-saved it should be possible to remove it
    if "path" in file:
        file["filename"] = file["name"]
        file["name"] = file["path"]
    return cls.stream_file_class(
        instance,
        field,
        None,
        name=file["name"],
        filename=file.get("filename"),
        storage=cls.storage_class(),
    )

process_file classmethod 

process_file(instance, field, file)
Source code in hypha/apply/funds/models/mixins.py 
88
89
90
91
92
93
@classmethod
def process_file(cls, instance, field, file):
    if isinstance(file, list):
        return [cls.stream_file(instance, field, f) for f in file]
    else:
        return cls.stream_file(instance, field, file)

process_file_data 

process_file_data(data)
Source code in hypha/apply/funds/models/mixins.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def process_file_data(self, data):
    for field in self.form_fields:
        if isinstance(field.block, UploadableMediaBlock):
            file = self.process_file(self, field, data.get(field.id, []))
            try:
                file.save()
            except (AttributeError, FileNotFoundError):
                try:
                    for f in file:
                        f.save()
                except FileNotFoundError:
                    pass
            self.form_data[field.id] = file

extract_files 

extract_files()
Source code in hypha/apply/funds/models/mixins.py 
109
110
111
112
113
114
115
def extract_files(self):
    files = {}
    for field in self.form_fields:
        if isinstance(field.block, UploadableMediaBlock):
            files[field.id] = self.data(field.id) or []
            self.form_data.pop(field.id, None)
    return files

from_db classmethod 

from_db(db, field_names, values)
Source code in hypha/apply/stream_forms/models.py 
28
29
30
31
32
33
34
35
@classmethod
def from_db(cls, db, field_names, values):
    instance = super().from_db(db, field_names, values)
    if "form_data" in field_names:
        instance.form_data = cls.deserialize_form_data(
            instance, instance.form_data, instance.form_fields
        )
    return instance

deserialised_data classmethod 

deserialised_data(instance, data, form_fields)
Source code in hypha/apply/funds/models/mixins.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@classmethod
def deserialised_data(cls, instance, data, form_fields):
    # Converts the file dicts into actual file objects
    data = data.copy()
    # PERFORMANCE NOTE:
    # Do not attempt to iterate over form_fields - that will fully instantiate the form_fields
    # including any sub queries that they do
    for i, field_data in enumerate(form_fields.raw_data):
        block = form_fields.stream_block.child_blocks[field_data["type"]]
        if isinstance(block, UploadableMediaBlock):
            field_id = field_data.get("id")
            if field_id:
                field = form_fields[i]
                file = data.get(field_id, [])
                data[field_id] = cls.process_file(instance, field, file)
    return data

get_definitive_id 

get_definitive_id(id)
Source code in hypha/apply/funds/models/mixins.py 
144
145
146
147
def get_definitive_id(self, id):
    if id in self.named_blocks:
        return self.named_blocks[id]
    return id

field 

field(id)
Source code in hypha/apply/funds/models/mixins.py 
149
150
151
152
153
154
def field(self, id):
    definitive_id = self.get_definitive_id(id)
    try:
        return self.raw_fields[definitive_id]
    except KeyError:
        raise UnusedFieldException(id) from None

data 

data(id)
Source code in hypha/apply/funds/models/mixins.py 
156
157
158
159
160
161
162
def data(self, id):
    definitive_id = self.get_definitive_id(id)
    try:
        return self.raw_data[definitive_id]
    except KeyError:
        # We have most likely progressed application forms so the data isn't in form_data
        return None

get_serialize_multi_inputs_answer 

get_serialize_multi_inputs_answer(field)
Source code in hypha/apply/funds/models/mixins.py 
242
243
244
245
246
def get_serialize_multi_inputs_answer(self, field):
    number_of_inputs = field.value.get("number_of_inputs")
    answers = [self.data(field.id + "_" + str(i)) for i in range(number_of_inputs)]
    data = ", ".join(filter(None, answers))
    return data

serialize 

serialize(field_id)
Source code in hypha/apply/funds/models/mixins.py 
248
249
250
251
252
253
254
255
256
257
258
259
def serialize(self, field_id):
    field = self.field(field_id)
    if isinstance(field.block, MultiInputCharFieldBlock):
        data = self.get_serialize_multi_inputs_answer(field)
    else:
        data = self.data(field_id)
    return field.render(
        context={
            "serialize": True,
            "data": data,
        }
    )

get_multi_inputs_answer 

get_multi_inputs_answer(field, include_question=False)
Source code in hypha/apply/funds/models/mixins.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
def get_multi_inputs_answer(self, field, include_question=False):
    number_of_inputs = field.value.get("number_of_inputs")
    answers = [self.data(field.id + "_" + str(i)) for i in range(number_of_inputs)]

    render_data = [
        field.render(
            context={
                "data": answer,
                "include_question": include_question if i == 0 else False,
            }
        )
        for i, answer in enumerate(filter(None, answers))
    ]
    return "".join(render_data).replace("</section>", "") + "</section>"

render_answer 

render_answer(field_id, include_question=False)
Source code in hypha/apply/funds/models/mixins.py 
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
def render_answer(self, field_id, include_question=False):
    try:
        field = self.field(field_id)
    except UnusedFieldException:
        return "-"
    if isinstance(field.block, MultiInputCharFieldBlock):
        render_data = self.get_multi_inputs_answer(field, include_question)
        return render_data
    else:
        data = self.data(field_id)
    # Some migrated content have empty address.
    if not data:
        return field.render(
            context={"data": "", "include_question": include_question}
        )
    return field.render(
        context={"data": data, "include_question": include_question}
    )

render_answers 

render_answers()
Source code in hypha/apply/funds/models/mixins.py 
295
296
297
298
299
300
def render_answers(self):
    # Returns a list of the rendered answers
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.normal_blocks
    ]

render_first_group_text_answers 

render_first_group_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
302
303
304
305
306
def render_first_group_text_answers(self):
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.first_group_normal_text_blocks
    ]

render_text_blocks_answers 

render_text_blocks_answers()
Source code in hypha/apply/funds/models/mixins.py 
308
309
310
311
312
313
314
def render_text_blocks_answers(self):
    # Returns a list of the rendered answers of type text
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.question_text_field_ids
        if field_id not in self.named_blocks
    ]

output_answers 

output_answers()
Source code in hypha/apply/funds/models/mixins.py 
316
317
318
def output_answers(self):
    # Returns a safe string of the rendered answers
    return mark_safe("".join(self.render_answers()))

output_text_answers 

output_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
320
321
def output_text_answers(self):
    return mark_safe("".join(self.render_text_blocks_answers()))

output_first_group_text_answers 

output_first_group_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
323
324
def output_first_group_text_answers(self):
    return mark_safe("".join(self.render_first_group_text_answers()))

get_answer_from_label 

get_answer_from_label(label)
Source code in hypha/apply/funds/models/mixins.py 
326
327
328
329
330
331
332
333
334
335
336
337
def get_answer_from_label(self, label):
    for field_id in self.question_text_field_ids:
        if field_id not in self.named_blocks:
            question_field = self.serialize(field_id)
            if label.lower() in question_field["question"].lower():
                if isinstance(question_field["answer"], str):
                    answer = question_field["answer"]
                else:
                    answer = ",".join(question_field["answer"])
                if answer and not answer == "N":
                    return answer
    return None

deserialize_form_data classmethod 

deserialize_form_data(instance, form_data, form_fields)
Source code in hypha/apply/stream_forms/models.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@classmethod
def deserialize_form_data(cls, instance, form_data, form_fields):
    data = form_data.copy()
    # PERFORMANCE NOTE:
    # Do not attempt to iterate over form_fields - that will fully instantiate the form_fields
    # including any sub queries that they do
    for _i, field_data in enumerate(form_fields.raw_data):
        block = form_fields.stream_block.child_blocks[field_data["type"]]
        field_id = field_data.get("id")
        try:
            value = data[field_id]
        except KeyError:
            pass
        else:
            data[field_id] = block.decode(value)
    return data

get_defined_fields 

get_defined_fields()
Source code in hypha/apply/stream_forms/models.py 
54
55
def get_defined_fields(self):
    return self.form_fields

get_form_fields 

get_form_fields(draft=False, form_data=None, user=None)
Source code in hypha/apply/stream_forms/models.py 
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def get_form_fields(self, draft=False, form_data=None, user=None):
    if form_data is None:
        form_data = {}

    form_fields = OrderedDict()
    field_blocks = self.get_defined_fields()
    group_counter = 1
    is_in_group = False

    # If true option 1 is selected
    grouped_fields_visible = False
    for struct_child in field_blocks:
        block = struct_child.block
        struct_value = struct_child.value
        if isinstance(block, FormFieldBlock):
            field_from_block = block.get_field(struct_value)
            disabled_help_text = _(
                "You are logged in so this information is fetched from your user account."
            )
            if isinstance(block, FullNameBlock) and user and user.is_authenticated:
                if user.full_name:
                    field_from_block.disabled = True
                    field_from_block.initial = user.full_name
                    field_from_block.help_text = disabled_help_text
                else:
                    field_from_block.help_text = _(
                        "You are logged in but your user account does not have a "
                        "full name. We'll update your user account with the name you provide here."
                    )
            if isinstance(block, EmailBlock) and user and user.is_authenticated:
                field_from_block.disabled = True
                field_from_block.initial = user.email
                field_from_block.help_text = disabled_help_text
            if draft and not issubclass(
                block.__class__, ApplicationMustIncludeFieldBlock
            ):
                field_from_block.required = False
            field_from_block.help_link = struct_value.get("help_link")
            field_from_block.group_number = group_counter if is_in_group else 1
            if isinstance(block, GroupToggleBlock) and not is_in_group:
                field_from_block.group_number = 1
                field_from_block.grouper_for = group_counter + 1
                group_counter += 1
                is_in_group = True
                grouped_fields_visible = (
                    form_data.get(struct_child.id) == field_from_block.choices[0][0]
                )
            if isinstance(block, TextFieldBlock):
                field_from_block.word_limit = struct_value.get("word_limit")
            if isinstance(block, MultiInputCharFieldBlock):
                number_of_inputs = struct_value.get("number_of_inputs")
                for index in range(number_of_inputs):
                    form_fields[struct_child.id + "_" + str(index)] = (
                        field_from_block
                    )
                    field_from_block.multi_input_id = struct_child.id
                    field_from_block.add_button_text = struct_value.get(
                        "add_button_text"
                    )
                    if (
                        index == number_of_inputs - 1
                    ):  # Add button after last input field
                        field_from_block.multi_input_add_button = True
                        # Index for field until which fields will be visible to applicant.
                        # Initially only the first field with id UUID_0 will be visible.
                        field_from_block.visibility_index = 0
                        field_from_block.max_index = index
                    if index != 0:
                        field_from_block.multi_input_field = True
                        field_from_block.required = False
                        field_from_block.initial = None
                    field_from_block = copy.copy(field_from_block)
            else:
                if is_in_group and not isinstance(block, GroupToggleBlock):
                    field_from_block.required_when_visible = (
                        field_from_block.required
                    )
                    field_from_block.required = (
                        field_from_block.required & grouped_fields_visible
                    )
                    field_from_block.visible = grouped_fields_visible
                form_fields[struct_child.id] = field_from_block
        elif isinstance(block, GroupToggleEndBlock):
            # Group toggle end block is used only to group fields and not used in actual form.
            # Todo: Use streamblock to create nested form field blocks, a more elegant method to group form fields.
            is_in_group = False
        else:
            field_wrapper = BlockFieldWrapper(struct_child)
            field_wrapper.group_number = group_counter if is_in_group else 1
            form_fields[struct_child.id] = field_wrapper

    return form_fields

get_form_class 

get_form_class(draft=False, form_data=None, user=None)
Source code in hypha/apply/stream_forms/models.py 
150
151
152
153
154
155
def get_form_class(self, draft=False, form_data=None, user=None):
    return type(
        "WagtailStreamForm",
        (self.submission_form_class,),
        self.get_form_fields(draft, form_data, user),
    )

get_compare_url_to_latest 

get_compare_url_to_latest()
Source code in hypha/apply/funds/models/application_revisions.py 
38
39
40
41
42
43
44
45
46
def get_compare_url_to_latest(self):
    return reverse(
        "funds:submissions:revisions:compare",
        kwargs={
            "submission_pk": self.submission.id,
            "to": self.submission.live_revision.id,
            "from": self.id,
        },
    )

get_absolute_url 

get_absolute_url()
Source code in hypha/apply/funds/models/application_revisions.py 
48
49
50
51
52
53
54
55
56
57
58
def get_absolute_url(self):
    # Compares against the previous revision
    previous_revision = self.submission.revisions.filter(id__lt=self.id).first()
    return reverse(
        "funds:submissions:revisions:compare",
        kwargs={
            "submission_pk": self.submission.id,
            "to": self.id,
            "from": previous_revision.id,
        },
    )

ApplicationSettings

Bases: BaseSiteSetting

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

extra_text_round class-attribute instance-attribute 

extra_text_round = RichTextField(blank=True)

extra_text_lab class-attribute instance-attribute 

extra_text_lab = RichTextField(blank=True)

panels class-attribute instance-attribute 

panels = [MultiFieldPanel([FieldPanel('extra_text_round'), FieldPanel('extra_text_lab')], 'extra text on application landing page')]

Meta

verbose_name class-attribute instance-attribute 
verbose_name = 'application settings'

RoundsAndLabs

Bases: Page

This behaves as a useful way to get all the rounds and labs that are defined in the project regardless of how they are implemented (lab/round/sealed_round)

objects class-attribute instance-attribute 

objects = RoundsAndLabsManager()

Meta

proxy class-attribute instance-attribute 
proxy = True

save 

save(*args, **kwargs)
Source code in hypha/apply/funds/models/applications.py 
837
838
def save(self, *args, **kwargs):
    raise NotImplementedError("Do not save through this model")

AssignedReviewers

Bases: Model

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

reviewer class-attribute instance-attribute 

reviewer = ForeignKey(AUTH_USER_MODEL, on_delete=CASCADE, limit_choices_to=LIMIT_TO_REVIEWER_GROUPS)

type class-attribute instance-attribute 

type = ForeignKey('auth.Group', on_delete=PROTECT)

submission class-attribute instance-attribute 

submission = ForeignKey('funds.ApplicationSubmission', related_name='assigned', on_delete=CASCADE)

role class-attribute instance-attribute 

role = ForeignKey('funds.ReviewerRole', related_name='+', on_delete=SET_NULL, null=True)

objects class-attribute instance-attribute 

objects = as_manager()

Meta

unique_together class-attribute instance-attribute 
unique_together = (('submission', 'role'), ('submission', 'reviewer'))

ApplicationForm

Bases: Model

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

name class-attribute instance-attribute 

name = CharField(max_length=255)

form_fields class-attribute instance-attribute 

form_fields = StreamField(ApplicationCustomFormFieldsBlock(), use_json_field=True)

panels class-attribute instance-attribute 

panels = [FieldPanel('name'), FieldPanel('form_fields')]

Reminder

Bases: Model

REVIEW class-attribute instance-attribute 

REVIEW = 'reviewers_review'

ACTIONS class-attribute instance-attribute 

ACTIONS = {REVIEW: 'Remind reviewers to Review'}

EMAIL class-attribute instance-attribute 

EMAIL = 'email'

MEDIUM class-attribute instance-attribute 

MEDIUM = {REVIEW: EMAIL}

ACTION_MESSAGE class-attribute instance-attribute 

ACTION_MESSAGE = {f'{REVIEW}-{EMAIL}': REVIEW_REMINDER}

submission class-attribute instance-attribute 

submission = ForeignKey('funds.ApplicationSubmission', on_delete=CASCADE, related_name='reminders')

user class-attribute instance-attribute 

user = ForeignKey(AUTH_USER_MODEL, on_delete=PROTECT)

time class-attribute instance-attribute 

time = DateTimeField()

action class-attribute instance-attribute 

action = CharField(choices=items(), default=REVIEW, max_length=50)

sent class-attribute instance-attribute 

sent = BooleanField(default=False)

title class-attribute instance-attribute 

title = CharField(max_length=60, blank=False, default='')

description class-attribute instance-attribute 

description = TextField(blank=True)

is_expired property 

is_expired

action_message property 

action_message

action_type property 

action_type

medium property 

medium

Meta

ordering class-attribute instance-attribute 
ordering = ['-time']

clean 

clean()
Source code in hypha/apply/funds/models/reminders.py 
46
47
48
def clean(self):
    if self.title == "":
        raise ValidationError("Title is Empty")

ReviewerRole

Bases: Model

name class-attribute instance-attribute 

name = CharField(max_length=128)

icon class-attribute instance-attribute 

icon = ForeignKey('images.CustomImage', null=True, blank=True, related_name='+', on_delete=SET_NULL)

order class-attribute instance-attribute 

order = IntegerField(help_text=gettext_lazy('The order this role should appear in the Update Reviewers form.'), null=True, blank=True)

panels class-attribute instance-attribute 

panels = [FieldPanel('name'), FieldPanel('icon'), FieldPanel('order')]

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

icon_url 

icon_url(filter_spec)
Source code in hypha/apply/funds/models/reviewer_role.py 
30
31
def icon_url(self, filter_spec):
    return generate_image_url(self.icon, filter_spec)

ReviewerSettings

Bases: BaseSiteSetting

SUBMISSIONS class-attribute instance-attribute 

SUBMISSIONS = [('all', 'All Submissions'), ('reviewed', 'Only reviewed Submissions')]

STATES class-attribute instance-attribute 

STATES = [('all', 'All States'), ('ext_state_or_higher', 'Only External review and higher'), ('ext_state_only', 'Only External review')]

OUTCOMES class-attribute instance-attribute 

OUTCOMES = [('all', 'All Outcomes'), ('all_except_dismissed', 'All Outcomes Except Dismissed'), ('accepted', 'Only Accepted')]

submission class-attribute instance-attribute 

submission = CharField(choices=SUBMISSIONS, default='all', max_length=10, help_text=gettext_lazy('Submissions for which reviewers should have access to'))

state class-attribute instance-attribute 

state = CharField(choices=STATES, default='all', max_length=20, help_text=gettext_lazy('Submissions states for which reviewers should have access to'))

outcome class-attribute instance-attribute 

outcome = CharField(choices=OUTCOMES, default='all', max_length=20, help_text=gettext_lazy('Submissions outcomes for which reviewers should have access to'))

assigned class-attribute instance-attribute 

assigned = BooleanField(default=False, help_text=gettext_lazy('Submissions for which reviewer is assigned to'))

use_settings class-attribute instance-attribute 

use_settings = BooleanField(default=False, help_text=gettext_lazy('Use the above configured variables to filter out submissions'))

panels class-attribute instance-attribute 

panels = [FieldPanel('submission'), FieldPanel('state'), FieldPanel('outcome'), FieldPanel('assigned'), FieldPanel('use_settings')]

Meta

verbose_name class-attribute instance-attribute 
verbose_name = 'Reviewer Settings'

ScreeningStatus

Bases: Model

title class-attribute instance-attribute 

title = CharField(max_length=128)

yes class-attribute instance-attribute 

yes = BooleanField(default=False, verbose_name=gettext_lazy('Yes/No'), help_text=gettext_lazy('Tick mark for Yes otherwise No.'))

default class-attribute instance-attribute 

default = BooleanField(default=False, verbose_name=gettext_lazy('Default Yes/No'), help_text=gettext_lazy('Only one Yes and No screening decision can be set as default.'))

base_form_class class-attribute instance-attribute 

base_form_class = ScreeningStatusAdminForm

Meta

verbose_name class-attribute instance-attribute 
verbose_name = 'Screening Decision'
verbose_name_plural class-attribute instance-attribute 
verbose_name_plural = 'screening decisions'

ApplicationSubmission

Bases: WorkflowHelpers, BaseStreamForm, AccessFormData, AbstractFormSubmission

stream_file_class class-attribute instance-attribute 

stream_file_class = PrivateStreamFieldFile

storage_class class-attribute instance-attribute 

storage_class = PrivateStorage

raw_data property 

raw_data

question_field_ids property 

question_field_ids

file_field_ids property 

file_field_ids

question_text_field_ids property 

question_text_field_ids

first_group_question_text_field_ids property 

first_group_question_text_field_ids

raw_fields property 

raw_fields

fields property 

fields

named_blocks property 

named_blocks

normal_blocks property 

normal_blocks

group_toggle_blocks property 

group_toggle_blocks

first_group_normal_text_blocks property 

first_group_normal_text_blocks

submission_form_class class-attribute instance-attribute 

submission_form_class = PageStreamBaseForm

WORKFLOW_CHOICES class-attribute instance-attribute 

WORKFLOW_CHOICES = {name: _Vaqfor (name, workflow) in items()}

workflow_name class-attribute instance-attribute 

workflow_name = CharField(choices=items(), max_length=100, default='single', verbose_name=gettext_lazy('Workflow'))

workflow property 

workflow

form_data class-attribute instance-attribute 

form_data = JSONField(encoder=StreamFieldDataEncoder)

form_fields class-attribute instance-attribute 

form_fields = StreamField(ApplicationCustomFormFieldsBlock(), use_json_field=True)

public_id class-attribute instance-attribute 

public_id = CharField(max_length=255, null=True, blank=True, unique=True, db_index=True)

summary class-attribute instance-attribute 

summary = TextField(default='', null=True, blank=True)

page class-attribute instance-attribute 

page = ForeignKey('wagtailcore.Page', on_delete=PROTECT)

round class-attribute instance-attribute 

round = ForeignKey('wagtailcore.Page', on_delete=PROTECT, related_name='submissions', null=True)

lead class-attribute instance-attribute 

lead = ForeignKey(AUTH_USER_MODEL, limit_choices_to=LIMIT_TO_STAFF, related_name='submission_lead', on_delete=PROTECT)

next class-attribute instance-attribute 

next = OneToOneField('self', on_delete=CASCADE, related_name='previous', null=True)

reviewers class-attribute instance-attribute 

reviewers = ManyToManyField(AUTH_USER_MODEL, related_name='submissions_reviewer', blank=True, through='AssignedReviewers')

partners class-attribute instance-attribute 

partners = ManyToManyField(AUTH_USER_MODEL, related_name='submissions_partner', limit_choices_to=LIMIT_TO_PARTNERS, blank=True)

meta_terms class-attribute instance-attribute 

meta_terms = ManyToManyField(MetaTerm, related_name='submissions', blank=True)

flags class-attribute instance-attribute 

flags = GenericRelation(Flag, content_type_field='target_content_type', object_id_field='target_object_id', related_query_name='submission')

activities class-attribute instance-attribute 

activities = GenericRelation('activity.Activity', content_type_field='source_content_type', object_id_field='source_object_id', related_query_name='submission')

user class-attribute instance-attribute 

user = ForeignKey(AUTH_USER_MODEL, on_delete=SET_NULL, null=True)

search_data class-attribute instance-attribute 

search_data = TextField()

search_document class-attribute instance-attribute 

search_document = SearchVectorField(null=True)

status class-attribute instance-attribute 

status = FSMField(default=INITIAL_STATE, protected=True)

screening_statuses class-attribute instance-attribute 

screening_statuses = ManyToManyField('funds.ScreeningStatus', related_name='submissions', blank=True)

submit_time class-attribute instance-attribute 

submit_time = DateTimeField(verbose_name=gettext_lazy('submit time'), auto_now_add=False)

live_revision class-attribute instance-attribute 

live_revision = OneToOneField('ApplicationRevision', on_delete=CASCADE, related_name='live', null=True, editable=False)

draft_revision class-attribute instance-attribute 

draft_revision = OneToOneField('ApplicationRevision', on_delete=CASCADE, related_name='draft', null=True, editable=False)

drupal_id class-attribute instance-attribute 

drupal_id = IntegerField(null=True, blank=True, editable=False)

is_archive class-attribute instance-attribute 

is_archive = BooleanField(default=False)

objects class-attribute instance-attribute 

objects = as_manager()

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

is_draft property 

is_draft

title_text_display property 

title_text_display

Return the title text for display across the site.

Use SUBMISSION_TITLE_TEXT_TEMPLATE setting to change format.

stage property 

stage

phase property 

phase

active property 

active

is_determination_form_attached property 

is_determination_form_attached

We use old django determination forms but now as we are moving to streamfield determination forms which can be created and attached to funds in admin.

This method checks if there are new determination forms attached to the submission or we would still use the old determination forms for backward compatibility.

has_all_reviewer_roles_assigned property 

has_all_reviewer_roles_assigned

community_review property 

community_review

missing_reviewers property 

missing_reviewers

staff_not_reviewed property 

staff_not_reviewed

reviewers_not_reviewed property 

reviewers_not_reviewed

flagged_staff property 

flagged_staff

ready_for_determination property 

ready_for_determination

accepted_for_funding property 

accepted_for_funding

in_final_stage property 

in_final_stage

in_internal_review_phase property 

in_internal_review_phase

in_external_review_phase property 

in_external_review_phase

is_finished property 

is_finished

Meta

indexes class-attribute instance-attribute 
indexes = [GinIndex(fields=['search_document'])]

stream_file classmethod 

stream_file(instance, field, file)
Source code in hypha/apply/funds/models/mixins.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@classmethod
def stream_file(cls, instance, field, file):
    if not file:
        return []
    if isinstance(file, cls.stream_file_class):
        return file
    if isinstance(file, File):
        return cls.stream_file_class(
            instance, field, file, name=file.name, storage=cls.storage_class()
        )

    if isinstance(file, PlaceholderUploadedFile):
        return cls.stream_file_class(
            instance,
            field,
            None,
            name=file.file_id,
            filename=file.name,
            storage=cls.storage_class(),
        )

    # This fixes a backwards compatibility issue with #507
    # Once every application has been re-saved it should be possible to remove it
    if "path" in file:
        file["filename"] = file["name"]
        file["name"] = file["path"]
    return cls.stream_file_class(
        instance,
        field,
        None,
        name=file["name"],
        filename=file.get("filename"),
        storage=cls.storage_class(),
    )

process_file classmethod 

process_file(instance, field, file)
Source code in hypha/apply/funds/models/mixins.py 
88
89
90
91
92
93
@classmethod
def process_file(cls, instance, field, file):
    if isinstance(file, list):
        return [cls.stream_file(instance, field, f) for f in file]
    else:
        return cls.stream_file(instance, field, file)

process_file_data 

process_file_data(data)
Source code in hypha/apply/funds/models/mixins.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def process_file_data(self, data):
    for field in self.form_fields:
        if isinstance(field.block, UploadableMediaBlock):
            file = self.process_file(self, field, data.get(field.id, []))
            try:
                file.save()
            except (AttributeError, FileNotFoundError):
                try:
                    for f in file:
                        f.save()
                except FileNotFoundError:
                    pass
            self.form_data[field.id] = file

extract_files 

extract_files()
Source code in hypha/apply/funds/models/mixins.py 
109
110
111
112
113
114
115
def extract_files(self):
    files = {}
    for field in self.form_fields:
        if isinstance(field.block, UploadableMediaBlock):
            files[field.id] = self.data(field.id) or []
            self.form_data.pop(field.id, None)
    return files

from_db classmethod 

from_db(db, field_names, values)
Source code in hypha/apply/stream_forms/models.py 
28
29
30
31
32
33
34
35
@classmethod
def from_db(cls, db, field_names, values):
    instance = super().from_db(db, field_names, values)
    if "form_data" in field_names:
        instance.form_data = cls.deserialize_form_data(
            instance, instance.form_data, instance.form_fields
        )
    return instance

deserialised_data classmethod 

deserialised_data(instance, data, form_fields)
Source code in hypha/apply/funds/models/mixins.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@classmethod
def deserialised_data(cls, instance, data, form_fields):
    # Converts the file dicts into actual file objects
    data = data.copy()
    # PERFORMANCE NOTE:
    # Do not attempt to iterate over form_fields - that will fully instantiate the form_fields
    # including any sub queries that they do
    for i, field_data in enumerate(form_fields.raw_data):
        block = form_fields.stream_block.child_blocks[field_data["type"]]
        if isinstance(block, UploadableMediaBlock):
            field_id = field_data.get("id")
            if field_id:
                field = form_fields[i]
                file = data.get(field_id, [])
                data[field_id] = cls.process_file(instance, field, file)
    return data

get_definitive_id 

get_definitive_id(id)
Source code in hypha/apply/funds/models/mixins.py 
144
145
146
147
def get_definitive_id(self, id):
    if id in self.named_blocks:
        return self.named_blocks[id]
    return id

field 

field(id)
Source code in hypha/apply/funds/models/mixins.py 
149
150
151
152
153
154
def field(self, id):
    definitive_id = self.get_definitive_id(id)
    try:
        return self.raw_fields[definitive_id]
    except KeyError:
        raise UnusedFieldException(id) from None

data 

data(id)
Source code in hypha/apply/funds/models/mixins.py 
156
157
158
159
160
161
162
def data(self, id):
    definitive_id = self.get_definitive_id(id)
    try:
        return self.raw_data[definitive_id]
    except KeyError:
        # We have most likely progressed application forms so the data isn't in form_data
        return None

get_serialize_multi_inputs_answer 

get_serialize_multi_inputs_answer(field)
Source code in hypha/apply/funds/models/mixins.py 
242
243
244
245
246
def get_serialize_multi_inputs_answer(self, field):
    number_of_inputs = field.value.get("number_of_inputs")
    answers = [self.data(field.id + "_" + str(i)) for i in range(number_of_inputs)]
    data = ", ".join(filter(None, answers))
    return data

serialize 

serialize(field_id)
Source code in hypha/apply/funds/models/mixins.py 
248
249
250
251
252
253
254
255
256
257
258
259
def serialize(self, field_id):
    field = self.field(field_id)
    if isinstance(field.block, MultiInputCharFieldBlock):
        data = self.get_serialize_multi_inputs_answer(field)
    else:
        data = self.data(field_id)
    return field.render(
        context={
            "serialize": True,
            "data": data,
        }
    )

get_multi_inputs_answer 

get_multi_inputs_answer(field, include_question=False)
Source code in hypha/apply/funds/models/mixins.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
def get_multi_inputs_answer(self, field, include_question=False):
    number_of_inputs = field.value.get("number_of_inputs")
    answers = [self.data(field.id + "_" + str(i)) for i in range(number_of_inputs)]

    render_data = [
        field.render(
            context={
                "data": answer,
                "include_question": include_question if i == 0 else False,
            }
        )
        for i, answer in enumerate(filter(None, answers))
    ]
    return "".join(render_data).replace("</section>", "") + "</section>"

render_answer 

render_answer(field_id, include_question=False)
Source code in hypha/apply/funds/models/mixins.py 
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
def render_answer(self, field_id, include_question=False):
    try:
        field = self.field(field_id)
    except UnusedFieldException:
        return "-"
    if isinstance(field.block, MultiInputCharFieldBlock):
        render_data = self.get_multi_inputs_answer(field, include_question)
        return render_data
    else:
        data = self.data(field_id)
    # Some migrated content have empty address.
    if not data:
        return field.render(
            context={"data": "", "include_question": include_question}
        )
    return field.render(
        context={"data": data, "include_question": include_question}
    )

render_answers 

render_answers()
Source code in hypha/apply/funds/models/mixins.py 
295
296
297
298
299
300
def render_answers(self):
    # Returns a list of the rendered answers
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.normal_blocks
    ]

render_first_group_text_answers 

render_first_group_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
302
303
304
305
306
def render_first_group_text_answers(self):
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.first_group_normal_text_blocks
    ]

render_text_blocks_answers 

render_text_blocks_answers()
Source code in hypha/apply/funds/models/mixins.py 
308
309
310
311
312
313
314
def render_text_blocks_answers(self):
    # Returns a list of the rendered answers of type text
    return [
        self.render_answer(field_id, include_question=True)
        for field_id in self.question_text_field_ids
        if field_id not in self.named_blocks
    ]

output_answers 

output_answers()
Source code in hypha/apply/funds/models/mixins.py 
316
317
318
def output_answers(self):
    # Returns a safe string of the rendered answers
    return mark_safe("".join(self.render_answers()))

output_text_answers 

output_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
320
321
def output_text_answers(self):
    return mark_safe("".join(self.render_text_blocks_answers()))

output_first_group_text_answers 

output_first_group_text_answers()
Source code in hypha/apply/funds/models/mixins.py 
323
324
def output_first_group_text_answers(self):
    return mark_safe("".join(self.render_first_group_text_answers()))

get_answer_from_label 

get_answer_from_label(label)
Source code in hypha/apply/funds/models/mixins.py 
326
327
328
329
330
331
332
333
334
335
336
337
def get_answer_from_label(self, label):
    for field_id in self.question_text_field_ids:
        if field_id not in self.named_blocks:
            question_field = self.serialize(field_id)
            if label.lower() in question_field["question"].lower():
                if isinstance(question_field["answer"], str):
                    answer = question_field["answer"]
                else:
                    answer = ",".join(question_field["answer"])
                if answer and not answer == "N":
                    return answer
    return None

deserialize_form_data classmethod 

deserialize_form_data(instance, form_data, form_fields)
Source code in hypha/apply/stream_forms/models.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@classmethod
def deserialize_form_data(cls, instance, form_data, form_fields):
    data = form_data.copy()
    # PERFORMANCE NOTE:
    # Do not attempt to iterate over form_fields - that will fully instantiate the form_fields
    # including any sub queries that they do
    for _i, field_data in enumerate(form_fields.raw_data):
        block = form_fields.stream_block.child_blocks[field_data["type"]]
        field_id = field_data.get("id")
        try:
            value = data[field_id]
        except KeyError:
            pass
        else:
            data[field_id] = block.decode(value)
    return data

get_defined_fields 

get_defined_fields()
Source code in hypha/apply/stream_forms/models.py 
54
55
def get_defined_fields(self):
    return self.form_fields

get_form_fields 

get_form_fields(draft=False, form_data=None, user=None)
Source code in hypha/apply/stream_forms/models.py 
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def get_form_fields(self, draft=False, form_data=None, user=None):
    if form_data is None:
        form_data = {}

    form_fields = OrderedDict()
    field_blocks = self.get_defined_fields()
    group_counter = 1
    is_in_group = False

    # If true option 1 is selected
    grouped_fields_visible = False
    for struct_child in field_blocks:
        block = struct_child.block
        struct_value = struct_child.value
        if isinstance(block, FormFieldBlock):
            field_from_block = block.get_field(struct_value)
            disabled_help_text = _(
                "You are logged in so this information is fetched from your user account."
            )
            if isinstance(block, FullNameBlock) and user and user.is_authenticated:
                if user.full_name:
                    field_from_block.disabled = True
                    field_from_block.initial = user.full_name
                    field_from_block.help_text = disabled_help_text
                else:
                    field_from_block.help_text = _(
                        "You are logged in but your user account does not have a "
                        "full name. We'll update your user account with the name you provide here."
                    )
            if isinstance(block, EmailBlock) and user and user.is_authenticated:
                field_from_block.disabled = True
                field_from_block.initial = user.email
                field_from_block.help_text = disabled_help_text
            if draft and not issubclass(
                block.__class__, ApplicationMustIncludeFieldBlock
            ):
                field_from_block.required = False
            field_from_block.help_link = struct_value.get("help_link")
            field_from_block.group_number = group_counter if is_in_group else 1
            if isinstance(block, GroupToggleBlock) and not is_in_group:
                field_from_block.group_number = 1
                field_from_block.grouper_for = group_counter + 1
                group_counter += 1
                is_in_group = True
                grouped_fields_visible = (
                    form_data.get(struct_child.id) == field_from_block.choices[0][0]
                )
            if isinstance(block, TextFieldBlock):
                field_from_block.word_limit = struct_value.get("word_limit")
            if isinstance(block, MultiInputCharFieldBlock):
                number_of_inputs = struct_value.get("number_of_inputs")
                for index in range(number_of_inputs):
                    form_fields[struct_child.id + "_" + str(index)] = (
                        field_from_block
                    )
                    field_from_block.multi_input_id = struct_child.id
                    field_from_block.add_button_text = struct_value.get(
                        "add_button_text"
                    )
                    if (
                        index == number_of_inputs - 1
                    ):  # Add button after last input field
                        field_from_block.multi_input_add_button = True
                        # Index for field until which fields will be visible to applicant.
                        # Initially only the first field with id UUID_0 will be visible.
                        field_from_block.visibility_index = 0
                        field_from_block.max_index = index
                    if index != 0:
                        field_from_block.multi_input_field = True
                        field_from_block.required = False
                        field_from_block.initial = None
                    field_from_block = copy.copy(field_from_block)
            else:
                if is_in_group and not isinstance(block, GroupToggleBlock):
                    field_from_block.required_when_visible = (
                        field_from_block.required
                    )
                    field_from_block.required = (
                        field_from_block.required & grouped_fields_visible
                    )
                    field_from_block.visible = grouped_fields_visible
                form_fields[struct_child.id] = field_from_block
        elif isinstance(block, GroupToggleEndBlock):
            # Group toggle end block is used only to group fields and not used in actual form.
            # Todo: Use streamblock to create nested form field blocks, a more elegant method to group form fields.
            is_in_group = False
        else:
            field_wrapper = BlockFieldWrapper(struct_child)
            field_wrapper.group_number = group_counter if is_in_group else 1
            form_fields[struct_child.id] = field_wrapper

    return form_fields

get_form_class 

get_form_class(draft=False, form_data=None, user=None)
Source code in hypha/apply/stream_forms/models.py 
150
151
152
153
154
155
def get_form_class(self, draft=False, form_data=None, user=None):
    return type(
        "WagtailStreamForm",
        (self.submission_form_class,),
        self.get_form_fields(draft, form_data, user),
    )

not_progressed 

not_progressed()
Source code in hypha/apply/funds/models/submissions.py 
527
528
def not_progressed(self):
    return not self.next

restart_stage 

restart_stage(**kwargs)

If running form the console please include your user using the kwarg "by"

u = User.objects.get(email="my@email.com") for a in ApplicationSubmission.objects.all(): a.restart_stage(by=u) a.save()

Source code in hypha/apply/funds/models/submissions.py 
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
@transition(
    status,
    source="*",
    target=RETURN_VALUE(INITIAL_STATE, "draft_proposal", "invited_to_proposal"),
    permission=make_permission_check({UserPermissions.ADMIN}),
)
def restart_stage(self, **kwargs):
    """
    If running form the console please include your user using the kwarg "by"

    u = User.objects.get(email="<[email protected]>")
    for a in ApplicationSubmission.objects.all():
        a.restart_stage(by=u)
        a.save()
    """
    if hasattr(self, "previous"):
        return "draft_proposal"
    elif self.next:
        return "invited_to_proposal"
    return INITIAL_STATE

ensure_user_has_account 

ensure_user_has_account()
Source code in hypha/apply/funds/models/submissions.py 
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
def ensure_user_has_account(self):
    if self.user and self.user.is_authenticated:
        self.form_data["email"] = self.user.email
        if name := self.user.get_full_name():
            self.form_data["full_name"] = name
        else:
            # user doesn't have name set, so use the one from the form
            self.user.full_name = self.form_data["full_name"]
            self.user.save()
    else:
        # Rely on the form having the following must include fields (see blocks.py)
        email = self.form_data.get("email")
        full_name = self.form_data.get("full_name")

        User = get_user_model()
        if "skip_account_creation_notification" in self.form_data:
            self.form_data.pop("skip_account_creation_notification", None)
            self.user, _ = User.objects.get_or_create(
                email=email, defaults={"full_name": full_name}
            )
        else:
            self.user, _ = User.objects.get_or_create_and_notify(
                email=email,
                site=self.page.get_site(),
                defaults={"full_name": full_name},
            )

    # Make sure the user is in the applicant group
    if not self.user.is_applicant:
        applicant_group = Group.objects.get(name=APPLICANT_GROUP_NAME)
        self.user.groups.add(applicant_group)
        self.user.save()

get_from_parent 

get_from_parent(attribute)
Source code in hypha/apply/funds/models/submissions.py 
596
597
598
599
600
601
def get_from_parent(self, attribute):
    try:
        return getattr(self.round.specific, attribute)
    except AttributeError:
        # We are a lab submission
        return getattr(self.page.specific, attribute)

progress_application 

progress_application(**kwargs)
Source code in hypha/apply/funds/models/submissions.py 
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
def progress_application(self, **kwargs):
    target = None
    for phase in STAGE_CHANGE_ACTIONS:
        transition = self.get_transition(phase)
        if can_proceed(transition):
            # We convert to dict as not concerned about transitions from the first phase
            # See note in workflow.py
            target = dict(PHASES)[phase].stage
    if not target:
        raise ValueError("Incorrect State for transition")

    submission_in_db = ApplicationSubmission.objects.get(id=self.id)
    prev_meta_terms = submission_in_db.meta_terms.all()

    self.id = None
    self.public_id = None
    proposal_form = kwargs.get("proposal_form")
    proposal_form = int(proposal_form) if proposal_form else 0
    self.form_fields = self.get_from_parent("get_defined_fields")(
        target, form_index=proposal_form
    )

    self.live_revision = None
    self.draft_revision = None
    self.save()
    self.meta_terms.set(prev_meta_terms)

    submission_in_db.next = self
    submission_in_db.save()

from_draft 

from_draft()

Sets current form_data to the form_data from the draft revision.

Returns:

  • Self –

    Self with the form_data attribute updated.

Source code in hypha/apply/funds/models/submissions.py 
646
647
648
649
650
651
652
653
654
655
656
def from_draft(self) -> Self:
    """Sets current `form_data` to the `form_data` from the draft revision.

    Returns:
        Self with the `form_data` attribute updated.
    """
    self.form_data = self.deserialised_data(
        self, self.draft_revision.form_data, self.form_fields
    )

    return self

create_revision 

create_revision(draft=False, force=False, by=None, **kwargs)

Create a new revision on the submission

This is used to save drafts, track changes when an RFI is made and save changes before rendering a preview

Parameters:

  • draft –

    if the revision is a draft

  • force –

    force a revision even if form data is the same

  • by (Optional[AnonymousUser | AbstractBaseUser], default: None ) –

    the author of the revision

  • preview –

    if the revision is being used to save befor a preview

Returns:

  • Optional[Model] –

    Returns the ApplicationRevision if it was created, otherwise returns None

Source code in hypha/apply/funds/models/submissions.py 
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
def create_revision(
    self,
    draft=False,
    force=False,
    by: Optional[AnonymousUser | AbstractBaseUser] = None,
    **kwargs,
) -> Optional[models.Model]:
    """Create a new revision on the submission

    This is used to save drafts, track changes when an RFI is made and
    save changes before rendering a preview

    Args:
        draft: if the revision is a draft
        force: force a revision even if form data is the same
        by: the author of the revision
        preview: if the revision is being used to save befor a preview

    Returns:
        Returns the [`ApplicationRevision`][hypha.apply.funds.models.ApplicationRevision] if it was created, otherwise returns `None`
    """
    ApplicationRevision = apps.get_model("funds", "ApplicationRevision")
    self.clean_submission()
    current_submission = ApplicationSubmission.objects.get(id=self.id)
    current_data = current_submission.form_data
    if current_data != self.form_data or force:
        if self.live_revision == self.draft_revision:
            revision = ApplicationRevision.objects.create(
                submission=self,
                form_data=self.form_data,
                author=by,
                is_draft=draft,
            )
        else:
            revision = self.draft_revision
            revision.form_data = self.form_data
            revision.author = by
            revision.save()

        if draft:
            self.form_data = current_submission.form_data
        else:
            # Move the revision state out of draft as it is being submitted
            if revision.is_draft:
                revision.is_draft = False
                revision.save()
            self.live_revision = revision
            self.search_data = " ".join(list(self.prepare_search_values()))
            self.search_document = self.prepare_search_vector()

        self.draft_revision = revision
        self.save(skip_custom=True)
        return revision
    else:
        revision = self.draft_revision

        # Utilized when the user has previously saved a draft,
        # then doesn't edit the draft but submits it straight
        # from the edit view
        if not draft and revision.is_draft:
            revision.is_draft = False
            revision.save()
            self.live_revision = revision
            self.search_data = " ".join(list(self.prepare_search_values()))
            self.search_document = self.prepare_search_vector()
            self.save(skip_custom=True)

            return revision

    return None

clean_submission 

clean_submission()
Source code in hypha/apply/funds/models/submissions.py 
730
731
732
733
def clean_submission(self):
    self.process_form_data()
    self.ensure_user_has_account()
    self.process_file_data(self.form_data)

get_assigned_meta_terms 

get_assigned_meta_terms()

Returns assigned meta terms excluding the 'root' term

Source code in hypha/apply/funds/models/submissions.py 
735
736
737
def get_assigned_meta_terms(self):
    """Returns assigned meta terms excluding the 'root' term"""
    return self.meta_terms.exclude(depth=1)

process_form_data 

process_form_data()
Source code in hypha/apply/funds/models/submissions.py 
739
740
741
742
743
def process_form_data(self):
    for field_name, field_id in self.named_blocks.items():
        response = self.form_data.pop(field_id, None)
        if response:
            self.form_data[field_name] = response

save 

save(*args, update_fields=None, skip_custom=False, **kwargs)
Source code in hypha/apply/funds/models/submissions.py 
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
def save(self, *args, update_fields=None, skip_custom=False, **kwargs):
    if update_fields is None:
        update_fields = []
    if update_fields and "form_data" not in update_fields:
        # We don't want to use this approach if the user is sending data
        return super().save(*args, update_fields=update_fields, **kwargs)
    elif skip_custom:
        return super().save(*args, **kwargs)

    creating = not self.id

    if creating:
        self.submit_time = timezone.now()
        # We are creating the object default to first stage
        self.workflow_name = self.get_from_parent("workflow_name")
        # Copy extra relevant information to the child
        self.lead = self.get_from_parent("lead")

        # We need the submission id to correctly save the files
        files = self.extract_files()

    self.clean_submission()

    # add a denormed version of the answer for searching
    # @TODO: remove 'search_data' in favour of 'search_document' for FTS
    self.search_data = " ".join(self.prepare_search_values())
    self.search_document = self.prepare_search_vector()

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

    # TODO: This functionality should be extracted and moved to a separate function, too hidden here
    if creating:
        AssignedReviewers = apps.get_model("funds", "AssignedReviewers")
        ApplicationRevision = apps.get_model("funds", "ApplicationRevision")

        if not self.public_id:
            self.public_id = (
                f"{self.get_from_parent('submission_id_prefix')}{self.id}"
            )

        self.process_file_data(files)
        AssignedReviewers.objects.bulk_create_reviewers(
            list(self.get_from_parent("reviewers").all()),
            self,
        )
        # TODO: This functionality should be implemented into `ApplicationSubmission.create_revision`
        first_revision = ApplicationRevision.objects.create(
            submission=self,
            form_data=self.form_data,
            author=self.user,
            is_draft=self.is_draft,
        )
        self.live_revision = first_revision
        self.draft_revision = first_revision
        self.save()

reviewed_by 

reviewed_by(user)
Source code in hypha/apply/funds/models/submissions.py 
825
826
def reviewed_by(self, user):
    return self.assigned.reviewed().filter(reviewer=user).exists()

flagged_by 

flagged_by(user)
Source code in hypha/apply/funds/models/submissions.py 
828
829
def flagged_by(self, user):
    return self.flags.filter(user=user, type=Flag.USER).exists()

has_permission_to_review 

has_permission_to_review(user)
Source code in hypha/apply/funds/models/submissions.py 
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
def has_permission_to_review(self, user):
    if user.is_apply_staff:
        return True

    if user in self.reviewers_not_reviewed:
        return True

    if (
        user.is_community_reviewer
        and self.user != user
        and self.community_review
        and not self.reviewed_by(user)
    ):
        return True

    return False

can_review 

can_review(user)
Source code in hypha/apply/funds/models/submissions.py 
852
853
854
855
856
def can_review(self, user):
    if self.reviewed_by(user):
        return False

    return self.has_permission_to_review(user)

can_view_draft 

can_view_draft(user)
Source code in hypha/apply/funds/models/submissions.py 
858
859
860
861
862
863
864
865
866
867
868
def can_view_draft(self, user):
    if self.user == user:
        return True

    if user.is_apply_staff and settings.SUBMISSIONS_DRAFT_ACCESS_STAFF:
        return True

    if user.is_apply_staff_admin and settings.SUBMISSIONS_DRAFT_ACCESS_STAFF_ADMIN:
        return True

    return False

get_searchable_contents 

get_searchable_contents()
Source code in hypha/apply/funds/models/submissions.py 
870
871
872
873
874
875
876
877
878
879
880
881
def get_searchable_contents(self):
    contents = []
    for field_id in self.question_field_ids:
        field = self.field(field_id)
        data = self.data(field_id)
        value = field.block.get_searchable_content(field.value, data)
        if value:
            if isinstance(value, list):
                contents.append(", ".join(value))
            else:
                contents.append(value)
    return contents

prepare_search_values 

prepare_search_values()
Source code in hypha/apply/funds/models/submissions.py 
883
884
885
886
887
888
889
890
def prepare_search_values(self):
    values = self.get_searchable_contents()

    # Add named fields into the search index
    for field in ["full_name", "email", "title", "public_id"]:
        if value := getattr(self, field):
            values.append(value)
    return values

index_components 

index_components()
Source code in hypha/apply/funds/models/submissions.py 
892
893
894
895
896
897
def index_components(self):
    return {
        "A": " ".join([f"id:{self.public_id or self.id}", self.title]),
        "C": " ".join([self.full_name, self.email]),
        "B": " ".join(self.get_searchable_contents()),
    }

prepare_search_vector 

prepare_search_vector()
Source code in hypha/apply/funds/models/submissions.py 
899
900
901
902
903
def prepare_search_vector(self):
    search_vectors = []
    for weight, text in self.index_components().items():
        search_vectors.append(SearchVector(Value(text), weight=weight))
    return reduce(operator.add, search_vectors)

get_absolute_url 

get_absolute_url()
Source code in hypha/apply/funds/models/submissions.py 
905
906
def get_absolute_url(self):
    return reverse("funds:submissions:detail", args=(self.id,))

get_data 

get_data()
Source code in hypha/apply/funds/models/submissions.py 
950
951
952
953
954
955
956
957
958
959
def get_data(self):
    # Updated for JSONField - Not used but base get_data will error
    form_data = self.form_data.copy()
    form_data.update(
        {
            "submit_time": self.submit_time,
        }
    )

    return form_data

get_current_screening_status 

get_current_screening_status()
Source code in hypha/apply/funds/models/submissions.py 
968
969
def get_current_screening_status(self):
    return self.screening_statuses.first()

get_yes_screening_status 

get_yes_screening_status()
Source code in hypha/apply/funds/models/submissions.py 
971
972
def get_yes_screening_status(self):
    return self.screening_statuses.filter(yes=True).exists()

get_no_screening_status 

get_no_screening_status()
Source code in hypha/apply/funds/models/submissions.py 
974
975
def get_no_screening_status(self):
    return self.screening_statuses.filter(yes=False).first()