Skip to content

Commit 858d2e3

Browse files
committed
docs(core_population): fix types
1 parent c14cfb9 commit 858d2e3

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

openfisca_core/populations/_core_population.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,12 @@ class CorePopulation:
4646
#: The :class:`.Simulation` for which the population is calculated.
4747
simulation: None | t.Simulation = None
4848

49+
#: The holders of the variables.
50+
_holders: t.HolderByVariable[t.VarDType]
51+
4952
def __init__(self, entity: t.CoreEntity, *__args: object, **__kwds: object) -> None:
5053
self.entity = entity
51-
self._holders: t.HolderByVariable = {}
54+
self._holders = {}
5255

5356
def __call__(
5457
self,
@@ -337,7 +340,7 @@ def check_period_validity(
337340

338341
# Helpers
339342

340-
def get_holder(self, variable_name: t.VariableName) -> t.Holder:
343+
def get_holder(self, variable_name: t.VariableName) -> t.Holder[t.VarDType]:
341344
"""Return the holder of a variable.
342345
343346
Args:
@@ -388,8 +391,10 @@ def get_holder(self, variable_name: t.VariableName) -> t.Holder:
388391
if holder:
389392
return holder
390393
variable = self.entity.get_variable(variable_name)
391-
self._holders[variable_name] = holder = holders.Holder(variable, self)
392-
return holder
394+
if variable is None:
395+
raise NotImplementedError
396+
self._holders[variable_name] = holders.Holder(variable, self)
397+
return self._holders[variable_name]
393398

394399
def get_memory_usage(
395400
self,

openfisca_core/types.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -254,21 +254,21 @@ def _on_disk_storable(self, /) -> bool: ...
254254
def _do_not_store(self, /) -> bool: ...
255255
def clone(self, __population: CorePopulation, /) -> Holder[_N]: ...
256256
def create_disk_storage(
257-
self, /, __dir: None | str = ..., __preserve: bool = ...
257+
self, __dir: None | str = ..., __preserve: bool = ..., /
258258
) -> OnDiskStorage[_N]: ...
259-
def delete_arrays(self, /, __period: None | Period = None) -> None: ...
260-
def get_array(self, /, __period: Period) -> None | Array[_N]: ...
259+
def delete_arrays(self, __period: None | Period = None, /) -> None: ...
260+
def get_array(self, __period: Period, /) -> None | Array[_N]: ...
261261
def get_memory_usage(self, /) -> MemoryUsage: ...
262262
def get_known_periods(self) -> list[Period]: ...
263263
def set_input(
264264
self,
265-
/,
266265
__period: Period,
267266
__array: Array[_N] | ArrayLike[_L],
267+
/,
268268
) -> None | Array[_N]: ...
269-
def put_in_cache(self, /, __value: Array[_N], period: Period) -> None: ...
269+
def put_in_cache(self, __value: Array[_N], period: Period, /) -> None: ...
270270
def default_array(self, /) -> Array[_N]: ...
271-
def _set(self, /, __period: None | Period, __value: Array[_N]) -> None: ...
271+
def _set(self, __period: None | Period, __value: Array[_N], /) -> None: ...
272272
def _to_array(self, __value: Array[_N] | ArrayLike[_L], /) -> Array[_N]: ...
273273

274274

@@ -427,9 +427,11 @@ def count(self, /) -> int: ...
427427
@property
428428
def entity(self, /) -> CoreEntity: ...
429429
@property
430-
def ids(self, /) -> StrArray: ...
430+
def ids(self, /) -> ArrayLike[str]: ...
431431
@property
432432
def simulation(self, /) -> None | Simulation: ...
433+
@property
434+
def _holders(self, /) -> HolderByVariable[_N]: ...
433435

434436

435437
class SinglePopulation(CorePopulation, Protocol):
@@ -464,7 +466,7 @@ def tax_benefit_system(self, /) -> TaxBenefitSystem: ...
464466
def trace(self, /) -> bool: ...
465467
@property
466468
def tracer(self, /) -> FullTracer: ...
467-
def calculate(self, __name: VariableName, period__: Period, /) -> VarArray: ...
469+
def calculate(self, __name: VariableName, __period: Period, /) -> VarArray: ...
468470
def calculate_add(self, __name: VariableName, __period: Period, /) -> VarArray: ...
469471
def calculate_divide(
470472
self, __name: VariableName, __period: Period, /

0 commit comments

Comments
 (0)