(BSR)[API] feat: add a function to get the full educational year period

Author: jcicurel-pass

api/src/pcapi/core/educational/api/institution.py

@@ -277,7 +277,7 @@ def _get_import_deposit_period_bounds(
 ) -> tuple[datetime, datetime]:
     match period_option:
         case ImportDepositPeriodOption.EDUCATIONAL_YEAR_FULL:
-            return (educational_year.beginningDate, educational_year.expirationDate)
+            return utils.get_educational_year_full_bounds(educational_year)
 
         case ImportDepositPeriodOption.EDUCATIONAL_YEAR_FIRST_PERIOD:
             return utils.get_educational_year_first_period_bounds(educational_year)

api/src/pcapi/core/educational/factories.py

@@ -258,11 +258,7 @@ class Meta:
     amount = 3000
     isFinal = True
     ministry = models.Ministry.EDUCATION_NATIONALE.name
-    period = factory.LazyAttribute(
-        lambda deposit: db_utils.make_timerange(
-            start=deposit.educationalYear.beginningDate, end=deposit.educationalYear.expirationDate
-        )
-    )
+    period = factory.LazyAttribute(lambda deposit: utils.get_educational_year_full_period(deposit.educationalYear))
 
 
 class EducationalDepositFirstPeriodFactory(EducationalDepositFactory):
@@ -319,7 +315,7 @@ def _get_booking_deposit(booking: models.CollectiveBooking) -> models.Educationa
 
     institution = booking.educationalInstitution
     year = booking.educationalYear
-    period = db_utils.make_timerange(year.beginningDate, year.expirationDate)
+    period = utils.get_educational_year_full_period(year)
 
     return EducationalDepositFactory.create(educationalInstitution=institution, educationalYear=year, period=period)
 

api/src/pcapi/core/educational/utils.py

@@ -131,6 +131,10 @@ def format_collective_offer_displayed_status(
     return COLLECTIVE_OFFER_DISPLAYED_STATUS_LABELS.get(displayed_status) or displayed_status.value
 
 
+def get_educational_year_full_bounds(educational_year: models.EducationalYear) -> tuple[datetime, datetime]:
+    return educational_year.beginningDate, educational_year.expirationDate
+
+
 def get_educational_year_first_period_bounds(educational_year: models.EducationalYear) -> tuple[datetime, datetime]:
     period_start = educational_year.beginningDate
     # Set the time at 23:59:59 to be consistent with educational year expirationDate
@@ -146,6 +150,12 @@ def get_educational_year_second_period_bounds(educational_year: models.Education
     return period_start, period_end
 
 
+def get_educational_year_full_period(educational_year: models.EducationalYear) -> DateTimeRange:
+    """Get the period 01/09 -> 31/08 (period = educational year)"""
+    period_start, period_end = get_educational_year_full_bounds(educational_year)
+    return db_utils.make_timerange(period_start, period_end)
+
+
 def get_educational_year_first_period(educational_year: models.EducationalYear) -> DateTimeRange:
     """Get the period 01/09 -> 31/12 of the given educational year"""
     period_start, period_end = get_educational_year_first_period_bounds(educational_year)

api/src/pcapi/sandboxes/scripts/creators/industrial/create_industrial_eac_data/create_institutions.py

@@ -251,7 +251,7 @@ def create_institutions_with_deposits_by_period() -> list[educational_models.Edu
             educational_factories.EducationalDepositFactory.create(
                 educationalInstitution=institution,
                 educationalYear=current_year,
-                period=make_timerange(start=current_year.beginningDate, end=current_year.expirationDate),
+                period=utils.get_educational_year_full_period(current_year),
                 amount=10_000,
             )
         ]
@@ -350,7 +350,7 @@ def create_institutions_with_deposits_by_period() -> list[educational_models.Edu
             educational_factories.EducationalDepositFactory.create(
                 educationalInstitution=institution,
                 educationalYear=next_year,
-                period=make_timerange(start=next_year.beginningDate, end=next_year.expirationDate),
+                period=utils.get_educational_year_full_period(next_year),
                 amount=10_000,
             )
         ]