Fix types in holders

openfisca · Dec 19, 2022 · 9ee7eea · 9ee7eea
1 parent a9e41a6
commit 9ee7eea
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 5 deletions.
diff --git a/openfisca_core/holders/holder.py b/openfisca_core/holders/holder.py
@@ -117,7 +117,7 @@ def get_memory_usage(self) -> MemoryUsage:
             >>> entity = entities.Entity("", "", "", "")
 
             >>> class MyVariable(variables.Variable):
-            ...     definition_period = "year"
+            ...     definition_period = periods.DateUnit.YEAR
             ...     entity = entity
             ...     value_type = int
 
@@ -188,7 +188,7 @@ def set_input(
             >>> entity = entities.Entity("", "", "", "")
 
             >>> class MyVariable(variables.Variable):
-            ...     definition_period = "year"
+            ...     definition_period = periods.DateUnit.YEAR
             ...     entity = entity
             ...     value_type = int
 

diff --git a/openfisca_core/holders/tests/__init__.py b/openfisca_core/holders/tests/__init__.py
diff --git a/openfisca_core/periods/helpers.py b/openfisca_core/periods/helpers.py
@@ -250,7 +250,9 @@ def _raise_error(value: str) -> NoReturn:
     Examples:
         >>> _raise_error("Oi mate!")
         Traceback (most recent call last):
-        ValueError: Expected a period (eg. '2017', ...); got: 'Oi mate!'.
+        ValueError: Expected a period (eg. '2017', '2017-01', '2017-01-01', ...
+        Learn more about legal period formats in OpenFisca:
+        <https://openfisca.org/doc/coding-the-legislation/35_periods.html#pe...
 
     """
 

diff --git a/openfisca_core/periods/period_.py b/openfisca_core/periods/period_.py
@@ -246,7 +246,7 @@ def date(self) -> "Date":
             >>> period = Period((DateUnit.YEAR, instant, 3))
             >>> period.date
             Traceback (most recent call last):
-            ValueError: "date" is undefined for a period of size > 1: year:2021-09:3.
+            ValueError: "date" is undefined for a period of size > 1: year:2021-10:3.
 
         """
 

diff --git a/openfisca_core/taxbenefitsystems/tax_benefit_system.py b/openfisca_core/taxbenefitsystems/tax_benefit_system.py
@@ -397,7 +397,7 @@ def get_parameters_at_instant(
 
         """
 
-        key: Instant
+        key: Optional[Instant]
         msg: str
 
         if isinstance(instant, Instant):

diff --git a/openfisca_core/variables/variable.py b/openfisca_core/variables/variable.py
@@ -326,6 +326,8 @@ def get_formula(
 
         """
 
+        instant: Optional[Instant]
+
         if not self.formulas:
             return None
 
@@ -340,6 +342,9 @@ def get_formula(
             except ValueError:
                 instant = periods.instant(period)
 
+        if instant is None:
+            return None
+
         if self.end and instant.date > self.end:
             return None