OpenFisca-Core-test 46.0.0__py3-none-any.whl

openfisca_core/periods/tests/test_period.py

@@ -0,0 +1,283 @@
+import pytest
+
+from openfisca_core.periods import DateUnit, Instant, Period
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 1, "2022"),
+        (DateUnit.MONTH, Instant((2022, 1, 1)), 12, "2022"),
+        (DateUnit.YEAR, Instant((2022, 3, 1)), 1, "year:2022-03"),
+        (DateUnit.MONTH, Instant((2022, 3, 1)), 12, "year:2022-03"),
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 3, "year:2022:3"),
+        (DateUnit.YEAR, Instant((2022, 1, 3)), 3, "year:2022:3"),
+    ],
+)
+def test_str_with_years(date_unit, instant, size, expected) -> None:
+    assert str(Period((date_unit, instant, size))) == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.MONTH, Instant((2022, 1, 1)), 1, "2022-01"),
+        (DateUnit.MONTH, Instant((2022, 1, 1)), 3, "month:2022-01:3"),
+        (DateUnit.MONTH, Instant((2022, 3, 1)), 3, "month:2022-03:3"),
+    ],
+)
+def test_str_with_months(date_unit, instant, size, expected) -> None:
+    assert str(Period((date_unit, instant, size))) == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.DAY, Instant((2022, 1, 1)), 1, "2022-01-01"),
+        (DateUnit.DAY, Instant((2022, 1, 1)), 3, "day:2022-01-01:3"),
+        (DateUnit.DAY, Instant((2022, 3, 1)), 3, "day:2022-03-01:3"),
+    ],
+)
+def test_str_with_days(date_unit, instant, size, expected) -> None:
+    assert str(Period((date_unit, instant, size))) == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.WEEK, Instant((2022, 1, 1)), 1, "2021-W52"),
+        (DateUnit.WEEK, Instant((2022, 1, 1)), 3, "week:2021-W52:3"),
+        (DateUnit.WEEK, Instant((2022, 3, 1)), 1, "2022-W09"),
+        (DateUnit.WEEK, Instant((2022, 3, 1)), 3, "week:2022-W09:3"),
+    ],
+)
+def test_str_with_weeks(date_unit, instant, size, expected) -> None:
+    assert str(Period((date_unit, instant, size))) == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.WEEKDAY, Instant((2022, 1, 1)), 1, "2021-W52-6"),
+        (DateUnit.WEEKDAY, Instant((2022, 1, 1)), 3, "weekday:2021-W52-6:3"),
+        (DateUnit.WEEKDAY, Instant((2022, 3, 1)), 1, "2022-W09-2"),
+        (DateUnit.WEEKDAY, Instant((2022, 3, 1)), 3, "weekday:2022-W09-2:3"),
+    ],
+)
+def test_str_with_weekdays(date_unit, instant, size, expected) -> None:
+    assert str(Period((date_unit, instant, size))) == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2022, 12, 1)), 1, 1),
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 2, 2),
+    ],
+)
+def test_size_in_years(date_unit, instant, size, expected) -> None:
+    period = Period((date_unit, instant, size))
+    assert period.size_in_years == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2020, 1, 1)), 1, 12),
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 2, 24),
+        (DateUnit.MONTH, Instant((2012, 1, 3)), 3, 3),
+    ],
+)
+def test_size_in_months(date_unit, instant, size, expected) -> None:
+    period = Period((date_unit, instant, size))
+    assert period.size_in_months == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2022, 12, 1)), 1, 365),
+        (DateUnit.YEAR, Instant((2020, 1, 1)), 1, 366),
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 2, 730),
+        (DateUnit.MONTH, Instant((2022, 12, 1)), 1, 31),
+        (DateUnit.MONTH, Instant((2020, 2, 3)), 1, 29),
+        (DateUnit.MONTH, Instant((2022, 1, 3)), 3, 31 + 28 + 31),
+        (DateUnit.MONTH, Instant((2012, 1, 3)), 3, 31 + 29 + 31),
+        (DateUnit.DAY, Instant((2022, 12, 31)), 1, 1),
+        (DateUnit.DAY, Instant((2022, 12, 31)), 3, 3),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 1, 7),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 3, 21),
+        (DateUnit.WEEKDAY, Instant((2022, 12, 31)), 1, 1),
+        (DateUnit.WEEKDAY, Instant((2022, 12, 31)), 3, 3),
+    ],
+)
+def test_size_in_days(date_unit, instant, size, expected) -> None:
+    period = Period((date_unit, instant, size))
+    assert period.size_in_days == expected
+    assert period.size_in_days == period.days
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2022, 12, 1)), 1, 52),
+        (DateUnit.YEAR, Instant((2020, 1, 1)), 5, 261),
+        (DateUnit.MONTH, Instant((2022, 12, 1)), 1, 4),
+        (DateUnit.MONTH, Instant((2020, 2, 3)), 1, 4),
+        (DateUnit.MONTH, Instant((2022, 1, 3)), 3, 12),
+        (DateUnit.MONTH, Instant((2012, 1, 3)), 3, 13),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 1, 1),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 3, 3),
+    ],
+)
+def test_size_in_weeks(date_unit, instant, size, expected) -> None:
+    period = Period((date_unit, instant, size))
+    assert period.size_in_weeks == expected
+
+
+@pytest.mark.parametrize(
+    ("date_unit", "instant", "size", "expected"),
+    [
+        (DateUnit.YEAR, Instant((2022, 12, 1)), 1, 364),
+        (DateUnit.YEAR, Instant((2020, 1, 1)), 1, 364),
+        (DateUnit.YEAR, Instant((2022, 1, 1)), 2, 728),
+        (DateUnit.MONTH, Instant((2022, 12, 1)), 1, 31),
+        (DateUnit.MONTH, Instant((2020, 2, 3)), 1, 29),
+        (DateUnit.MONTH, Instant((2022, 1, 3)), 3, 31 + 28 + 31),
+        (DateUnit.MONTH, Instant((2012, 1, 3)), 3, 31 + 29 + 31),
+        (DateUnit.DAY, Instant((2022, 12, 31)), 1, 1),
+        (DateUnit.DAY, Instant((2022, 12, 31)), 3, 3),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 1, 7),
+        (DateUnit.WEEK, Instant((2022, 12, 31)), 3, 21),
+        (DateUnit.WEEKDAY, Instant((2022, 12, 31)), 1, 1),
+        (DateUnit.WEEKDAY, Instant((2022, 12, 31)), 3, 3),
+    ],
+)
+def test_size_in_weekdays(date_unit, instant, size, expected) -> None:
+    period = Period((date_unit, instant, size))
+    assert period.size_in_weekdays == expected
+
+
+@pytest.mark.parametrize(
+    ("period_unit", "sub_unit", "instant", "start", "cease", "count"),
+    [
+        (
+            DateUnit.YEAR,
+            DateUnit.YEAR,
+            Instant((2022, 12, 31)),
+            Instant((2022, 1, 1)),
+            Instant((2024, 1, 1)),
+            3,
+        ),
+        (
+            DateUnit.YEAR,
+            DateUnit.MONTH,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 1)),
+            Instant((2025, 11, 1)),
+            36,
+        ),
+        (
+            DateUnit.YEAR,
+            DateUnit.DAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2025, 12, 30)),
+            1096,
+        ),
+        (
+            DateUnit.YEAR,
+            DateUnit.WEEK,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 26)),
+            Instant((2025, 12, 15)),
+            156,
+        ),
+        (
+            DateUnit.YEAR,
+            DateUnit.WEEKDAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2025, 12, 26)),
+            1092,
+        ),
+        (
+            DateUnit.MONTH,
+            DateUnit.MONTH,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 1)),
+            Instant((2023, 2, 1)),
+            3,
+        ),
+        (
+            DateUnit.MONTH,
+            DateUnit.DAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 3, 30)),
+            90,
+        ),
+        (
+            DateUnit.DAY,
+            DateUnit.DAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 2)),
+            3,
+        ),
+        (
+            DateUnit.DAY,
+            DateUnit.WEEKDAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 2)),
+            3,
+        ),
+        (
+            DateUnit.WEEK,
+            DateUnit.DAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 20)),
+            21,
+        ),
+        (
+            DateUnit.WEEK,
+            DateUnit.WEEK,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 26)),
+            Instant((2023, 1, 9)),
+            3,
+        ),
+        (
+            DateUnit.WEEK,
+            DateUnit.WEEKDAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 20)),
+            21,
+        ),
+        (
+            DateUnit.WEEKDAY,
+            DateUnit.DAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 2)),
+            3,
+        ),
+        (
+            DateUnit.WEEKDAY,
+            DateUnit.WEEKDAY,
+            Instant((2022, 12, 31)),
+            Instant((2022, 12, 31)),
+            Instant((2023, 1, 2)),
+            3,
+        ),
+    ],
+)
+def test_subperiods(period_unit, sub_unit, instant, start, cease, count) -> None:
+    period = Period((period_unit, instant, 3))
+    subperiods = period.get_subperiods(sub_unit)
+    assert len(subperiods) == count
+    assert subperiods[0] == Period((sub_unit, start, 1))
+    assert subperiods[-1] == Period((sub_unit, cease, 1))

openfisca_core/populations/__init__.py

@@ -0,0 +1,64 @@
+# Transitional imports to ensure non-breaking changes.
+# Could be deprecated in the next major release.
+#
+# How imports are being used today:
+#
+#   >>> from openfisca_core.module import symbol
+#
+# The previous example provokes cyclic dependency problems
+# that prevent us from modularizing the different components
+# of the library so to make them easier to test and to maintain.
+#
+# How could them be used after the next major release:
+#
+#   >>> from openfisca_core import module
+#   >>> module.symbol()
+#
+# And for classes:
+#
+#   >>> from openfisca_core.module import Symbol
+#   >>> Symbol()
+#
+# See: https://www.python.org/dev/peps/pep-0008/#imports
+
+from openfisca_core.projectors import (
+    EntityToPersonProjector,
+    FirstPersonToEntityProjector,
+    Projector,
+    UniqueRoleToEntityProjector,
+)
+from openfisca_core.projectors.helpers import get_projector_from_shortcut, projectable
+
+from . import types
+from ._core_population import CorePopulation
+from ._errors import (
+    IncompatibleOptionsError,
+    InvalidArraySizeError,
+    InvalidOptionError,
+    PeriodValidityError,
+)
+from .group_population import GroupPopulation
+from .population import Population
+
+ADD, DIVIDE = types.Option
+SinglePopulation = Population
+
+__all__ = [
+    "ADD",
+    "DIVIDE",
+    "CorePopulation",
+    "EntityToPersonProjector",
+    "FirstPersonToEntityProjector",
+    "GroupPopulation",
+    "IncompatibleOptionsError",
+    "InvalidArraySizeError",
+    "InvalidOptionError",
+    "PeriodValidityError",
+    "Population",
+    "Projector",
+    "SinglePopulation",
+    "UniqueRoleToEntityProjector",
+    "get_projector_from_shortcut",
+    "projectable",
+    "types",
+]