Views

hypha.apply.funds.views

User module-attribute

User = get_user_model()

SubmissionStatsMixin

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    submissions = ApplicationSubmission.objects.exclude_draft()
    submission_undetermined_count = submissions.undetermined().count()
    review_my_count = submissions.reviewed_by(self.request.user).count()

    submission_value = submissions.current().value()
    submission_sum = intcomma(submission_value.get("value__sum"))
    submission_count = submission_value.get("value__count")

    submission_accepted = submissions.current_accepted()
    submission_accepted_value = submission_accepted.value()
    submission_accepted_sum = intcomma(submission_accepted_value.get("value__sum"))
    submission_accepted_count = submission_accepted.count()

    reviews = Review.objects.submitted()
    review_count = reviews.count()
    review_my_score = reviews.by_user(self.request.user).score()

    return super().get_context_data(
        submission_undetermined_count=submission_undetermined_count,
        review_my_count=review_my_count,
        submission_sum=submission_sum,
        submission_count=submission_count,
        submission_accepted_count=submission_accepted_count,
        submission_accepted_sum=submission_accepted_sum,
        review_count=review_count,
        review_my_score=review_my_score,
        **kwargs,
    )

BaseAdminSubmissionsTable

Bases: SingleTableMixin, FilterView

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    submissions = self.filterset_class._meta.model.objects.current().for_table(
        self.request.user
    )

    if not can_access_drafts(self.request.user):
        submissions = submissions.exclude_draft()

    return submissions

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

BatchUpdateLeadView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute

form_class = BatchUpdateSubmissionLeadForm

context_name class-attribute instance-attribute

context_name = 'batch_lead_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    new_lead = form.cleaned_data["lead"]
    submissions = form.cleaned_data["submissions"]
    services.bulk_update_lead(
        submissions=submissions,
        user=self.request.user,
        lead=new_lead,
        request=self.request,
    )
    return super().form_valid(form)

form_invalid

form_invalid(form)

Source code in hypha/apply/funds/views.py

def form_invalid(self, form):
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return super().form_invalid(form)

BatchUpdateReviewersView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute

form_class = BatchUpdateReviewersForm

context_name class-attribute instance-attribute

context_name = 'batch_reviewer_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    submissions = form.cleaned_data["submissions"]
    external_reviewers = form.cleaned_data["external_reviewers"]
    assigned_roles = {
        role: form.cleaned_data[field] for field, role in form.role_fields.items()
    }
    services.bulk_update_reviewers(
        submissions=submissions,
        external_reviewers=external_reviewers,
        assigned_roles=assigned_roles,
        user=self.request.user,
        request=self.request,
    )

    return super().form_valid(form)

form_invalid

form_invalid(form)

Source code in hypha/apply/funds/views.py

def form_invalid(self, form):
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return super().form_invalid(form)

BatchDeleteSubmissionView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute

form_class = BatchDeleteSubmissionForm

context_name class-attribute instance-attribute

context_name = 'batch_delete_submission_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    submissions = form.cleaned_data["submissions"]
    services.bulk_delete_submissions(
        submissions=submissions,
        user=self.request.user,
        request=self.request,
    )
    return super().form_valid(form)

form_invalid

form_invalid(form)

Source code in hypha/apply/funds/views.py

def form_invalid(self, form):
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return super().form_invalid(form)

BatchArchiveSubmissionView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute

form_class = BatchArchiveSubmissionForm

context_name class-attribute instance-attribute

context_name = 'batch_archive_submission_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    # If a user without archive edit access is somehow able to access batch archive submissions
    # (ie. they were looking at the submission list when permissions changed) "refresh" the page
    if not can_alter_archived_submissions(self.request.user):
        return HttpResponseRedirect(self.request.path)
    submissions = form.cleaned_data["submissions"]
    services.bulk_archive_submissions(
        submissions=submissions,
        user=self.request.user,
        request=self.request,
    )
    return super().form_valid(form)

form_invalid

form_invalid(form)

Source code in hypha/apply/funds/views.py

def form_invalid(self, form):
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return super().form_invalid(form)

BatchProgressSubmissionView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute

form_class = BatchProgressSubmissionForm

context_name class-attribute instance-attribute

context_name = 'batch_progress_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    submissions = form.cleaned_data["submissions"]
    transitions = form.cleaned_data.get("action")

    try:
        redirect = BatchDeterminationCreateView.should_redirect(
            self.request, submissions, transitions
        )
    except ValueError as e:
        messages.warning(self.request, "Could not determine: " + str(e))
        return self.form_invalid(form)
    else:
        if redirect:
            return redirect

    failed = []
    phase_changes = {}
    for submission in submissions:
        valid_actions = {
            action
            for action, _ in submission.get_actions_for_user(self.request.user)
        }
        old_phase = submission.phase
        try:
            transition = (valid_actions & set(transitions)).pop()
            submission.perform_transition(
                transition,
                self.request.user,
                request=self.request,
                notify=False,
            )
        except (PermissionDenied, KeyError):
            failed.append(submission)
        else:
            phase_changes[submission.id] = old_phase

    if failed:
        messages.warning(
            self.request,
            _("Failed to update: ")
            + ", ".join(str(submission) for submission in failed),
        )

    succeeded_submissions = submissions.exclude(
        id__in=[submission.id for submission in failed]
    )
    messenger(
        MESSAGES.BATCH_TRANSITION,
        user=self.request.user,
        request=self.request,
        sources=succeeded_submissions,
        related=phase_changes,
    )

    ready_for_review = [phase for phase in transitions if phase in review_statuses]
    if ready_for_review:
        messenger(
            MESSAGES.BATCH_READY_FOR_REVIEW,
            user=self.request.user,
            request=self.request,
            sources=succeeded_submissions.filter(status__in=ready_for_review),
        )

    return super().form_valid(form)

BaseReviewerSubmissionsTable

Bases: BaseAdminSubmissionsTable

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

table_class class-attribute instance-attribute

table_class = ReviewerSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionReviewerFilterAndSearch

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

get_queryset

get_queryset()

If use_settings variable is set for ReviewerSettings use settings parameters to filter submissions or return only reviewed_by as it was by default.

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    """
    If use_settings variable is set for ReviewerSettings use settings
    parameters to filter submissions or return only reviewed_by as it
    was by default.
    """
    reviewer_settings = ReviewerSettings.for_request(self.request)
    if reviewer_settings.use_settings:
        return (
            super()
            .get_queryset()
            .for_reviewer_settings(self.request.user, reviewer_settings)
            .order_by("-submit_time")
        )
    return super().get_queryset().reviewed_by(self.request.user)

AwaitingReviewSubmissionsListView

Bases: SingleTableMixin, ListView

model class-attribute instance-attribute

model = ApplicationSubmission

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

template_name class-attribute instance-attribute

template_name = 'funds/submissions_awaiting_review.html'

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    submissions = ApplicationSubmission.objects.in_review_for(
        self.request.user
    ).order_by("-submit_time")
    return submissions.for_table(self.request.user)

SubmissionOverviewView

Bases: BaseAdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

template_name class-attribute instance-attribute

template_name = 'funds/submissions_overview.html'

table_class class-attribute instance-attribute

table_class = SummarySubmissionsTable

table_pagination class-attribute instance-attribute

table_pagination = False

filter_action class-attribute instance-attribute

filter_action = reverse_lazy('funds:submissions:list')

search_action class-attribute instance-attribute

search_action = reverse_lazy('funds:submissions:list')

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    submissions = self.filterset_class._meta.model.objects.current().for_table(
        self.request.user
    )

    if not can_access_drafts(self.request.user):
        submissions = submissions.exclude_draft()

    return submissions

get_table_data

get_table_data()

Source code in hypha/apply/funds/views.py

def get_table_data(self):
    limit = 5
    return (
        super()
        .get_table_data()
        .order_by(F("last_update").desc(nulls_last=True))[:limit]
    )

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    limit = 6
    base_query = (
        RoundsAndLabs.objects.with_progress().active().order_by("-end_date")
    )
    can_export = can_export_submissions(self.request.user)
    open_rounds = base_query.open()[:limit]
    open_query = "?round_state=open"
    closed_rounds = base_query.closed()[:limit]
    closed_query = "?round_state=closed"
    rounds_title = "All Rounds and Labs"

    status_counts = dict(
        ApplicationSubmission.objects.current()
        .values("status")
        .annotate(
            count=Count("status"),
        )
        .values_list("status", "count")
    )

    grouped_statuses = {
        status: {
            "name": data["name"],
            "count": sum(
                status_counts.get(status, 0) for status in data["statuses"]
            ),
            "url": reverse_lazy(
                "funds:submissions:status", kwargs={"status": status}
            ),
        }
        for status, data in PHASES_MAPPING.items()
    }

    staff_flagged = self.get_staff_flagged()

    return super().get_context_data(
        open_rounds=open_rounds,
        open_query=open_query,
        can_export=can_export,
        closed_rounds=closed_rounds,
        closed_query=closed_query,
        rounds_title=rounds_title,
        status_counts=grouped_statuses,
        staff_flagged=staff_flagged,
        **kwargs,
    )

get_staff_flagged

get_staff_flagged()

Source code in hypha/apply/funds/views.py

def get_staff_flagged(self):
    qs = super().get_queryset().flagged_staff().order_by("-submit_time")
    row_attrs = dict(
        {"data-flag-type": "staff"}, **SummarySubmissionsTable._meta.row_attrs
    )

    limit = 5
    return {
        "table": SummarySubmissionsTable(
            qs[:limit],
            prefix="staff-flagged-",
            attrs={"class": "all-submissions-table flagged-table"},
            row_attrs=row_attrs,
        ),
        "display_more": qs.count() > limit,
    }

SubmissionAdminListView

SubmissionAdminListView(*args, **kwargs)

Bases: BaseAdminSubmissionsTable, DelegateableListView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

template_name class-attribute instance-attribute

template_name = 'funds/submissions.html'

form_views class-attribute instance-attribute

form_views = [BatchUpdateLeadView, BatchUpdateReviewersView, BatchProgressSubmissionView, BatchDeleteSubmissionView, BatchArchiveSubmissionView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
    }

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object_list = self.get_queryset()
    return super().post(request, *args, **kwargs)

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    archived_kwargs = {"archived": self.request.GET.get("archived", 0)}
    new_kwargs.update(archived_kwargs)
    new_kwargs.update(kwargs)
    return new_kwargs

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    if self.request.GET.get("archived"):
        # if archived is in param, let archived filter handle the queryset as per its value.
        submissions = (
            self.filterset_class._meta.model.objects.include_archive().for_table(
                self.request.user
            )
        )
    else:
        submissions = self.filterset_class._meta.model.objects.current().for_table(
            self.request.user
        )

    if not can_access_drafts(self.request.user):
        submissions = submissions.exclude_draft()

    return submissions

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    show_archive = can_view_archived_submissions(self.request.user)
    can_archive = can_bulk_archive_submissions(self.request.user)

    return super().get_context_data(
        show_archive=show_archive,
        can_bulk_archive=can_archive,
        **kwargs,
    )

GroupingApplicationsListView

Bases: TemplateView

Template view for grouped submissions

template_name class-attribute instance-attribute

template_name = 'funds/grouped_application_list.html'

SubmissionReviewerListView

Bases: BaseReviewerSubmissionsTable

table_class class-attribute instance-attribute

table_class = ReviewerSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionReviewerFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

template_name class-attribute instance-attribute

template_name = 'funds/submissions.html'

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_queryset

get_queryset()

If use_settings variable is set for ReviewerSettings use settings parameters to filter submissions or return only reviewed_by as it was by default.

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    """
    If use_settings variable is set for ReviewerSettings use settings
    parameters to filter submissions or return only reviewed_by as it
    was by default.
    """
    reviewer_settings = ReviewerSettings.for_request(self.request)
    if reviewer_settings.use_settings:
        return (
            super()
            .get_queryset()
            .for_reviewer_settings(self.request.user, reviewer_settings)
            .order_by("-submit_time")
        )
    return super().get_queryset().reviewed_by(self.request.user)

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

SubmissionListView

Bases: ViewDispatcher

partner_view class-attribute instance-attribute

partner_view = None

community_view class-attribute instance-attribute

community_view = None

applicant_view class-attribute instance-attribute

applicant_view = None

finance_view class-attribute instance-attribute

finance_view = None

contracting_view class-attribute instance-attribute

contracting_view = None

admin_view class-attribute instance-attribute

admin_view = SubmissionAdminListView

reviewer_view class-attribute instance-attribute

reviewer_view = SubmissionReviewerListView

admin_check

admin_check(request)

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

def admin_check(self, request):
    return request.user.is_apply_staff

reviewer_check

reviewer_check(request)

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

def reviewer_check(self, request):
    return request.user.is_reviewer

partner_check

partner_check(request)

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

def partner_check(self, request):
    return request.user.is_partner

community_check

community_check(request)

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

def community_check(self, request):
    return request.user.is_community_reviewer

finance_check

finance_check(request)

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

def finance_check(self, request):
    return request.user.is_finance

contracting_check

contracting_check(request)

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

def contracting_check(self, request):
    return request.user.is_contracting

applicant_check

applicant_check(request)

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

def applicant_check(self, request):
    return request.user.is_applicant

dispatch

dispatch(request, *args, **kwargs)

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

def dispatch(self, request, *args, **kwargs):
    view = None

    if self.admin_check(request):
        view = self.admin_view
    elif self.reviewer_check(request):
        view = self.reviewer_view
    elif self.partner_check(request):
        view = self.partner_view
    elif self.community_check(request):
        view = self.community_view
    elif self.finance_check(request):
        view = self.finance_view
    elif self.contracting_check(request):
        view = self.contracting_view
    elif self.applicant_check(request):
        view = self.applicant_view

    if view:
        return view.as_view()(request, *args, **kwargs)
    return HttpResponseForbidden()

SubmissionStaffFlaggedView

Bases: BaseAdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

table_class class-attribute instance-attribute

table_class = StaffFlaggedSubmissionsTable

template_name class-attribute instance-attribute

template_name = 'funds/submissions_staff_flagged.html'

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    return (
        self.filterset_class._meta.model.objects.current()
        .for_table(self.request.user)
        .flagged_staff()
        .order_by("-submit_time")
    )

SubmissionUserFlaggedView

Bases: UserPassesTestMixin, BaseAdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

table_class class-attribute instance-attribute

table_class = UserFlaggedSubmissionsTable

template_name class-attribute instance-attribute

template_name = 'funds/submissions_user_flagged.html'

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    return (
        self.filterset_class._meta.model.objects.current()
        .for_table(self.request.user)
        .flagged_by(self.request.user)
        .order_by("-submit_time")
    )

test_func

test_func()

Source code in hypha/apply/funds/views.py

def test_func(self):
    return self.request.user.is_apply_staff or self.request.user.is_reviewer

ExportSubmissionsByRound

Bases: UserPassesTestMixin, BaseAdminSubmissionsTable

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        search_action=self.search_action,
        filter_action=self.filter_action,
        **kwargs,
    )

export_submissions

export_submissions(round_id)

Source code in hypha/apply/funds/views.py

def export_submissions(self, round_id):
    csv_stream = StringIO()
    writer = csv.writer(csv_stream)
    header_row, values = [], []
    index = 0
    check = False

    for submission in ApplicationSubmission.objects.filter(round=round_id):
        for field_id in submission.question_text_field_ids:
            question_field = submission.serialize(field_id)
            field_name = question_field["question"]
            field_value = question_field["answer"]
            if field_id not in submission.named_blocks:
                header_row.append(field_name) if not check else header_row
                values.append(field_value)
            else:
                header_row.insert(index, field_name) if not check else header_row
                values.insert(index, field_value)
                index = index + 1

        if not check:
            writer.writerow(header_row)
            check = True

        writer.writerow(values)
        values.clear()
        index = 0

    csv_stream.seek(0)
    return csv_stream

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    try:
        self.obj = Page.objects.get(pk=self.kwargs.get("pk")).specific
    except Page.DoesNotExist as exc:
        raise Http404(_("No Round or Lab found matching the query")) from exc

    if not isinstance(self.obj, (LabBase, RoundBase)):
        raise Http404(_("No Round or Lab found matching the query"))
    return super().get_queryset().filter(Q(round=self.obj) | Q(page=self.obj))

get

get(request, pk)

Source code in hypha/apply/funds/views.py

def get(self, request, pk):
    self.get_queryset()
    csv_data = self.export_submissions(pk)
    response = HttpResponse(csv_data.readlines(), content_type="text/csv")
    response["Content-Disposition"] = "inline; filename=" + str(self.obj) + ".csv"
    return response

test_func

test_func()

Source code in hypha/apply/funds/views.py

def test_func(self):
    return can_export_submissions(self.request.user)

SubmissionsByRound

SubmissionsByRound(*args, **kwargs)

Bases: BaseAdminSubmissionsTable, DelegateableListView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded property

excluded

template_name class-attribute instance-attribute

template_name = 'funds/submissions_by_round.html'

form_views class-attribute instance-attribute

form_views = [BatchUpdateLeadView, BatchUpdateReviewersView, BatchProgressSubmissionView, BatchDeleteSubmissionView, BatchArchiveSubmissionView]

excluded_fields class-attribute instance-attribute

excluded_fields = ['round', 'fund'] + SUBMISSIONS_TABLE_EXCLUDED_FIELDS

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object_list = self.get_queryset()
    return super().post(request, *args, **kwargs)

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_form_kwargs

get_form_kwargs()

Source code in hypha/apply/funds/views.py

def get_form_kwargs(self):
    kwargs = super().get_form_kwargs()
    kwargs["round"] = self.obj
    return kwargs

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    # We want to only show lab or Rounds in this view, their base class is Page
    try:
        self.obj = Page.objects.get(pk=self.kwargs.get("pk")).specific
    except Page.DoesNotExist as e:
        raise Http404(_("No Round or Lab found matching the query")) from e

    if not isinstance(self.obj, (LabBase, RoundBase)):
        raise Http404(_("No Round or Lab found matching the query"))
    return super().get_queryset().filter(Q(round=self.obj) | Q(page=self.obj))

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(object=self.obj, **kwargs)

SubmissionsByStatus

SubmissionsByStatus(*args, **kwargs)

Bases: BaseAdminSubmissionsTable, DelegateableListView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

table_class class-attribute instance-attribute

table_class = AdminSubmissionsTable

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

search_action class-attribute instance-attribute

search_action = ''

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

template_name class-attribute instance-attribute

template_name = 'funds/submissions_by_status.html'

status_mapping class-attribute instance-attribute

status_mapping = PHASES_MAPPING

form_views class-attribute instance-attribute

form_views = [BatchUpdateLeadView, BatchUpdateReviewersView, BatchProgressSubmissionView, BatchDeleteSubmissionView, BatchArchiveSubmissionView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
    }

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object_list = self.get_queryset()
    return super().post(request, *args, **kwargs)

get_table_kwargs

get_table_kwargs(**kwargs)

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self, **kwargs):
    return {**self.excluded, **kwargs}

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    self.status = kwargs.get("status")
    try:
        status_data = self.status_mapping[self.status]
    except KeyError:
        raise Http404(_("No statuses match the requested value")) from None
    self.status_name = status_data["name"]
    self.statuses = status_data["statuses"]
    return super().dispatch(request, *args, **kwargs)

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    return super().get_filterset_kwargs(
        filterset_class, limit_statuses=self.statuses, **kwargs
    )

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    return super().get_queryset().filter(status__in=self.statuses)

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(
        status=self.status_name,
        statuses=self.statuses,
        **kwargs,
    )

ProgressSubmissionView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = ProgressSubmissionForm

context_name class-attribute instance-attribute

context_name = 'progress_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(ProgressSubmissionView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    action = form.cleaned_data.get("action")
    # Defer to the determination form for any of the determination transitions
    redirect = DeterminationCreateOrUpdateView.should_redirect(
        self.request, self.object, action
    )
    if redirect:
        return redirect

    self.object.perform_transition(action, self.request.user, request=self.request)
    return super().form_valid(form)

CreateProjectView

Bases: DelegatedViewMixin, CreateView

context_name class-attribute instance-attribute

context_name = 'project_form'

form_class class-attribute instance-attribute

form_class = CreateProjectForm

model class-attribute instance-attribute

model = Project

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_parent_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(CreateProjectView, self).dispatch(request, *args, **kwargs)

get_success_url

get_success_url()

Source code in hypha/apply/funds/views.py

def get_success_url(self):
    return self.object.get_absolute_url()

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    response = super().form_valid(form)
    messenger(
        MESSAGES.CREATED_PROJECT,
        request=self.request,
        user=self.request.user,
        source=self.object,
        related=self.object.submission,
    )
    # add task for staff to add PAF to the project
    add_task_to_user_group(
        code=PROJECT_WAITING_PAF,
        user_group=Group.objects.filter(name=STAFF_GROUP_NAME),
        related_obj=self.object,
    )
    return response

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    context["action_message"] = _("Project Created!")
    return context

ScreeningSubmissionView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = ScreeningSubmissionForm

context_name class-attribute instance-attribute

context_name = 'screening_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(ScreeningSubmissionView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    old = copy(self.get_object())
    response = super().form_valid(form)
    # Record activity
    messenger(
        MESSAGES.SCREENING,
        request=self.request,
        user=self.request.user,
        source=self.object,
        related=", ".join([s.title for s in old.screening_statuses.all()]),
    )
    return response

UnarchiveSubmissionView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = UnarchiveSubmissionForm

context_name class-attribute instance-attribute

context_name = 'unarchive_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    # If a user without archive edit access is somehow able to access "Unarchive Submission"
    # (ie. they were looking at the submission when permissions changed) "refresh" the page
    if not can_alter_archived_submissions(self.request.user):
        return HttpResponseRedirect(self.request.path)
    response = super().form_valid(form)
    # Record activity
    messenger(
        MESSAGES.UNARCHIVE_SUBMISSION,
        request=self.request,
        user=self.request.user,
        source=self.object,
    )
    return response

get_success_url

get_success_url()

Source code in hypha/apply/funds/views.py

def get_success_url(self):
    return self.object.get_absolute_url()

ArchiveSubmissionView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = ArchiveSubmissionForm

context_name class-attribute instance-attribute

context_name = 'archive_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    # If a user without archive edit access is somehow able to access "Archive Submission"
    # (ie. they were looking at the submission when permissions changed) "refresh" the page
    if not can_alter_archived_submissions(self.request.user):
        return HttpResponseRedirect(self.request.path)
    response = super().form_valid(form)
    submission = self.get_object()
    # Record activity
    messenger(
        MESSAGES.ARCHIVE_SUBMISSION,
        request=self.request,
        user=self.request.user,
        source=submission,
    )
    return response

get_success_url

get_success_url()

Source code in hypha/apply/funds/views.py

def get_success_url(self):
    return self.object.get_absolute_url()

UpdateLeadView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = UpdateSubmissionLeadForm

context_name class-attribute instance-attribute

context_name = 'lead_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(UpdateLeadView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    # Fetch the old lead from the database
    old = copy(self.get_object())
    response = super().form_valid(form)
    messenger(
        MESSAGES.UPDATE_LEAD,
        request=self.request,
        user=self.request.user,
        source=form.instance,
        related=old.lead,
    )
    return response

UpdateReviewersView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = UpdateReviewersForm

context_name class-attribute instance-attribute

context_name = 'reviewer_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(UpdateReviewersView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    old_reviewers = {copy(reviewer) for reviewer in form.instance.assigned.all()}
    response = super().form_valid(form)

    new_reviewers = set(form.instance.assigned.all())
    added = new_reviewers - old_reviewers
    removed = old_reviewers - new_reviewers

    messenger(
        MESSAGES.REVIEWERS_UPDATED,
        request=self.request,
        user=self.request.user,
        source=self.kwargs["object"],
        added=added,
        removed=removed,
    )

    # Update submission status if needed.
    services.set_status_after_reviewers_assigned(
        submission=form.instance, updated_by=self.request.user, request=self.request
    )

    return response

UpdatePartnersView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = UpdatePartnersForm

context_name class-attribute instance-attribute

context_name = 'partner_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(UpdatePartnersView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    old_partners = set(self.get_object().partners.all())
    response = super().form_valid(form)
    new_partners = set(form.instance.partners.all())

    added = new_partners - old_partners
    removed = old_partners - new_partners

    messenger(
        MESSAGES.PARTNERS_UPDATED,
        request=self.request,
        user=self.request.user,
        source=self.kwargs["object"],
        added=added,
        removed=removed,
    )

    messenger(
        MESSAGES.PARTNERS_UPDATED_PARTNER,
        request=self.request,
        user=self.request.user,
        source=self.kwargs["object"],
        added=added,
        removed=removed,
    )

    return response

UpdateMetaTermsView

Bases: DelegatedViewMixin, UpdateView

model class-attribute instance-attribute

model = ApplicationSubmission

form_class class-attribute instance-attribute

form_class = UpdateMetaTermsForm

context_name class-attribute instance-attribute

context_name = 'meta_terms_form'

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(UpdateMetaTermsView, self).dispatch(request, *args, **kwargs)

ReminderCreateView

Bases: DelegatedViewMixin, CreateView

context_name class-attribute instance-attribute

context_name = 'reminder_form'

form_class class-attribute instance-attribute

form_class = CreateReminderForm

model class-attribute instance-attribute

model = Reminder

setup

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

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

def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object

get_object()

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

def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names

get_template_names()

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

def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name

get_form_name()

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

def get_form_name(self):
    return self.context_name

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs

get_parent_kwargs()

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

def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object

get_parent_object()

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

def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form

get_form(*args, **kwargs)

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

def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data

get_context_data(**kwargs)

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

def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod

is_model_form()

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

@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form

contribute_form(parent)

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

def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url

get_success_url()

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

def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_parent_object()
    permission, reason = has_permission(
        "submission_edit", request.user, object=submission, raise_exception=False
    )
    if not permission:
        messages.warning(self.request, reason)
        return HttpResponseRedirect(submission.get_absolute_url())
    return super(ReminderCreateView, self).dispatch(request, *args, **kwargs)

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    response = super().form_valid(form)

    messenger(
        MESSAGES.CREATE_REMINDER,
        request=self.request,
        user=self.request.user,
        source=self.object.submission,
        related=self.object,
    )

    return response

ReminderDeleteView

Bases: DeleteView

model class-attribute instance-attribute

model = Reminder

get_success_url

get_success_url()

Source code in hypha/apply/funds/views.py

def get_success_url(self):
    submission = get_object_or_404(
        ApplicationSubmission, id=self.kwargs["submission_pk"]
    )
    return reverse_lazy("funds:submissions:detail", args=(submission.id,))

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    reminder = self.get_object()
    messenger(
        MESSAGES.DELETE_REMINDER,
        user=self.request.user,
        request=self.request,
        source=reminder.submission,
        related=reminder,
    )
    return super().form_valid(form)

AdminSubmissionDetailView

AdminSubmissionDetailView(*args, **kwargs)

Bases: ActivityContextMixin, DelegateableView, DetailView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

template_name_suffix class-attribute instance-attribute

template_name_suffix = '_admin_detail'

model class-attribute instance-attribute

model = ApplicationSubmission

form_views class-attribute instance-attribute

form_views = [ArchiveSubmissionView, ProgressSubmissionView, ScreeningSubmissionView, ReminderCreateView, CommentFormView, UpdateLeadView, UpdateReviewersView, UpdatePartnersView, CreateProjectView, UpdateMetaTermsView, UnarchiveSubmissionView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    if submission.status == DRAFT_STATE and not submission.can_view_draft(
        request.user
    ):
        raise Http404
    permission, _ = has_permission(
        "submission_view", request.user, object=submission, raise_exception=True
    )
    redirect = SubmissionSealedView.should_redirect(request, submission)
    return redirect or super().dispatch(request, *args, **kwargs)

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    other_submissions = (
        self.model.objects.filter(user=self.object.user)
        .current()
        .exclude(id=self.object.id)
    )
    if self.object.next:
        other_submissions = other_submissions.exclude(id=self.object.next.id)

    default_screening_statuses = get_default_screening_statues()

    return super().get_context_data(
        other_submissions=other_submissions,
        default_screening_statuses=default_screening_statuses,
        archive_access_groups=get_archive_view_groups(),
        can_archive=can_alter_archived_submissions(self.request.user),
        **kwargs,
    )

ReviewerSubmissionDetailView

ReviewerSubmissionDetailView(*args, **kwargs)

Bases: ActivityContextMixin, DelegateableView, DetailView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

template_name_suffix class-attribute instance-attribute

template_name_suffix = '_reviewer_detail'

model class-attribute instance-attribute

model = ApplicationSubmission

form_views class-attribute instance-attribute

form_views = [CommentFormView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/activity/views.py

def get_context_data(self, **kwargs):
    extra = {
        # Do not prefetch on the related_object__author as the models
        # are not homogeneous and this will fail
        "comments": get_related_comments_for_user(self.object, self.request.user)
    }
    return super().get_context_data(**extra, **kwargs)

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    # If the requesting user submitted the application, return the Applicant view.
    # Reviewers may sometimes be applicants as well.
    if submission.user == request.user:
        return ApplicantSubmissionDetailView.as_view()(request, *args, **kwargs)
    if submission.status == DRAFT_STATE:
        raise Http404

    permission, _ = has_permission(
        "submission_view", request.user, object=submission, raise_exception=True
    )

    reviewer_settings = ReviewerSettings.for_request(request)
    if reviewer_settings.use_settings:
        queryset = ApplicationSubmission.objects.for_reviewer_settings(
            request.user, reviewer_settings
        )
        # Reviewer can't view submission which is not listed in ReviewerSubmissionsTable
        if not queryset.filter(id=submission.id).exists():
            raise PermissionDenied

    return super().dispatch(request, *args, **kwargs)

PartnerSubmissionDetailView

PartnerSubmissionDetailView(*args, **kwargs)

Bases: ActivityContextMixin, DelegateableView, DetailView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

model class-attribute instance-attribute

model = ApplicationSubmission

form_views class-attribute instance-attribute

form_views = [CommentFormView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/activity/views.py

def get_context_data(self, **kwargs):
    extra = {
        # Do not prefetch on the related_object__author as the models
        # are not homogeneous and this will fail
        "comments": get_related_comments_for_user(self.object, self.request.user)
    }
    return super().get_context_data(**extra, **kwargs)

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

get_object

get_object()

Source code in hypha/apply/funds/views.py

def get_object(self):
    return super().get_object().from_draft()

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, _ = has_permission(
        "submission_view", request.user, object=submission, raise_exception=True
    )
    # If the requesting user submitted the application, return the Applicant view.
    # Partners may sometimes be applicants as well.
    if submission.user == request.user:
        return ApplicantSubmissionDetailView.as_view()(request, *args, **kwargs)
    # Only allow partners in the submission they are added as partners
    partner_has_access = submission.partners.filter(pk=request.user.pk).exists()
    if not partner_has_access:
        raise PermissionDenied
    if submission.status == DRAFT_STATE:
        raise Http404
    return super().dispatch(request, *args, **kwargs)

CommunitySubmissionDetailView

CommunitySubmissionDetailView(*args, **kwargs)

Bases: ActivityContextMixin, DelegateableView, DetailView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

template_name_suffix class-attribute instance-attribute

template_name_suffix = '_community_detail'

model class-attribute instance-attribute

model = ApplicationSubmission

form_views class-attribute instance-attribute

form_views = [CommentFormView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/activity/views.py

def get_context_data(self, **kwargs):
    extra = {
        # Do not prefetch on the related_object__author as the models
        # are not homogeneous and this will fail
        "comments": get_related_comments_for_user(self.object, self.request.user)
    }
    return super().get_context_data(**extra, **kwargs)

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, _ = has_permission(
        "submission_view", request.user, object=submission, raise_exception=True
    )
    # If the requesting user submitted the application, return the Applicant view.
    # Reviewers may sometimes be applicants as well.
    if submission.user == request.user:
        return ApplicantSubmissionDetailView.as_view()(request, *args, **kwargs)
    # Only allow community reviewers in submission with a community review state.
    if not submission.community_review:
        raise PermissionDenied
    if submission.status == DRAFT_STATE:
        raise Http404
    return super().dispatch(request, *args, **kwargs)

ApplicantSubmissionDetailView

ApplicantSubmissionDetailView(*args, **kwargs)

Bases: ActivityContextMixin, DelegateableView, DetailView

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

def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_prefix class-attribute instance-attribute

form_prefix = 'form-submitted-'

model class-attribute instance-attribute

model = ApplicationSubmission

form_views class-attribute instance-attribute

form_views = [CommentFormView]

get_form_kwargs

get_form_kwargs()

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

def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/activity/views.py

def get_context_data(self, **kwargs):
    extra = {
        # Do not prefetch on the related_object__author as the models
        # are not homogeneous and this will fail
        "comments": get_related_comments_for_user(self.object, self.request.user)
    }
    return super().get_context_data(**extra, **kwargs)

post

post(request, *args, **kwargs)

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

def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

get_object

get_object()

Source code in hypha/apply/funds/views.py

def get_object(self):
    return super().get_object().from_draft()

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    permission, _ = has_permission(
        "submission_view", request.user, object=submission, raise_exception=True
    )
    # This view is only for applicants.
    if submission.user != request.user:
        raise PermissionDenied
    return super().dispatch(request, *args, **kwargs)

SubmissionDetailView

Bases: ViewDispatcher

finance_view class-attribute instance-attribute

finance_view = None

contracting_view class-attribute instance-attribute

contracting_view = None

admin_view class-attribute instance-attribute

admin_view = AdminSubmissionDetailView

reviewer_view class-attribute instance-attribute

reviewer_view = ReviewerSubmissionDetailView

partner_view class-attribute instance-attribute

partner_view = PartnerSubmissionDetailView

community_view class-attribute instance-attribute

community_view = CommunitySubmissionDetailView

applicant_view class-attribute instance-attribute

applicant_view = ApplicantSubmissionDetailView

admin_check

admin_check(request)

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

def admin_check(self, request):
    return request.user.is_apply_staff

reviewer_check

reviewer_check(request)

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

def reviewer_check(self, request):
    return request.user.is_reviewer

partner_check

partner_check(request)

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

def partner_check(self, request):
    return request.user.is_partner

community_check

community_check(request)

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

def community_check(self, request):
    return request.user.is_community_reviewer

finance_check

finance_check(request)

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

def finance_check(self, request):
    return request.user.is_finance

contracting_check

contracting_check(request)

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

def contracting_check(self, request):
    return request.user.is_contracting

applicant_check

applicant_check(request)

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

def applicant_check(self, request):
    return request.user.is_applicant

dispatch

dispatch(request, *args, **kwargs)

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

def dispatch(self, request, *args, **kwargs):
    view = None

    if self.admin_check(request):
        view = self.admin_view
    elif self.reviewer_check(request):
        view = self.reviewer_view
    elif self.partner_check(request):
        view = self.partner_view
    elif self.community_check(request):
        view = self.community_view
    elif self.finance_check(request):
        view = self.finance_view
    elif self.contracting_check(request):
        view = self.contracting_view
    elif self.applicant_check(request):
        view = self.applicant_view

    if view:
        return view.as_view()(request, *args, **kwargs)
    return HttpResponseForbidden()

SubmissionSealedView

Bases: DetailView

template_name class-attribute instance-attribute

template_name = 'funds/submission_sealed.html'

model class-attribute instance-attribute

model = ApplicationSubmission

get

get(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def get(self, request, *args, **kwargs):
    submission = self.get_object()
    if not self.round_is_sealed(submission):
        return self.redirect_detail(submission)
    return super().get(request, *args, **kwargs)

post

post(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def post(self, request, *args, **kwargs):
    submission = self.get_object()
    if self.can_view_sealed(request.user):
        self.peeked(submission)
    return self.redirect_detail(submission)

redirect_detail

redirect_detail(submission)

Source code in hypha/apply/funds/views.py

def redirect_detail(self, submission):
    return HttpResponseRedirect(
        reverse_lazy("funds:submissions:detail", args=(submission.id,))
    )

peeked

peeked(submission)

Source code in hypha/apply/funds/views.py

def peeked(self, submission):
    messenger(
        MESSAGES.OPENED_SEALED,
        request=self.request,
        user=self.request.user,
        source=submission,
    )
    self.request.session.setdefault("peeked", {})[str(submission.id)] = True
    # Dictionary updates do not trigger session saves. Force update
    self.request.session.modified = True

can_view_sealed

can_view_sealed(user)

Source code in hypha/apply/funds/views.py

def can_view_sealed(self, user):
    return user.is_superuser

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(
        can_view_sealed=self.can_view_sealed(self.request.user),
        **kwargs,
    )

round_is_sealed classmethod

round_is_sealed(submission)

Source code in hypha/apply/funds/views.py

@classmethod
def round_is_sealed(cls, submission):
    try:
        return submission.round.specific.is_sealed
    except AttributeError:
        # Its a lab - cant be sealed
        return False

has_peeked classmethod

has_peeked(request, submission)

Source code in hypha/apply/funds/views.py

@classmethod
def has_peeked(cls, request, submission):
    return str(submission.id) in request.session.get("peeked", {})

should_redirect classmethod

should_redirect(request, submission)

Source code in hypha/apply/funds/views.py

@classmethod
def should_redirect(cls, request, submission):
    if cls.round_is_sealed(submission) and not cls.has_peeked(request, submission):
        return HttpResponseRedirect(
            reverse_lazy("funds:submissions:sealed", args=(submission.id,))
        )

BaseSubmissionEditView

Bases: UpdateView

Converts the data held on the submission into an editable format and knows how to save that back to the object. Shortcuts the normal update view save approach

model class-attribute instance-attribute

model = ApplicationSubmission

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    permission, _ = has_permission(
        "submission_edit",
        request.user,
        object=self.get_object(),
        raise_exception=True,
    )
    if not self.get_object().phase.permissions.can_edit(request.user):
        raise PermissionDenied
    return super().dispatch(request, *args, **kwargs)

buttons

buttons()

Source code in hypha/apply/funds/views.py

def buttons(self):
    if settings.SUBMISSION_PREVIEW_REQUIRED:
        yield ("preview", "primary", _("Preview and submit"))
        yield ("save", "white", _("Save draft"))
    else:
        yield ("submit", "primary", _("Submit"))
        yield ("save", "white", _("Save draft"))

get_form_kwargs

get_form_kwargs()

Returns the keyword arguments for instantiating the form.

This method is called by the form mixin during form instantiation. It returns a dictionary of keyword arguments that will be passed to the form's constructor.

Returns:

• dict –

  A dictionary of keyword arguments for the form constructor.

Source code in hypha/apply/funds/views.py

def get_form_kwargs(self):
    """
    Returns the keyword arguments for instantiating the form.

    This method is called by the form mixin during form instantiation.
    It returns a dictionary of keyword arguments that will be passed to
    the form's constructor.

    Returns:
        dict: A dictionary of keyword arguments for the form constructor.
    """
    kwargs = super().get_form_kwargs()
    instance = kwargs.pop("instance").from_draft()
    initial = instance.raw_data
    for field_id in instance.file_field_ids:
        initial.pop(field_id + "-uploads", False)
        initial[field_id] = self.get_placeholder_file(
            instance.raw_data.get(field_id)
        )
    kwargs["initial"] = initial
    return kwargs

get_placeholder_file

get_placeholder_file(initial_file)

Source code in hypha/apply/funds/views.py

def get_placeholder_file(self, 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
    ]

save_draft_and_refresh_page

save_draft_and_refresh_page(form)

Source code in hypha/apply/funds/views.py

def save_draft_and_refresh_page(self, form) -> HttpResponseRedirect:
    self.object.create_revision(draft=True, by=self.request.user)
    form.delete_temporary_files()
    messages.success(self.request, _("Draft saved"))
    return HttpResponseRedirect(
        reverse_lazy("funds:submissions:edit", args=(self.object.id,))
    )

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(buttons=self.buttons(), **kwargs)

get_form_class

get_form_class()

Returns the form class for the view.

This method is called by the view during form instantiation. It returns the form class that will be used to render the form.

When trying to save as draft, this method will return a version of form class that doesn't validate required fields while saving.

The method also disables any group toggle fields in the form, as they are not supported on edit forms.

Returns:

• class –

  The form class for the view.

Source code in hypha/apply/funds/views.py

def get_form_class(self):
    """
    Returns the form class for the view.

    This method is called by the view during form instantiation. It returns
    the form class that will be used to render the form.

    When trying to save as draft, this method will return a version of form
    class that doesn't validate required fields while saving.

    The method also disables any group toggle fields in the form, as they
    are not supported on edit forms.

    Returns:
        class: The form class for the view.
    """
    is_draft = True if "save" in self.request.POST else False
    form_fields = self.object.get_form_fields(
        draft=is_draft, form_data=self.object.raw_data, user=self.request.user
    )
    field_blocks = self.object.get_defined_fields()
    for field_block in field_blocks:
        if isinstance(field_block.block, GroupToggleBlock):
            # Disable group toggle field as it is not supported on edit forms.
            form_fields[field_block.id].disabled = True
    return type(
        "WagtailStreamForm", (self.object.submission_form_class,), form_fields
    )

AdminSubmissionEditView

Bases: BaseSubmissionEditView

model class-attribute instance-attribute

model = ApplicationSubmission

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    permission, _ = has_permission(
        "submission_edit",
        request.user,
        object=self.get_object(),
        raise_exception=True,
    )
    if not self.get_object().phase.permissions.can_edit(request.user):
        raise PermissionDenied
    return super().dispatch(request, *args, **kwargs)

buttons

buttons()

Source code in hypha/apply/funds/views.py

def buttons(self):
    if settings.SUBMISSION_PREVIEW_REQUIRED:
        yield ("preview", "primary", _("Preview and submit"))
        yield ("save", "white", _("Save draft"))
    else:
        yield ("submit", "primary", _("Submit"))
        yield ("save", "white", _("Save draft"))

get_form_kwargs

get_form_kwargs()

Returns the keyword arguments for instantiating the form.

This method is called by the form mixin during form instantiation. It returns a dictionary of keyword arguments that will be passed to the form's constructor.

Returns:

• dict –

  A dictionary of keyword arguments for the form constructor.

Source code in hypha/apply/funds/views.py

def get_form_kwargs(self):
    """
    Returns the keyword arguments for instantiating the form.

    This method is called by the form mixin during form instantiation.
    It returns a dictionary of keyword arguments that will be passed to
    the form's constructor.

    Returns:
        dict: A dictionary of keyword arguments for the form constructor.
    """
    kwargs = super().get_form_kwargs()
    instance = kwargs.pop("instance").from_draft()
    initial = instance.raw_data
    for field_id in instance.file_field_ids:
        initial.pop(field_id + "-uploads", False)
        initial[field_id] = self.get_placeholder_file(
            instance.raw_data.get(field_id)
        )
    kwargs["initial"] = initial
    return kwargs

get_placeholder_file

get_placeholder_file(initial_file)

Source code in hypha/apply/funds/views.py

def get_placeholder_file(self, 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
    ]

save_draft_and_refresh_page

save_draft_and_refresh_page(form)

Source code in hypha/apply/funds/views.py

def save_draft_and_refresh_page(self, form) -> HttpResponseRedirect:
    self.object.create_revision(draft=True, by=self.request.user)
    form.delete_temporary_files()
    messages.success(self.request, _("Draft saved"))
    return HttpResponseRedirect(
        reverse_lazy("funds:submissions:edit", args=(self.object.id,))
    )

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(buttons=self.buttons(), **kwargs)

get_form_class

get_form_class()

Returns the form class for the view.

This method is called by the view during form instantiation. It returns the form class that will be used to render the form.

When trying to save as draft, this method will return a version of form class that doesn't validate required fields while saving.

The method also disables any group toggle fields in the form, as they are not supported on edit forms.

Returns:

• class –

  The form class for the view.

Source code in hypha/apply/funds/views.py

def get_form_class(self):
    """
    Returns the form class for the view.

    This method is called by the view during form instantiation. It returns
    the form class that will be used to render the form.

    When trying to save as draft, this method will return a version of form
    class that doesn't validate required fields while saving.

    The method also disables any group toggle fields in the form, as they
    are not supported on edit forms.

    Returns:
        class: The form class for the view.
    """
    is_draft = True if "save" in self.request.POST else False
    form_fields = self.object.get_form_fields(
        draft=is_draft, form_data=self.object.raw_data, user=self.request.user
    )
    field_blocks = self.object.get_defined_fields()
    for field_block in field_blocks:
        if isinstance(field_block.block, GroupToggleBlock):
            # Disable group toggle field as it is not supported on edit forms.
            form_fields[field_block.id].disabled = True
    return type(
        "WagtailStreamForm", (self.object.submission_form_class,), form_fields
    )

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    self.object.new_data(form.cleaned_data)

    if "save" in self.request.POST:
        return self.save_draft_and_refresh_page(form=form)

    if "submit" in self.request.POST:
        revision = self.object.create_revision(by=self.request.user)
        if revision:
            messenger(
                MESSAGES.EDIT_SUBMISSION,
                request=self.request,
                user=self.request.user,
                source=self.object,
                related=revision,
            )

    # Required for django-file-form: delete temporary files for the new files
    # uploaded while edit.
    form.delete_temporary_files()
    return HttpResponseRedirect(self.get_success_url())

ApplicantSubmissionEditView

Bases: BaseSubmissionEditView

model class-attribute instance-attribute

model = ApplicationSubmission

transitions property

transitions

buttons

buttons()

Source code in hypha/apply/funds/views.py

def buttons(self):
    if settings.SUBMISSION_PREVIEW_REQUIRED:
        yield ("preview", "primary", _("Preview and submit"))
        yield ("save", "white", _("Save draft"))
    else:
        yield ("submit", "primary", _("Submit"))
        yield ("save", "white", _("Save draft"))

get_form_kwargs

get_form_kwargs()

Returns the keyword arguments for instantiating the form.

This method is called by the form mixin during form instantiation. It returns a dictionary of keyword arguments that will be passed to the form's constructor.

Returns:

• dict –

  A dictionary of keyword arguments for the form constructor.

Source code in hypha/apply/funds/views.py

def get_form_kwargs(self):
    """
    Returns the keyword arguments for instantiating the form.

    This method is called by the form mixin during form instantiation.
    It returns a dictionary of keyword arguments that will be passed to
    the form's constructor.

    Returns:
        dict: A dictionary of keyword arguments for the form constructor.
    """
    kwargs = super().get_form_kwargs()
    instance = kwargs.pop("instance").from_draft()
    initial = instance.raw_data
    for field_id in instance.file_field_ids:
        initial.pop(field_id + "-uploads", False)
        initial[field_id] = self.get_placeholder_file(
            instance.raw_data.get(field_id)
        )
    kwargs["initial"] = initial
    return kwargs

get_placeholder_file

get_placeholder_file(initial_file)

Source code in hypha/apply/funds/views.py

def get_placeholder_file(self, 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
    ]

save_draft_and_refresh_page

save_draft_and_refresh_page(form)

Source code in hypha/apply/funds/views.py

def save_draft_and_refresh_page(self, form) -> HttpResponseRedirect:
    self.object.create_revision(draft=True, by=self.request.user)
    form.delete_temporary_files()
    messages.success(self.request, _("Draft saved"))
    return HttpResponseRedirect(
        reverse_lazy("funds:submissions:edit", args=(self.object.id,))
    )

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(buttons=self.buttons(), **kwargs)

get_form_class

get_form_class()

Returns the form class for the view.

This method is called by the view during form instantiation. It returns the form class that will be used to render the form.

When trying to save as draft, this method will return a version of form class that doesn't validate required fields while saving.

The method also disables any group toggle fields in the form, as they are not supported on edit forms.

Returns:

• class –

  The form class for the view.

Source code in hypha/apply/funds/views.py

def get_form_class(self):
    """
    Returns the form class for the view.

    This method is called by the view during form instantiation. It returns
    the form class that will be used to render the form.

    When trying to save as draft, this method will return a version of form
    class that doesn't validate required fields while saving.

    The method also disables any group toggle fields in the form, as they
    are not supported on edit forms.

    Returns:
        class: The form class for the view.
    """
    is_draft = True if "save" in self.request.POST else False
    form_fields = self.object.get_form_fields(
        draft=is_draft, form_data=self.object.raw_data, user=self.request.user
    )
    field_blocks = self.object.get_defined_fields()
    for field_block in field_blocks:
        if isinstance(field_block.block, GroupToggleBlock):
            # Disable group toggle field as it is not supported on edit forms.
            form_fields[field_block.id].disabled = True
    return type(
        "WagtailStreamForm", (self.object.submission_form_class,), form_fields
    )

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    if request.user != submission.user:
        raise PermissionDenied
    return super().dispatch(request, *args, **kwargs)

get_object_fund_current_round

get_object_fund_current_round()

Source code in hypha/apply/funds/views.py

def get_object_fund_current_round(self):
    assigned_fund = self.object.round.get_parent().specific
    if assigned_fund.open_round:
        return assigned_fund.open_round
    return False

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    self.object.new_data(form.cleaned_data)

    # Update submit_time only when application is getting submitted from the Draft State for the first time.
    if self.object.status == DRAFT_STATE and "submit" in self.request.POST:
        self.object.submit_time = timezone.now()
        if self.object.round:
            current_round = self.get_object_fund_current_round()
            if current_round:
                self.object.round = current_round
        self.object.save(update_fields=["submit_time", "round"])

    if self.object.status == DRAFT_STATE and "preview" in self.request.POST:
        self.object.create_revision(draft=True, by=self.request.user)
        form.delete_temporary_files()
        # messages.success(self.request, _("Draft saved"))
        context = self.get_context_data()
        return render(self.request, "funds/application_preview.html", context)

    if "save" in self.request.POST:
        return self.save_draft_and_refresh_page(form=form)

    revision = self.object.create_revision(by=self.request.user)
    submitting_proposal = self.object.phase.name in STAGE_CHANGE_ACTIONS

    if submitting_proposal:
        messenger(
            MESSAGES.PROPOSAL_SUBMITTED,
            request=self.request,
            user=self.request.user,
            source=self.object,
        )
    elif revision and not self.object.status == DRAFT_STATE:
        messenger(
            MESSAGES.APPLICANT_EDIT,
            request=self.request,
            user=self.request.user,
            source=self.object,
            related=revision,
        )

    action = set(self.request.POST.keys()) & set(self.transitions.keys())
    try:
        transition = self.transitions[action.pop()]
    except KeyError:
        pass
    else:
        self.object.perform_transition(
            transition.target,
            self.request.user,
            request=self.request,
            notify=not (revision or submitting_proposal)
            or self.object.status == DRAFT_STATE,  # Use the other notification
        )

    # Required for django-file-form: delete temporary files for the new files
    # uploaded while edit.
    form.delete_temporary_files()
    return HttpResponseRedirect(self.get_success_url())

PartnerSubmissionEditView

Bases: ApplicantSubmissionEditView

model class-attribute instance-attribute

model = ApplicationSubmission

transitions property

transitions

buttons

buttons()

Source code in hypha/apply/funds/views.py

def buttons(self):
    if settings.SUBMISSION_PREVIEW_REQUIRED:
        yield ("preview", "primary", _("Preview and submit"))
        yield ("save", "white", _("Save draft"))
    else:
        yield ("submit", "primary", _("Submit"))
        yield ("save", "white", _("Save draft"))

get_form_kwargs

get_form_kwargs()

Returns the keyword arguments for instantiating the form.

This method is called by the form mixin during form instantiation. It returns a dictionary of keyword arguments that will be passed to the form's constructor.

Returns:

• dict –

  A dictionary of keyword arguments for the form constructor.

Source code in hypha/apply/funds/views.py

def get_form_kwargs(self):
    """
    Returns the keyword arguments for instantiating the form.

    This method is called by the form mixin during form instantiation.
    It returns a dictionary of keyword arguments that will be passed to
    the form's constructor.

    Returns:
        dict: A dictionary of keyword arguments for the form constructor.
    """
    kwargs = super().get_form_kwargs()
    instance = kwargs.pop("instance").from_draft()
    initial = instance.raw_data
    for field_id in instance.file_field_ids:
        initial.pop(field_id + "-uploads", False)
        initial[field_id] = self.get_placeholder_file(
            instance.raw_data.get(field_id)
        )
    kwargs["initial"] = initial
    return kwargs

get_placeholder_file

get_placeholder_file(initial_file)

Source code in hypha/apply/funds/views.py

def get_placeholder_file(self, 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
    ]

save_draft_and_refresh_page

save_draft_and_refresh_page(form)

Source code in hypha/apply/funds/views.py

def save_draft_and_refresh_page(self, form) -> HttpResponseRedirect:
    self.object.create_revision(draft=True, by=self.request.user)
    form.delete_temporary_files()
    messages.success(self.request, _("Draft saved"))
    return HttpResponseRedirect(
        reverse_lazy("funds:submissions:edit", args=(self.object.id,))
    )

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(buttons=self.buttons(), **kwargs)

get_form_class

get_form_class()

Returns the form class for the view.

This method is called by the view during form instantiation. It returns the form class that will be used to render the form.

When trying to save as draft, this method will return a version of form class that doesn't validate required fields while saving.

The method also disables any group toggle fields in the form, as they are not supported on edit forms.

Returns:

• class –

  The form class for the view.

Source code in hypha/apply/funds/views.py

def get_form_class(self):
    """
    Returns the form class for the view.

    This method is called by the view during form instantiation. It returns
    the form class that will be used to render the form.

    When trying to save as draft, this method will return a version of form
    class that doesn't validate required fields while saving.

    The method also disables any group toggle fields in the form, as they
    are not supported on edit forms.

    Returns:
        class: The form class for the view.
    """
    is_draft = True if "save" in self.request.POST else False
    form_fields = self.object.get_form_fields(
        draft=is_draft, form_data=self.object.raw_data, user=self.request.user
    )
    field_blocks = self.object.get_defined_fields()
    for field_block in field_blocks:
        if isinstance(field_block.block, GroupToggleBlock):
            # Disable group toggle field as it is not supported on edit forms.
            form_fields[field_block.id].disabled = True
    return type(
        "WagtailStreamForm", (self.object.submission_form_class,), form_fields
    )

get_object_fund_current_round

get_object_fund_current_round()

Source code in hypha/apply/funds/views.py

def get_object_fund_current_round(self):
    assigned_fund = self.object.round.get_parent().specific
    if assigned_fund.open_round:
        return assigned_fund.open_round
    return False

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    self.object.new_data(form.cleaned_data)

    # Update submit_time only when application is getting submitted from the Draft State for the first time.
    if self.object.status == DRAFT_STATE and "submit" in self.request.POST:
        self.object.submit_time = timezone.now()
        if self.object.round:
            current_round = self.get_object_fund_current_round()
            if current_round:
                self.object.round = current_round
        self.object.save(update_fields=["submit_time", "round"])

    if self.object.status == DRAFT_STATE and "preview" in self.request.POST:
        self.object.create_revision(draft=True, by=self.request.user)
        form.delete_temporary_files()
        # messages.success(self.request, _("Draft saved"))
        context = self.get_context_data()
        return render(self.request, "funds/application_preview.html", context)

    if "save" in self.request.POST:
        return self.save_draft_and_refresh_page(form=form)

    revision = self.object.create_revision(by=self.request.user)
    submitting_proposal = self.object.phase.name in STAGE_CHANGE_ACTIONS

    if submitting_proposal:
        messenger(
            MESSAGES.PROPOSAL_SUBMITTED,
            request=self.request,
            user=self.request.user,
            source=self.object,
        )
    elif revision and not self.object.status == DRAFT_STATE:
        messenger(
            MESSAGES.APPLICANT_EDIT,
            request=self.request,
            user=self.request.user,
            source=self.object,
            related=revision,
        )

    action = set(self.request.POST.keys()) & set(self.transitions.keys())
    try:
        transition = self.transitions[action.pop()]
    except KeyError:
        pass
    else:
        self.object.perform_transition(
            transition.target,
            self.request.user,
            request=self.request,
            notify=not (revision or submitting_proposal)
            or self.object.status == DRAFT_STATE,  # Use the other notification
        )

    # Required for django-file-form: delete temporary files for the new files
    # uploaded while edit.
    form.delete_temporary_files()
    return HttpResponseRedirect(self.get_success_url())

dispatch

dispatch(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, request, *args, **kwargs):
    submission = self.get_object()
    # If the requesting user submitted the application, return the Applicant view.
    # Partners may somtimes be applicants as well.
    partner_has_access = submission.partners.filter(pk=request.user.pk).exists()
    if not partner_has_access and submission.user != request.user:
        raise PermissionDenied
    return super(ApplicantSubmissionEditView, self).dispatch(
        request, *args, **kwargs
    )

SubmissionEditView

Bases: ViewDispatcher

community_view class-attribute instance-attribute

community_view = None

finance_view class-attribute instance-attribute

finance_view = None

contracting_view class-attribute instance-attribute

contracting_view = None

admin_view class-attribute instance-attribute

admin_view = AdminSubmissionEditView

applicant_view class-attribute instance-attribute

applicant_view = ApplicantSubmissionEditView

reviewer_view class-attribute instance-attribute

reviewer_view = ApplicantSubmissionEditView

partner_view class-attribute instance-attribute

partner_view = PartnerSubmissionEditView

admin_check

admin_check(request)

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

def admin_check(self, request):
    return request.user.is_apply_staff

reviewer_check

reviewer_check(request)

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

def reviewer_check(self, request):
    return request.user.is_reviewer

partner_check

partner_check(request)

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

def partner_check(self, request):
    return request.user.is_partner

community_check

community_check(request)

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

def community_check(self, request):
    return request.user.is_community_reviewer

finance_check

finance_check(request)

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

def finance_check(self, request):
    return request.user.is_finance

contracting_check

contracting_check(request)

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

def contracting_check(self, request):
    return request.user.is_contracting

applicant_check

applicant_check(request)

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

def applicant_check(self, request):
    return request.user.is_applicant

dispatch

dispatch(request, *args, **kwargs)

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

def dispatch(self, request, *args, **kwargs):
    view = None

    if self.admin_check(request):
        view = self.admin_view
    elif self.reviewer_check(request):
        view = self.reviewer_view
    elif self.partner_check(request):
        view = self.partner_view
    elif self.community_check(request):
        view = self.community_view
    elif self.finance_check(request):
        view = self.finance_view
    elif self.contracting_check(request):
        view = self.contracting_view
    elif self.applicant_check(request):
        view = self.applicant_view

    if view:
        return view.as_view()(request, *args, **kwargs)
    return HttpResponseForbidden()

RevisionListView

Bases: ListView

model class-attribute instance-attribute

model = ApplicationRevision

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    self.submission = get_object_or_404(
        ApplicationSubmission, id=self.kwargs["submission_pk"]
    )
    self.queryset = self.model.objects.filter(
        submission=self.submission,
    ).exclude(
        draft__isnull=False,
        live__isnull=True,
    )
    return super().get_queryset()

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    return super().get_context_data(
        submission=self.submission,
        **kwargs,
    )

RevisionCompareView

Bases: DetailView

model class-attribute instance-attribute

model = ApplicationSubmission

template_name class-attribute instance-attribute

template_name = 'funds/revisions_compare.html'

pk_url_kwarg class-attribute instance-attribute

pk_url_kwarg = 'submission_pk'

compare_revisions

compare_revisions(from_data, to_data)

Source code in hypha/apply/funds/views.py

def compare_revisions(self, from_data, to_data):
    self.object.form_data = from_data.form_data
    from_rendered_text_fields = self.object.render_text_blocks_answers()
    from_required = self.render_required()

    self.object.form_data = to_data.form_data
    to_rendered_text_fields = self.object.render_text_blocks_answers()
    to_required = self.render_required()

    required_fields = [
        compare(*fields) for fields in zip(from_required, to_required, strict=False)
    ]

    stream_fields = [
        compare(*fields)
        for fields in zip(
            from_rendered_text_fields, to_rendered_text_fields, strict=False
        )
    ]

    return (required_fields, stream_fields)

render_required

render_required()

Source code in hypha/apply/funds/views.py

def render_required(self):
    return [
        getattr(self.object, "get_{}_display".format(field))()
        for field in self.object.named_blocks
    ]

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    from_revision = self.object.revisions.get(id=self.kwargs["from"])
    to_revision = self.object.revisions.get(id=self.kwargs["to"])
    required_fields, stream_fields = self.compare_revisions(
        from_revision, to_revision
    )
    timestamps = (from_revision.timestamp, to_revision.timestamp)
    return super().get_context_data(
        timestamps=timestamps,
        required_fields=required_fields,
        stream_fields=stream_fields,
        **kwargs,
    )

RoundListView

Bases: SingleTableMixin, FilterView

template_name class-attribute instance-attribute

template_name = 'funds/rounds.html'

table_class class-attribute instance-attribute

table_class = RoundsTable

filterset_class class-attribute instance-attribute

filterset_class = RoundsFilter

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    return RoundsAndLabs.objects.with_progress()

SubmissionDeleteView

Bases: DeleteView

model class-attribute instance-attribute

model = ApplicationSubmission

success_url class-attribute instance-attribute

success_url = reverse_lazy('funds:submissions:list')

form_valid

form_valid(form)

Source code in hypha/apply/funds/views.py

def form_valid(self, form):
    submission = self.get_object()
    messenger(
        MESSAGES.DELETE_SUBMISSION,
        user=self.request.user,
        request=self.request,
        source=submission,
    )

    # Delete NEW_SUBMISSION event for this particular submission
    Event.objects.filter(
        type=MESSAGES.NEW_SUBMISSION, object_id=submission.id
    ).delete()

    # delete submission and redirect to success url
    return super().form_valid(form)

SubmissionPrivateMediaView

Bases: UserPassesTestMixin, PrivateMediaView

storage class-attribute instance-attribute

storage = PrivateStorage()

raise_exception class-attribute instance-attribute

raise_exception = True

get

get(*args, **kwargs)

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

def get(self, *args, **kwargs):
    file_to_serve = self.get_media(*args, **kwargs)
    return FileResponse(file_to_serve)

dispatch

dispatch(*args, **kwargs)

Source code in hypha/apply/funds/views.py

def dispatch(self, *args, **kwargs):
    submission_pk = self.kwargs["pk"]
    self.submission = get_object_or_404(ApplicationSubmission, pk=submission_pk)
    return super().dispatch(*args, **kwargs)

get_media

get_media(*args, **kwargs)

Source code in hypha/apply/funds/views.py

def get_media(self, *args, **kwargs):
    field_id = kwargs["field_id"]
    file_name = kwargs["file_name"]
    path_to_file = generate_submission_file_path(
        self.submission.pk, field_id, file_name
    )
    return self.storage.open(path_to_file)

test_func

test_func()

Source code in hypha/apply/funds/views.py

def test_func(self):
    permission, _ = has_permission(
        "submission_view", self.request.user, self.submission
    )
    return permission

SubmissionDetailSimplifiedView

Bases: DetailView

model class-attribute instance-attribute

model = ApplicationSubmission

template_name_suffix class-attribute instance-attribute

template_name_suffix = '_simplified_detail'

get_object

get_object(queryset=None)

Source code in hypha/apply/funds/views.py

def get_object(self, queryset=None):
    obj = super().get_object(queryset)

    if not hasattr(obj, "project"):
        raise Http404

    return obj

SubmissionDetailPDFView

Bases: SingleObjectMixin, View

model class-attribute instance-attribute

model = ApplicationSubmission

get_object

get_object(queryset=None)

Source code in hypha/apply/funds/views.py

def get_object(self, queryset=None):
    obj = super().get_object(queryset)

    if not hasattr(obj, "project"):
        raise Http404

    return obj

get

get(request, *args, **kwargs)

Source code in hypha/apply/funds/views.py

def get(self, request, *args, **kwargs):
    self.object = self.get_object()
    pdf_page_settings = PDFPageSettings.for_request(request)
    content = draw_submission_content(self.object.output_text_answers())
    pdf = make_pdf(
        title=self.object.title,
        sections=[
            {
                "content": content,
                "title": "Submission",
                "meta": [
                    self.object.stage,
                    self.object.page,
                    self.object.round,
                    f"Lead: { self.object.lead }",
                ],
            },
        ],
        pagesize=pdf_page_settings.download_page_size,
    )
    return FileResponse(
        pdf,
        as_attachment=True,
        filename=self.object.title + ".pdf",
    )

SubmissionResultView

Bases: SubmissionStatsMixin, FilterView

template_name class-attribute instance-attribute

template_name = 'funds/submissions_result.html'

filterset_class class-attribute instance-attribute

filterset_class = SubmissionFilterAndSearch

filter_action class-attribute instance-attribute

filter_action = ''

excluded_fields class-attribute instance-attribute

excluded_fields = SUBMISSIONS_TABLE_EXCLUDED_FIELDS

excluded property

excluded

get_filterset_kwargs

get_filterset_kwargs(filterset_class, **kwargs)

Source code in hypha/apply/funds/views.py

def get_filterset_kwargs(self, filterset_class, **kwargs):
    new_kwargs = super().get_filterset_kwargs(filterset_class)
    new_kwargs.update(self.excluded)
    new_kwargs.update(kwargs)
    return new_kwargs

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    return self.filterset_class._meta.model.objects.current().exclude_draft()

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    if self.object_list:
        submission_values = self.object_list.value()
        count_values = submission_values.get("value__count")
        total_value = intcomma(submission_values.get("value__sum"))
        average_value = intcomma(round(submission_values.get("value__avg")))
    else:
        count_values = 0
        total_value = 0
        average_value = 0

    return super().get_context_data(
        search_term=search_term,
        filter_action=self.filter_action,
        count_values=count_values,
        total_value=total_value,
        average_value=average_value,
        **kwargs,
    )

ReviewerLeaderboard

Bases: SingleTableMixin, FilterView

filterset_class class-attribute instance-attribute

filterset_class = ReviewerLeaderboardFilter

filter_action class-attribute instance-attribute

filter_action = ''

table_class class-attribute instance-attribute

table_class = ReviewerLeaderboardTable

table_pagination class-attribute instance-attribute

table_pagination = False

template_name class-attribute instance-attribute

template_name = 'funds/reviewer_leaderboard.html'

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    search_term = self.request.GET.get("query")

    return super().get_context_data(
        search_term=search_term,
        filter_action=self.filter_action,
        **kwargs,
    )

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    # Only list reviewers.
    return self.filterset_class._meta.model.objects.reviewers()

get_table_data

get_table_data()

Source code in hypha/apply/funds/views.py

def get_table_data(self):
    ninety_days_ago = timezone.now() - timedelta(days=90)
    this_year = timezone.now().year
    last_year = timezone.now().year - 1
    return (
        super()
        .get_table_data()
        .annotate(
            total=Count("assignedreviewers__review"),
            ninety_days=Count(
                "assignedreviewers__review",
                filter=Q(
                    assignedreviewers__review__created_at__date__gte=ninety_days_ago
                ),
            ),
            this_year=Count(
                "assignedreviewers__review",
                filter=Q(assignedreviewers__review__created_at__year=this_year),
            ),
            last_year=Count(
                "assignedreviewers__review",
                filter=Q(assignedreviewers__review__created_at__year=last_year),
            ),
        )
    )

ReviewerLeaderboardDetail

Bases: SingleTableMixin, ListView

model class-attribute instance-attribute

model = Review

table_class class-attribute instance-attribute

table_class = ReviewerLeaderboardDetailTable

paginator_class class-attribute instance-attribute

paginator_class = LazyPaginator

table_pagination class-attribute instance-attribute

table_pagination = {'per_page': 25}

template_name class-attribute instance-attribute

template_name = 'funds/reviewer_leaderboard_detail.html'

get_context_data

get_context_data(**kwargs)

Source code in hypha/apply/funds/views.py

def get_context_data(self, **kwargs):
    obj = User.objects.get(pk=self.kwargs.get("pk"))
    return super().get_context_data(object=obj, **kwargs)

get_table_data

get_table_data()

Source code in hypha/apply/funds/views.py

def get_table_data(self):
    return (
        super()
        .get_table_data()
        .filter(author__reviewer_id=self.kwargs.get("pk"))
        .select_related("submission")
    )

RoleColumn

Bases: Column

render

render(value, record)

Source code in hypha/apply/funds/views.py

def render(self, value, record):
    return AssignedReviewers.objects.filter(
        reviewer=record,
        role=self.verbose_name,
        submission__status__in=active_statuses,
    ).count()

StaffAssignments

Bases: SingleTableMixin, ListView

model class-attribute instance-attribute

model = User

table_class class-attribute instance-attribute

table_class = StaffAssignmentsTable

table_pagination class-attribute instance-attribute

table_pagination = False

template_name class-attribute instance-attribute

template_name = 'funds/staff_assignments.html'

get_queryset

get_queryset()

Source code in hypha/apply/funds/views.py

def get_queryset(self):
    # Only list staff.
    return self.model.objects.staff()

get_table_data

get_table_data()

Source code in hypha/apply/funds/views.py

def get_table_data(self):
    table_data = super().get_table_data()
    reviewer_roles = ReviewerRole.objects.all().order_by("order")
    for data in table_data:
        for i, _role in enumerate(reviewer_roles):
            # Only setting column name with dummy value 0.
            # Actual value will be set in RoleColumn render method.
            setattr(data, f"role{i}", 0)
    return table_data

get_table_kwargs

get_table_kwargs()

Source code in hypha/apply/funds/views.py

def get_table_kwargs(self):
    reviewer_roles = ReviewerRole.objects.all().order_by("order")
    extra_columns = []
    for i, role in enumerate(reviewer_roles):
        extra_columns.append((f"role{i}", RoleColumn(verbose_name=role)))
    return {
        "extra_columns": extra_columns,
    }

submission_success

submission_success(request, pk)

Source code in hypha/apply/funds/views.py

def submission_success(request, pk):
    submission = get_object_or_404(ApplicationSubmission, pk=pk)
    return render(
        request,
        "funds/submission-success.html",
        {
            "form_submission": submission,
        },
    )