From 31fed539551f6705b967f4e72d8990be50af0296 Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Sat, 24 Oct 2020 12:40:56 +0200
Subject: [PATCH] Rename get_instance_by_pk and document it better
---
aleksis/apps/alsijil/util/alsijil_helpers.py | 4 ++--
aleksis/apps/alsijil/views.py | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/aleksis/apps/alsijil/util/alsijil_helpers.py b/aleksis/apps/alsijil/util/alsijil_helpers.py
index 51279dc62..10bf5b4e7 100644
--- a/aleksis/apps/alsijil/util/alsijil_helpers.py
+++ b/aleksis/apps/alsijil/util/alsijil_helpers.py
@@ -38,14 +38,14 @@ def get_lesson_period_by_pk(
return lesson_period
-def get_instance_by_pk(
+def get_timetable_instance_by_pk(
request: HttpRequest,
year: Optional[int] = None,
week: Optional[int] = None,
type_: Optional[str] = None,
id_: Optional[int] = None,
):
- """Get Instance object by given type and id or the current person."""
+ """Get timetable object (teacher, room or group) by given type and id or the current person."""
if type_ and id_:
return get_el_by_pk(request, type_, id_)
elif hasattr(request, "user") and hasattr(request.user, "person"):
diff --git a/aleksis/apps/alsijil/views.py b/aleksis/apps/alsijil/views.py
index 220e89653..6120e8dca 100644
--- a/aleksis/apps/alsijil/views.py
+++ b/aleksis/apps/alsijil/views.py
@@ -34,7 +34,7 @@ from .forms import (
)
from .models import ExcuseType, ExtraMark, LessonDocumentation, PersonalNote
from .tables import ExcuseTypeTable, ExtraMarkTable
-from .util.alsijil_helpers import get_instance_by_pk, get_lesson_period_by_pk
+from .util.alsijil_helpers import get_lesson_period_by_pk, get_timetable_instance_by_pk
@permission_required("alsijil.view_lesson", fn=get_lesson_period_by_pk)
@@ -162,7 +162,7 @@ def lesson(
return render(request, "alsijil/class_register/lesson.html", context)
-@permission_required("alsijil.view_week", fn=get_instance_by_pk)
+@permission_required("alsijil.view_week", fn=get_timetable_instance_by_pk)
def week_view(
request: HttpRequest,
year: Optional[int] = None,
@@ -177,7 +177,7 @@ def week_view(
else:
wanted_week = CalendarWeek()
- instance = get_instance_by_pk(request, year, week, type_, id_)
+ instance = get_timetable_instance_by_pk(request, year, week, type_, id_)
lesson_periods = LessonPeriod.objects.in_week(wanted_week).annotate(
has_documentation=Exists(
--
GitLab