chore: make VanguardDynamicSpending.calculate_withdrawal_size a private method

Author: chilango74

okama/portfolios/cashflow_strategies.py

@@ -666,9 +666,9 @@ def indexation(self, indexation: Optional[float]):
             self._clear_cf_cache()
             self._indexation = indexation
 
-    def calculate_withdrawal_size(self, last_withdrawal: float, balance: float, number_of_periods: int) -> float:
+    def _calculate_withdrawal_size(self, last_withdrawal: float, balance: float, number_of_periods: int) -> float:
         """
-        Calculate regular withdrawal size (Extra Withdrawals are not taken into account).
+        Calculate regular withdrawal size (Extra Withdrawals are not taken into account). Used in helpers.
 
         Parameters
         ----------
@@ -829,9 +829,9 @@ def crash_threshold_reduction(self, value):
         self._crash_threshold_reduction = value
 
 
-    def calculate_withdrawal_size(self, drawdown: float, withdrawal_without_drawdowns: float) -> float:
+    def _calculate_withdrawal_size(self, drawdown: float, withdrawal_without_drawdowns: float) -> float:
         """
-        Calculate regular withdrawal size (Extra Withdrawals are not taken into account).
+        Calculate regular withdrawal size (Extra Withdrawals are not taken into account). Used in helpers.
 
         Parameters
         ----------

okama/portfolios/dcf_calculations.py

@@ -77,7 +77,7 @@ def get_wealth_indexes_fv_with_cashflow(
             elif cashflow_parameters.NAME == "CWID":
                 withdrawal_without_drawdowns = amount * (1 + indexation_per_period) ** n
                 if drawdowns[date] < 0:
-                    cashflow = cashflow_parameters.calculate_withdrawal_size(
+                    cashflow = cashflow_parameters._calculate_withdrawal_size(
                         drawdown=drawdowns[date],
                         withdrawal_without_drawdowns=withdrawal_without_drawdowns,
                     )
@@ -116,15 +116,15 @@ def get_wealth_indexes_fv_with_cashflow(
             elif cashflow_parameters.NAME == "fixed_percentage":
                 cashflow_value = cashflow_parameters.percentage / periods_per_year * period_initial_amount
             elif cashflow_parameters.NAME == "VDS":
-                cashflow_value = cashflow_parameters.calculate_withdrawal_size(
+                cashflow_value = cashflow_parameters._calculate_withdrawal_size(
                     last_withdrawal=last_regular_cash_flow if n > 0 else 0,
                     balance=period_initial_amount,
                     number_of_periods=n,
                 )
             elif cashflow_parameters.NAME == "CWID":
                 withdrawal_without_drawdowns = amount * (1 + indexation_per_period) ** n
                 if drawdowns[last_date] < 0:
-                    cashflow_value = cashflow_parameters.calculate_withdrawal_size(
+                    cashflow_value = cashflow_parameters._calculate_withdrawal_size(
                         drawdown=drawdowns[last_date],
                         withdrawal_without_drawdowns=withdrawal_without_drawdowns,
                     )
@@ -218,7 +218,7 @@ def get_cash_flow_fv(
             elif cashflow_parameters.NAME == "CWID":
                 withdrawal_without_drawdowns = amount * (1 + indexation_per_period) ** n
                 if drawdowns[date] < 0:
-                    cashflow = cashflow_parameters.calculate_withdrawal_size(
+                    cashflow = cashflow_parameters._calculate_withdrawal_size(
                         drawdown = drawdowns[date],
                         withdrawal_without_drawdowns = withdrawal_without_drawdowns,
                     )
@@ -258,15 +258,15 @@ def get_cash_flow_fv(
             elif cashflow_parameters.NAME == "fixed_percentage":
                 cashflow_value = cashflow_parameters.percentage / periods_per_year * period_initial_amount
             elif cashflow_parameters.NAME == "VDS":
-                cashflow_value = cashflow_parameters.calculate_withdrawal_size(
+                cashflow_value = cashflow_parameters._calculate_withdrawal_size(
                     last_withdrawal=last_regular_cash_flow if n > 0 else 0,
                     balance=period_initial_amount,
                     number_of_periods=n,
                 )
             elif cashflow_parameters.NAME == "CWID":
                 withdrawal_without_drawdowns = amount * (1 + indexation_per_period) ** n
                 if drawdowns[last_date] < 0:
-                    cashflow_value = cashflow_parameters.calculate_withdrawal_size(
+                    cashflow_value = cashflow_parameters._calculate_withdrawal_size(
                         drawdown = drawdowns[last_date],
                         withdrawal_without_drawdowns = withdrawal_without_drawdowns,
                     )