From 83c085b6116d2145d0b9696cf747a84fbae1fec8 Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Tue, 16 Feb 2021 16:37:53 +0100
Subject: [PATCH] Rename get_from_period to from_period and add docstring
---
aleksis/apps/chronos/models.py | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/aleksis/apps/chronos/models.py b/aleksis/apps/chronos/models.py
index 24f8e855..65fa3113 100644
--- a/aleksis/apps/chronos/models.py
+++ b/aleksis/apps/chronos/models.py
@@ -218,7 +218,11 @@ class TimePeriod(ValidityRangeRelatedExtensibleModel):
return url_prev, url_next
@classmethod
- def get_from_period(cls, period: int, day: date) -> "TimePeriod":
+ def from_period(cls, period: int, day: date) -> "TimePeriod":
+ """Get `TimePeriod` object for a period on a specific date.
+
+ This will respect the relation to validity ranges.
+ """
return cls.objects.on_day(day).filter(period=period).first()
@classproperty
@@ -907,7 +911,7 @@ class Event(SchoolTermRelatedExtensibleModel, GroupPropertiesMixin, TeacherPrope
"""
day = getattr(self, "_date", timezone.now().date())
if day != self.date_start:
- return TimePeriod.get_from_period(TimePeriod.period_min, day)
+ return TimePeriod.from_period(TimePeriod.period_min, day)
else:
return self.period_from
@@ -919,7 +923,7 @@ class Event(SchoolTermRelatedExtensibleModel, GroupPropertiesMixin, TeacherPrope
"""
day = getattr(self, "_date", timezone.now().date())
if day != self.date_end:
- return TimePeriod.get_from_period(TimePeriod.period_max, day)
+ return TimePeriod.from_period(TimePeriod.period_max, day)
else:
return self.period_to
--
GitLab