ENH: Add the possibility to close trades at end of bt.run (kernc#273 & kernc#343)

Author: Benouare

CHANGELOG.md

@@ -4,7 +4,8 @@ What's New
 These were the major changes contributing to each release:
 
 
-### 0.x.x
+### 0.3.2
+* new param on run to manage close, or not the trades at end (#273)
 
 
 ### 0.3.1
@@ -114,4 +115,4 @@ These were the major changes contributing to each release:
 ### 0.1.0
 (2019-01-15)
 
-* Initial release
+* Initial release

backtesting/backtesting.py

@@ -984,7 +984,8 @@ def __init__(self,
                  margin: float = 1.,
                  trade_on_close=False,
                  hedging=False,
-                 exclusive_orders=False
+                 exclusive_orders=False,
+                 close_all_at_end=False
                  ):
         """
         Initialize a backtest. Requires data and a strategy to test.
@@ -1029,6 +1030,9 @@ def __init__(self,
         trade/position, making at most a single trade (long or short) in effect
         at each time.
 
+        if 'close_all_at_end' is 'False', the trade will not be close at end,
+        and will not apear in _Stats.
+
         [FIFO]: https://www.investopedia.com/terms/n/nfa-compliance-rule-2-43b.asp
         """
 
@@ -1078,7 +1082,7 @@ def __init__(self,
             warnings.warn('Data index is not datetime. Assuming simple periods, '
                           'but `pd.DateTimeIndex` is advised.',
                           stacklevel=2)
-
+        self._close_all_at_end = bool(close_all_at_end)
         self._data: pd.DataFrame = data
         self._broker = partial(
             _Broker, cash=cash, commission=commission, margin=margin,
@@ -1164,14 +1168,15 @@ def run(self, **kwargs) -> pd.Series:
                 # Next tick, a moment before bar close
                 strategy.next()
             else:
-                # Close any remaining open trades so they produce some stats
-                for trade in broker.trades:
-                    trade.close()
-
-                # Re-run broker one last time to handle orders placed in the last strategy
-                # iteration. Use the same OHLC values as in the last broker iteration.
-                if start < len(self._data):
-                    try_(broker.next, exception=_OutOfMoneyError)
+                if self._close_all_at_end is True:
+                    # Close any remaining open trades so they produce some stats
+                    for trade in broker.trades:
+                        trade.close()
+
+                    # Re-run broker one last time to handle orders placed in the last strategy
+                    # iteration. Use the same OHLC values as in the last broker iteration.
+                    if start < len(self._data):
+                        try_(broker.next, exception=_OutOfMoneyError)
 
             # Set data back to full length
             # for future `indicator._opts['data'].index` calls to work

backtesting/test/_test.py

@@ -398,6 +398,31 @@ def next(self):
 
         self.assertFalse(Backtest(SHORT_DATA, S).run()._trades.empty)
 
+    def test_dont_close_orders_from_last_strategy_iteration(self):
+        class S(Strategy):
+            def init(self): pass
+
+            def next(self):
+                if not self.position:
+                    self.buy()
+                elif len(self.data) == len(SHORT_DATA):
+                    self.position.close()
+        self.assertEqual(len(
+            Backtest(SHORT_DATA, S, close_all_at_end=False).run()._strategy.closed_trades), 0)
+        self.assertEqual(len(
+            Backtest(SHORT_DATA, S, close_all_at_end=False).run()._strategy.trades), 1)
+
+    def test_dont_close_orders_trades_from_last_strategy_iteration(self):
+        class S(Strategy):
+            def init(self): pass
+
+            def next(self):
+                if not self.position:
+                    self.buy()
+
+        self.assertEqual(len(
+            Backtest(SHORT_DATA, S, close_all_at_end=False).run()._strategy.trades), 1)
+
     def test_check_adjusted_price_when_placing_order(self):
         class S(Strategy):
             def init(self): pass