feat(tests): add assert_near parser

Author: bonjourmauko

STYLEGUIDE.md

@@ -72,9 +72,8 @@ And avoid:
 # No
 
 from openfisca_country_template.entities import Person
-from openfisca_core import variables
-from openfisca_core.tools import assert_near
-from openfisca_core import axes
+from openfisca_core import axes, variables
+from openfisca_test import assert_near
 
 from numpy import ndarray
 from copy import deepcopy

openfisca_core/holders/tests/test_helpers.py

@@ -1,6 +1,7 @@
 import pytest
 
-from openfisca_core import holders, tools
+import openfisca_test as test
+from openfisca_core import holders
 from openfisca_core.entities import Entity
 from openfisca_core.holders import Holder
 from openfisca_core.periods import DateUnit, Instant, Period
@@ -86,7 +87,7 @@ def test_set_input_dispatch_by_period(
     holders.set_input_dispatch_by_period(holder, dispatch_period, values)
     total = sum(map(holder.get_array, holder.get_known_periods()))
 
-    tools.assert_near(total, expected, absolute_error_margin=0.001)
+    test.assert_near(total, expected, absolute_error_margin=0.001)
 
 
 @pytest.mark.parametrize(
@@ -136,4 +137,4 @@ def test_set_input_divide_by_period(
     holders.set_input_divide_by_period(holder, divide_period, values)
     last = holder.get_array(holder.get_known_periods()[-1])
 
-    tools.assert_near(last, expected, absolute_error_margin=0.001)
+    test.assert_near(last, expected, absolute_error_margin=0.001)

openfisca_core/indexed_enums/__init__.py

@@ -21,6 +21,9 @@
 #
 # See: https://www.python.org/dev/peps/pep-0008/#imports
 
-from .config import ENUM_ARRAY_DTYPE  # noqa: F401
-from .enum import Enum  # noqa: F401
-from .enum_array import EnumArray  # noqa: F401
+from . import types
+from .config import ENUM_ARRAY_DTYPE
+from .enum import Enum
+from .enum_array import EnumArray
+
+__all__ = ["ENUM_ARRAY_DTYPE", "Enum", "EnumArray", "types"]

openfisca_core/indexed_enums/enum.py

@@ -6,6 +6,7 @@
 
 import numpy
 
+from . import types as t
 from .config import ENUM_ARRAY_DTYPE
 from .enum_array import EnumArray
 
@@ -38,6 +39,7 @@ def encode(
             numpy.int_,
             numpy.float_,
             numpy.object_,
+            t.Array[t.ArrayBytes],
         ],
     ) -> EnumArray:
         """

openfisca_core/indexed_enums/enum_array.py

@@ -5,6 +5,8 @@
 
 import numpy
 
+from . import types as t
+
 if typing.TYPE_CHECKING:
     from openfisca_core.indexed_enums import Enum
 
@@ -21,7 +23,7 @@ class EnumArray(numpy.ndarray):
     # https://docs.scipy.org/doc/numpy-1.13.0/user/basics.subclassing.html#slightly-more-realistic-example-attribute-added-to-existing-array.
     def __new__(
         cls,
-        input_array: numpy.int_,
+        input_array: t.Array[t.ArrayEnum],
         possible_values: Optional[Type[Enum]] = None,
     ) -> EnumArray:
         obj = numpy.asarray(input_array).view(cls)

openfisca_core/indexed_enums/types.py

@@ -0,0 +1,3 @@
+from openfisca_core.types import Array, ArrayBytes, ArrayEnum
+
+__all__ = ["Array", "ArrayBytes", "ArrayEnum"]

openfisca_core/periods/instant_.py

@@ -90,7 +90,7 @@ def __str__(self):
         return instant_str
 
     @property
-    def date(self):
+    def date(self) -> pendulum.Date:
         instant_date = config.date_by_instant_cache.get(self)
 
         if instant_date is None:

openfisca_core/scripts/measure_performances.py

@@ -16,8 +16,8 @@
 from openfisca_core.entities import build_entity
 from openfisca_core.periods import DateUnit
 from openfisca_core.taxbenefitsystems import TaxBenefitSystem
-from openfisca_core.tools import assert_near
 from openfisca_core.variables import Variable
+from openfisca_test import assert_near
 
 args = None
 

openfisca_core/tools/__init__.py

@@ -1,79 +1,10 @@
-# -*- coding: utf-8 -*-
-
+from __future__ import annotations
 
 import os
 
 import numexpr
 
-from openfisca_core.indexed_enums import EnumArray
-
-
-def assert_near(
-    value,
-    target_value,
-    absolute_error_margin=None,
-    message="",
-    relative_error_margin=None,
-):
-    """
-
-    :param value: Value returned by the test
-    :param target_value: Value that the test should return to pass
-    :param absolute_error_margin: Absolute error margin authorized
-    :param message: Error message to be displayed if the test fails
-    :param relative_error_margin: Relative error margin authorized
-
-    Limit : This function cannot be used to assert near periods.
-
-    """
-
-    import numpy
-
-    if absolute_error_margin is None and relative_error_margin is None:
-        absolute_error_margin = 0
-    if not isinstance(value, numpy.ndarray):
-        value = numpy.array(value)
-    if isinstance(value, EnumArray):
-        return assert_enum_equals(value, target_value, message)
-    if numpy.issubdtype(value.dtype, numpy.datetime64):
-        target_value = numpy.array(target_value, dtype=value.dtype)
-        assert_datetime_equals(value, target_value, message)
-    if isinstance(target_value, str):
-        target_value = eval_expression(target_value)
-
-    target_value = numpy.array(target_value).astype(numpy.float32)
-
-    value = numpy.array(value).astype(numpy.float32)
-    diff = abs(target_value - value)
-    if absolute_error_margin is not None:
-        assert (
-            diff <= absolute_error_margin
-        ).all(), "{}{} differs from {} with an absolute margin {} > {}".format(
-            message, value, target_value, diff, absolute_error_margin
-        )
-    if relative_error_margin is not None:
-        assert (
-            diff <= abs(relative_error_margin * target_value)
-        ).all(), "{}{} differs from {} with a relative margin {} > {}".format(
-            message,
-            value,
-            target_value,
-            diff,
-            abs(relative_error_margin * target_value),
-        )
-
-
-def assert_datetime_equals(value, target_value, message=""):
-    assert (value == target_value).all(), "{}{} differs from {}.".format(
-        message, value, target_value
-    )
-
-
-def assert_enum_equals(value, target_value, message=""):
-    value = value.decode_to_str()
-    assert (value == target_value).all(), "{}{} differs from {}.".format(
-        message, value, target_value
-    )
+from openfisca_core import types as t
 
 
 def indent(text):
@@ -102,7 +33,9 @@ def get_trace_tool_link(scenario, variables, api_url, trace_tool_url):
     return url
 
 
-def eval_expression(expression):
+def eval_expression(
+    expression: str,
+) -> str | t.Array[t.ArrayBool | t.ArrayInt | t.ArrayFloat]:
     try:
         return numexpr.evaluate(expression)
     except (KeyError, TypeError):

openfisca_core/tools/test_runner.py

@@ -17,8 +17,8 @@
 
 from openfisca_core.errors import SituationParsingError, VariableNotFound
 from openfisca_core.simulation_builder import SimulationBuilder
-from openfisca_core.tools import assert_near
 from openfisca_core.warnings import LibYAMLWarning
+from openfisca_test import assert_near
 
 
 class Options(TypedDict, total=False):

openfisca_core/types.py

@@ -10,11 +10,42 @@
 
 import numpy
 
+# Type aliases
+
+#: Type for arrays of any type.
+ArrayAny: TypeAlias = numpy.generic
+
+#: Type for arrays of booleans.
+ArrayBool: TypeAlias = numpy.bool_
+
+#: Type for arrays of bytes.
+ArrayBytes: TypeAlias = numpy.bytes_
+
+#: Type for arrays of dates.
+ArrayDate: TypeAlias = numpy.datetime64
+
+#: Type for arrays of enums.
+ArrayEnum: TypeAlias = numpy.int16
+
+#: Type for arrays of floats.
+ArrayFloat: TypeAlias = numpy.float32
+
+#: Type for arrays of integers.
+ArrayInt: TypeAlias = numpy.int32
+
+#: Type for arrays of Python objects.
+ArrayObject: TypeAlias = numpy.object_
+
+#: Type for arrays of strings.
+ArrayStr: TypeAlias = numpy.str_
+
+#: Generic numpy type an array can have.
 N = TypeVar("N", bound=numpy.generic, covariant=True)
 
-#: Type representing an numpy array.
+#: Type representing a numpy array.
 Array: TypeAlias = NDArray[N]
 
+#: Generic type a sequence can have.
 L = TypeVar("L")
 
 #: Type representing an array-like object.

openfisca_core/variables/__init__.py

@@ -21,6 +21,16 @@
 #
 # See: https://www.python.org/dev/peps/pep-0008/#imports
 
-from .config import FORMULA_NAME_PREFIX, VALUE_TYPES  # noqa: F401
-from .helpers import get_annualized_variable, get_neutralized_variable  # noqa: F401
-from .variable import Variable  # noqa: F401
+from . import types
+from .config import FORMULA_NAME_PREFIX, VALUE_TYPES
+from .helpers import get_annualized_variable, get_neutralized_variable
+from .variable import Variable
+
+__all__ = [
+    "FORMULA_NAME_PREFIX",
+    "VALUE_TYPES",
+    "Variable",
+    "get_annualized_variable",
+    "get_neutralized_variable",
+    "types",
+]

openfisca_core/variables/config.py

@@ -1,47 +1,46 @@
 import datetime
 
-import numpy
+from openfisca_core import indexed_enums as enum
 
-from openfisca_core import indexed_enums
-from openfisca_core.indexed_enums import Enum
+from . import types as t
 
 VALUE_TYPES = {
     bool: {
-        "dtype": numpy.bool_,
+        "dtype": t.ArrayBool,
         "default": False,
         "json_type": "boolean",
         "formatted_value_type": "Boolean",
         "is_period_size_independent": True,
     },
     int: {
-        "dtype": numpy.int32,
+        "dtype": t.ArrayInt,
         "default": 0,
         "json_type": "integer",
         "formatted_value_type": "Int",
         "is_period_size_independent": False,
     },
     float: {
-        "dtype": numpy.float32,
+        "dtype": t.ArrayFloat,
         "default": 0,
         "json_type": "number",
         "formatted_value_type": "Float",
         "is_period_size_independent": False,
     },
     str: {
-        "dtype": object,
+        "dtype": t.ArrayBytes,
         "default": "",
         "json_type": "string",
         "formatted_value_type": "String",
         "is_period_size_independent": True,
     },
-    Enum: {
-        "dtype": indexed_enums.ENUM_ARRAY_DTYPE,
+    enum.Enum: {
+        "dtype": t.ArrayEnum,
         "json_type": "string",
         "formatted_value_type": "String",
         "is_period_size_independent": True,
     },
     datetime.date: {
-        "dtype": "datetime64[D]",
+        "dtype": t.ArrayDate,
         "default": datetime.date.fromtimestamp(0),  # 0 == 1970-01-01
         "json_type": "string",
         "formatted_value_type": "Date",

openfisca_core/variables/types.py

@@ -0,0 +1,17 @@
+from openfisca_core.types import (
+    ArrayBool,
+    ArrayBytes,
+    ArrayDate,
+    ArrayEnum,
+    ArrayFloat,
+    ArrayInt,
+)
+
+__any__ = [
+    ArrayBool,
+    ArrayBytes,
+    ArrayDate,
+    ArrayEnum,
+    ArrayFloat,
+    ArrayInt,
+]

openfisca_tasks/lint.mk

@@ -9,7 +9,7 @@ check-syntax-errors: .
 	@$(call print_pass,$@:)
 
 ## Run linters to check for syntax and style errors.
-check-style: $(shell git ls-files "*.py")
+check-style: $(shell git ls-files "*.py" "*.pyi")
 	@$(call print_help,$@:)
 	@isort --check $?
 	@black --check $?
@@ -32,21 +32,23 @@ lint-doc-%:
 	@## able to integrate documentation improvements progresively.
 	@##
 	@$(call print_help,$(subst $*,%,$@:))
-	@flake8 --select=D101,D102,D103,DAR openfisca_core/$*
-	@pylint openfisca_core/$*
+	@flake8 --select=D101,D102,D103,DAR openfisca_core/$* openfisca_test
+	@pylint openfisca_core/$* openfisca_test
 	@$(call print_pass,$@:)
 
 ## Run static type checkers for type errors.
 check-types:
 	@$(call print_help,$@:)
+	@command -v pyright && pyright
 	@mypy \
 		openfisca_core/commons \
 		openfisca_core/entities \
-		openfisca_core/types.py
+		openfisca_core/types.py \
+		openfisca_test
 	@$(call print_pass,$@:)
 
 ## Run code formatters to correct style errors.
-format-style: $(shell git ls-files "*.py")
+format-style: $(shell git ls-files "*.py" "*.pyi")
 	@$(call print_help,$@:)
 	@isort $?
 	@black $?

openfisca_tasks/test_code.mk

@@ -36,7 +36,8 @@ test-core: $(shell pytest --quiet --quiet --collect-only 2> /dev/null | cut -f 1
 		openfisca_core/entities \
 		openfisca_core/holders \
 		openfisca_core/periods \
-		openfisca_core/projectors
+		openfisca_core/projectors \
+		openfisca_test
 	@PYTEST_ADDOPTS="$${PYTEST_ADDOPTS} ${pytest_args}" \
 		coverage run -m \
 		${openfisca} test $? \