BREAKING CHANGE: remove CoreEntity.set_tax_benefit_system

The feature is now provided by simple variable assignment:

```python
entity.tax_benefit_system = tax_benefit_system
```

Likewise, `entity.tax_benefit_system` becomes part of the public API
(which implicitly it was as the private marker was being violated).

Author: bonjourmauko

openfisca_core/entities/_core_entity.py

@@ -44,18 +44,14 @@ class CoreEntity:
     is_person: ClassVar[bool]
 
     #: A ``TaxBenefitSystem`` instance.
-    _tax_benefit_system: None | t.TaxBenefitSystem = None
+    tax_benefit_system: None | t.TaxBenefitSystem = None
 
     @abc.abstractmethod
     def __init__(self, *__args: object, **__kwargs: object) -> None: ...
 
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}({self.key})"
 
-    def set_tax_benefit_system(self, tax_benefit_system: t.TaxBenefitSystem) -> None:
-        """A ``CoreEntity`` belongs to a ``TaxBenefitSystem``."""
-        self._tax_benefit_system = tax_benefit_system
-
     def get_variable(
         self,
         variable_name: t.VariableName,
@@ -92,7 +88,7 @@ def get_variable(
             ValueError: You must set 'tax_benefit_system' before calling this...
 
             >>> tax_benefit_system = taxbenefitsystems.TaxBenefitSystem([this])
-            >>> this.set_tax_benefit_system(tax_benefit_system)
+            >>> this.tax_benefit_system = tax_benefit_system
 
             >>> this.get_variable("tax")
 
@@ -105,19 +101,18 @@ def get_variable(
             ...     value_type = float
             ...     entity = that
 
-            >>> this._tax_benefit_system.add_variable(tax)
+            >>> this.tax_benefit_system.add_variable(tax)
             <openfisca_core.entities._core_entity.tax object at ...>
 
             >>> this.get_variable("tax")
             <openfisca_core.entities._core_entity.tax object at ...>
 
+
         """
-        if self._tax_benefit_system is None:
-            msg = "You must set 'tax_benefit_system' before calling this method."
-            raise ValueError(
-                msg,
-            )
-        return self._tax_benefit_system.get_variable(variable_name, check_existence)
+        if self.tax_benefit_system is None:
+            msg = "You must set 'tax_benefit_system' to call this method."
+            raise ValueError(msg)
+        return self.tax_benefit_system.get_variable(variable_name, check_existence)
 
     def check_variable_defined_for_entity(self, variable_name: t.VariableName) -> None:
         """Check if ``variable_name`` is defined for ``self``.
@@ -140,7 +135,7 @@ def check_variable_defined_for_entity(self, variable_name: t.VariableName) -> No
             >>> this = entities.SingleEntity("this", "", "", "")
             >>> that = entities.SingleEntity("that", "", "", "")
             >>> tax_benefit_system = taxbenefitsystems.TaxBenefitSystem([that])
-            >>> this.set_tax_benefit_system(tax_benefit_system)
+            >>> this.tax_benefit_system = tax_benefit_system
 
             >>> this.check_variable_defined_for_entity("tax")
             Traceback (most recent call last):
@@ -151,7 +146,7 @@ def check_variable_defined_for_entity(self, variable_name: t.VariableName) -> No
             ...     value_type = int
             ...     entity = that
 
-            >>> this._tax_benefit_system.add_variable(tax)
+            >>> this.tax_benefit_system.add_variable(tax)
             <openfisca_core.entities._core_entity.tax object at ...>
 
             >>> this.check_variable_defined_for_entity("tax")
@@ -160,7 +155,7 @@ def check_variable_defined_for_entity(self, variable_name: t.VariableName) -> No
 
             >>> tax.entity = this
 
-            >>> this._tax_benefit_system.update_variable(tax)
+            >>> this.tax_benefit_system.update_variable(tax)
             <openfisca_core.entities._core_entity.tax object at ...>
 
             >>> this.check_variable_defined_for_entity("tax")

openfisca_core/populations/_core_population.py

@@ -87,7 +87,7 @@ def __call__(
             >>> population("salary", period)
 
             >>> tbs = taxbenefitsystems.TaxBenefitSystem([person])
-            >>> person.set_tax_benefit_system(tbs)
+            >>> person.tax_benefit_system = tbs
             >>> simulation = simulations.Simulation(tbs, {person.key: population})
             >>> population("salary", period)
             Traceback (most recent call last):
@@ -365,7 +365,7 @@ def get_holder(self, variable_name: t.VariableName) -> t.Holder:
             ...     value_type = int
 
             >>> tbs = taxbenefitsystems.TaxBenefitSystem([person])
-            >>> person.set_tax_benefit_system(tbs)
+            >>> person.tax_benefit_system = tbs
             >>> population = populations.SinglePopulation(person)
             >>> simulation = simulations.Simulation(tbs, {person.key: population})
             >>> population.get_holder("income_tax")

openfisca_core/taxbenefitsystems/tax_benefit_system.py

@@ -72,7 +72,7 @@ def __init__(self, entities: Sequence[Entity]) -> None:
             entity for entity in self.entities if not entity.is_person
         ]
         for entity in self.entities:
-            entity.set_tax_benefit_system(self)
+            entity.tax_benefit_system = self
 
     @property
     def base_tax_benefit_system(self):
@@ -572,7 +572,7 @@ def clone(self):
             ):
                 new_dict[key] = value
         for entity in new_dict["entities"]:
-            entity.set_tax_benefit_system(new)
+            entity.tax_benefit_system = new
 
         new_dict["parameters"] = self.parameters.clone()
         new_dict["_parameters_at_instant_cache"] = {}

openfisca_core/types.py

@@ -262,6 +262,8 @@ def get_population(self, plural: None | str, /) -> CorePopulation: ...
 class TaxBenefitSystem(Protocol):
     person_entity: SingleEntity
 
+    @property
+    def variables(self, /) -> dict[VariableName, Variable]: ...
     def get_variable(
         self,
         variable_name: VariableName,

tests/core/tools/test_runner/test_yaml_runner.py

@@ -15,7 +15,7 @@ class TaxBenefitSystem:
     def __init__(self) -> None:
         self.variables = {"salary": TestVariable()}
         self.person_entity = Entity("person", "persons", None, "")
-        self.person_entity.set_tax_benefit_system(self)
+        self.person_entity.tax_benefit_system = self
 
     def get_package_metadata(self):
         return {"name": "Test", "version": "Test"}