Switch combined profit response to dataclass

freqtrade/persistence/trade_model.py

@@ -3,6 +3,7 @@ This module contains the class to persist trades into SQLite
 """
 import logging
 from collections import defaultdict
+from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 from math import isclose
 from typing import Any, ClassVar, Dict, List, Optional, Sequence, cast
@@ -26,6 +27,14 @@ from freqtrade.util import FtPrecise, dt_now
 logger = logging.getLogger(__name__)
 
 
+@dataclass
+class ProfitStruct:
+    profit_abs: float
+    profit_ratio: float
+    total_profit: float
+    total_profit_ratio: float
+
+
 class Order(ModelBase):
     """
     Order database model
@@ -906,14 +915,14 @@ class LocalTrade:
         return float(f"{profit:.8f}")
 
     def calc_profit_combined(self, rate: float, amount: Optional[float] = None,
-                             open_rate: Optional[float] = None):
+                             open_rate: Optional[float] = None) -> ProfitStruct:
         """
         Calculate profit metrics (absolute, ratio, total, total ratio).
         All calculations include fees.
         :param rate: close rate to compare with.
         :param amount: Amount to use for the calculation. Falls back to trade.amount if not set.
         :param open_rate: open_rate to use. Defaults to self.open_rate if not provided.
-        :return: TODO: fill me out
+        :return: Profit structure, containing absolute and relative profits.
         """
 
         close_trade_value = self.calc_close_trade_value(rate, amount)
@@ -943,13 +952,13 @@ class LocalTrade:
         )
         total_profit_ratio = float(f"{total_profit_ratio:.8f}")
         profit_abs = float(f"{profit_abs:.8f}")
-        res = {
+
-            'profit_abs': profit_abs,
+        return ProfitStruct(
-            'profit_ratio': profit_ratio,
+            profit_abs=profit_abs,
-            'total_profit': profit_abs + self.realized_profit,
+            profit_ratio=profit_ratio,
-            'total_profit_ratio': total_profit_ratio,
+            total_profit=profit_abs + self.realized_profit,
-        }
+            total_profit_ratio=total_profit_ratio,
-        return res
+        )
 
     def calc_profit_ratio(
             self, rate: float, amount: Optional[float] = None,

tests/persistence/test_persistence.py

@@ -1159,21 +1159,21 @@ def test_calc_profit(
     trade.open_order_id = 'something'
 
     profit_res = trade.calc_profit_combined(close_rate)
-    assert pytest.approx(profit_res['profit_abs']) == round(profit, 8)
+    assert pytest.approx(profit_res.profit_abs) == round(profit, 8)
-    assert pytest.approx(profit_res['profit_ratio']) == round(profit_ratio, 8)
+    assert pytest.approx(profit_res.profit_ratio) == round(profit_ratio, 8)
 
-    assert pytest.approx(profit_res['total_profit']) == round(profit, 8)
+    assert pytest.approx(profit_res.total_profit) == round(profit, 8)
-    # assert pytest.approx(profit_res['total_profit_ratio']) == round(profit_ratio, 8)
+    # assert pytest.approx(profit_res.total_profit_ratio) == round(profit_ratio, 8)
 
     assert pytest.approx(trade.calc_profit(rate=close_rate)) == round(profit, 8)
     assert pytest.approx(trade.calc_profit_ratio(rate=close_rate)) == round(profit_ratio, 8)
 
     profit_res2 = trade.calc_profit_combined(close_rate, trade.amount, trade.open_rate)
-    assert pytest.approx(profit_res2['profit_abs']) == round(profit, 8)
+    assert pytest.approx(profit_res2.profit_abs) == round(profit, 8)
-    assert pytest.approx(profit_res2['profit_ratio']) == round(profit_ratio, 8)
+    assert pytest.approx(profit_res2.profit_ratio) == round(profit_ratio, 8)
 
-    assert pytest.approx(profit_res2['total_profit']) == round(profit, 8)
+    assert pytest.approx(profit_res2.total_profit) == round(profit, 8)
-    # assert pytest.approx(profit_res2['total_profit_ratio']) == round(profit_ratio, 8)
+    # assert pytest.approx(profit_res2.total_profit_ratio) == round(profit_ratio, 8)
 
     assert pytest.approx(trade.calc_profit(close_rate, trade.amount,
                          trade.open_rate)) == round(profit, 8)