Refactor as

Author: bonjourmauko

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Rename `instant` to `build_instant`.
 - Rename `period` to `build_period`.
 - Move `instant_date` to `Instant.to_date`.
+- Refactor `Period.contains` as `Period.__contains__`.
 - Make `periods.parse_period` stricter (for example `2022-1` now fails).
 
 #### Technical changes

openfisca_core/data_storage/in_memory_storage.py

@@ -41,7 +41,7 @@ def delete(self, period = None):
         self._arrays = {
             period_item: value
             for period_item, value in self._arrays.items()
-            if not period.contains(period_item)
+            if period_item not in period
             }
 
     def get_known_periods(self):

openfisca_core/data_storage/on_disk_storage.py

@@ -62,7 +62,7 @@ def delete(self, period = None):
             self._files = {
                 period_item: value
                 for period_item, value in self._files.items()
-                if not period.contains(period_item)
+                if period_item not in period
                 }
 
     def get_known_periods(self):

openfisca_core/periods/period_.py

@@ -144,6 +144,29 @@ def __str__(self) -> str:
         # complex period
         return '{}:{}-{:02d}:{}'.format(unit, year, month, size)
 
+    def __contains__(self, other: object) -> bool:
+        """Checks if a ``period`` contains another one.
+
+        Args:
+            other (object): The other ``Period``.
+
+        Returns:
+            True if ``other`` is contained, otherwise False.
+
+        Example:
+            >>> period = Period((YEAR, Instant((2021, 1, 1)), 1))
+            >>> sub_period = Period((MONTH, Instant((2021, 1, 1)), 3))
+
+            >>> sub_period in period
+            True
+
+        """
+
+        if isinstance(other, types.Period):
+            return self.start <= other.start and self.stop >= other.stop
+
+        return super().__contains__(other)
+
     @property
     def date(self) -> datetime.date:
         """The date representation of the ``period``'s' start date.
@@ -512,23 +535,3 @@ def offset(
         """
 
         return self.__class__((self[0], self[1].offset(offset, self[0] if unit is None else unit), self[2]))
-
-    def contains(self, other: types.Period) -> bool:
-        """Checks if a ``period`` contains another one.
-
-        Args:
-            other (:obj:`.Period`): The other ``Period``.
-
-        Returns:
-            True if ``other`` is contained, otherwise False.
-
-        Example:
-            >>> period = Period((YEAR, Instant((2021, 1, 1)), 1))
-            >>> sub_period = Period((MONTH, Instant((2021, 1, 1)), 3))
-
-            >>> period.contains(sub_period)
-            True
-
-        """
-
-        return self.start <= other.start and self.stop >= other.stop

openfisca_core/variables/helpers.py

@@ -17,7 +17,7 @@ def get_annualized_variable(variable: variables.Variable, annualization_period:
     def make_annual_formula(original_formula, annualization_period = None):
 
         def annual_formula(population, period, parameters):
-            if period.start.month != 1 and (annualization_period is None or annualization_period.contains(period)):
+            if period.start.month != 1 and (annualization_period is None or period not in annualization_period):
                 return population(variable.name, period.this_year.first_month)
             if original_formula.__code__.co_argcount == 2:
                 return original_formula(population, period)