bbstrader 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

bbstrader/btengine/execution.py

@@ -1,8 +1,8 @@
-from datetime import datetime
-from queue import Queue
 from abc import ABCMeta, abstractmethod
-from bbstrader.btengine.event import FillEvent, OrderEvent
+from queue import Queue
+
 from bbstrader.btengine.data import DataHandler
+from bbstrader.btengine.event import FillEvent, OrderEvent
 from bbstrader.metatrader.account import Account
 
 __all__ = [
@@ -11,6 +11,7 @@ __all__ = [
     "MT5ExecutionHandler"
 ]
 
+
 class ExecutionHandler(metaclass=ABCMeta):
     """
     The ExecutionHandler abstract class handles the interaction
@@ -84,7 +85,7 @@ class SimExecutionHandler(ExecutionHandler):
             self.events.put(fill_event)
             self.logger.info(
                 f"{event.direction} ORDER FILLED: SYMBOL={event.symbol}, "
-                f"QUANTITY={event.quantity}, PRICE @{event.price} EXCHANGE={fill_event.exchange}", 
+                f"QUANTITY={event.quantity}, PRICE @{event.price} EXCHANGE={fill_event.exchange}",
                 custom_time=fill_event.timeindex
             )
 
@@ -93,16 +94,16 @@ class MT5ExecutionHandler(ExecutionHandler):
     """
     The main role of `MT5ExecutionHandler` class is to estimate the execution fees 
     for different asset classes on the MT5 terminal. 
-    
+
     Generally we have four types of fees when we execute trades using the MT5 terminal 
     (commissions, swap, spread and other fees). But most of these fees depend on the specifications 
     of each instrument and the duration of the transaction for the swap for example. 
-    
+
     Calculating the exact fees for each instrument would be a bit complex because our Backtest engine 
     and the Portfolio class do not take into account the duration of each trade to apply the appropriate 
     rate for the swap for example. So we have to use only the model of calculating the commissions 
     for each asset class and each instrument.
-    
+
     The second thing that must be taken into account on MT5 is the type of account offered by the broker. 
     Brokers have different account categories each with its specifications for each asset class and each instrument. 
     Again considering all these conditions would make our class very complex. So we took the `Raw Spread` 
@@ -113,6 +114,7 @@ class MT5ExecutionHandler(ExecutionHandler):
     NOTE:
         This class only works with `bbstrader.metatrader.data.MT5DataHandler` class.
     """
+
     def __init__(self, events: Queue, data: DataHandler, **kwargs):
         """
         Initialises the handler, setting the event queues up internally.
@@ -134,8 +136,8 @@ class MT5ExecutionHandler(ExecutionHandler):
         if contract_size == 1:
             lot = quantity
         if symbol_type in [
-            'COMD', 'FUT', 'CRYPTO'] and contract_size > 1:
-            lot = quantity  / contract_size
+                'COMD', 'FUT', 'CRYPTO'] and contract_size > 1:
+            lot = quantity / contract_size
         if symbol_type == 'FX':
             lot = (quantity*price / contract_size)
         return self._check_lot(symbol, lot)
@@ -147,7 +149,7 @@ class MT5ExecutionHandler(ExecutionHandler):
         elif lot > symbol_info.volume_max:
             return symbol_info.volume_max
         return round(lot, 2)
-    
+
     def _estimate_total_fees(self, symbol, lot, qty, price):
         symbol_type = self.__account.get_symbol_type(symbol)
         if symbol_type in ['STK', 'ETF']:
@@ -164,16 +166,16 @@ class MT5ExecutionHandler(ExecutionHandler):
             return self._estimate_crypto_commission()
         else:
             return 0.0
-            
+
     def _estimate_stock_commission(self, symbol, qty, price):
         # https://admiralmarkets.com/start-trading/contract-specifications?regulator=jsc
         min_com = 1.0
         min_aud = 8.0
         min_dkk = 30.0
         min_nok = min_sek = 10.0
-        us_com = 0.02 # per chare
-        ger_fr_uk_cm = 0.001 # percent
-        eu_asia_cm = 0.0015 # percent
+        us_com = 0.02  # per chare
+        ger_fr_uk_cm = 0.001  # percent
+        eu_asia_cm = 0.0015  # percent
         if (
             symbol in self.__account.get_stocks_from_country('USA')
             or self.__account.get_symbol_type(symbol) == 'ETF'
@@ -214,7 +216,7 @@ class MT5ExecutionHandler(ExecutionHandler):
 
     def _estimate_crypto_commission(self):
         return 0.0
-    
+
     def execute_order(self, event: OrderEvent):
         """
         Executes an Order event by converting it into a Fill event.
@@ -243,4 +245,4 @@ class MT5ExecutionHandler(ExecutionHandler):
 
 
 class IBExecutionHandler(ExecutionHandler):
-    ...
+    ...

bbstrader/btengine/performance.py

@@ -1,12 +1,12 @@
+import warnings
+
+import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
+import quantstats as qs
 import seaborn as sns
 import yfinance as yf
-from scipy.stats import mstats
-import matplotlib.pyplot as plt
-from matplotlib.ticker import MaxNLocator
-import quantstats as qs
-import warnings
+
 warnings.filterwarnings("ignore")
 
 sns.set_theme()
@@ -37,6 +37,8 @@ def create_sharpe_ratio(returns, periods=252) -> float:
     return qs.stats.sharpe(returns, periods=periods)
 
 # Define a function to calculate the Sortino Ratio
+
+
 def create_sortino_ratio(returns, periods=252) -> float:
     """
     Create the Sortino ratio for the strategy, based on a
@@ -215,7 +217,7 @@ def plot_returns_and_dd(df: pd.DataFrame, benchmark: str, title):
     plt.show()
 
 
-def plot_monthly_yearly_returns(df:pd.DataFrame, title):
+def plot_monthly_yearly_returns(df: pd.DataFrame, title):
     """
     Plot the monthly and yearly returns of the strategy.
 
@@ -295,6 +297,7 @@ def plot_monthly_yearly_returns(df:pd.DataFrame, title):
     # Show the plot
     plt.show()
 
+
 def show_qs_stats(returns, benchmark, strategy_name, save_dir=None):
     """
     Generate the full quantstats report for the strategy.
@@ -317,4 +320,5 @@ def show_qs_stats(returns, benchmark, strategy_name, save_dir=None):
 
     # Generate the full report with a benchmark
     qs.reports.full(returns, mode='full', benchmark=benchmark)
-    qs.reports.html(returns, benchmark=benchmark, output=save_dir, title=strategy_name)
+    qs.reports.html(returns, benchmark=benchmark,
+                    output=save_dir, title=strategy_name)

bbstrader/btengine/portfolio.py

@@ -1,26 +1,21 @@
-import pandas as pd
-from queue import Queue
-from pathlib import Path
 from datetime import datetime
-from bbstrader.btengine.event import (
-    OrderEvent, 
-    FillEvent, 
-    MarketEvent, 
-    SignalEvent
-)
+from pathlib import Path
+from queue import Queue
+
+import pandas as pd
+import quantstats as qs
+
 from bbstrader.btengine.data import DataHandler
+from bbstrader.btengine.event import FillEvent, MarketEvent, OrderEvent, SignalEvent
 from bbstrader.btengine.performance import (
-    create_drawdowns, 
-    create_sharpe_ratio, 
-    create_sortino_ratio, 
-    plot_performance, 
-    show_qs_stats, 
-    plot_returns_and_dd, 
-    plot_monthly_yearly_returns
+    create_drawdowns,
+    create_sharpe_ratio,
+    create_sortino_ratio,
+    plot_monthly_yearly_returns,
+    plot_performance,
+    plot_returns_and_dd,
+    show_qs_stats,
 )
-from bbstrader.config import BBSTRADER_DIR
-import quantstats as qs
-
 
 __all__ = [
     'Portfolio',
@@ -175,7 +170,7 @@ class Portfolio(object):
         d['Commission'] = 0.0
         d['Total'] = self.initial_capital
         return d
-    
+
     def _get_price(self, symbol: str) -> float:
         try:
             price = self.bars.get_latest_bar_value(
@@ -190,7 +185,7 @@ class Portfolio(object):
                 return price
             except AttributeError:
                 raise AttributeError(
-                    f"Bars object must have 'adj_close' or 'close' prices"
+                    "Bars object must have 'adj_close' or 'close' prices"
                 )
 
     def update_timeindex(self, event: MarketEvent):
@@ -285,7 +280,7 @@ class Portfolio(object):
 
         Args:
             signal (SignalEvent): The tuple containing Signal information.
-        
+
         Returns:
             OrderEvent: The OrderEvent to be executed.
         """
@@ -305,19 +300,22 @@ class Portfolio(object):
         else:
             order_type = direction
 
-        if  direction == 'LONG' and new_quantity > 0: 
-            order = OrderEvent(symbol, order_type, new_quantity, 'BUY', price, direction)
+        if direction == 'LONG' and new_quantity > 0:
+            order = OrderEvent(symbol, order_type,
+                               new_quantity, 'BUY', price, direction)
         if direction == 'SHORT' and new_quantity > 0:
-            order = OrderEvent(symbol, order_type, new_quantity, 'SELL', price, direction)
+            order = OrderEvent(symbol, order_type,
+                               new_quantity, 'SELL', price, direction)
 
         if direction == 'EXIT' and cur_quantity > 0:
-            order = OrderEvent(symbol, order_type, abs(cur_quantity), 'SELL', price, direction)
+            order = OrderEvent(symbol, order_type, abs(
+                cur_quantity), 'SELL', price, direction)
         if direction == 'EXIT' and cur_quantity < 0:
-            order = OrderEvent(symbol, order_type, abs(cur_quantity), 'BUY', price, direction)
+            order = OrderEvent(symbol, order_type, abs(
+                cur_quantity), 'BUY', price, direction)
 
         return order
 
-
     def update_signal(self, event: SignalEvent):
         """
         Acts on a SignalEvent to generate new orders
@@ -369,19 +367,20 @@ class Portfolio(object):
         else:
             results_dir = Path('.backtests') / strategy_name
         results_dir.mkdir(parents=True, exist_ok=True)
-        
-        csv_file =  f"{strategy_name}_{now}_equities.csv"
+
+        csv_file = f"{strategy_name}_{now}_equities.csv"
         png_file = f'{strategy_name}_{now}_returns_heatmap.png'
         html_file = f"{strategy_name}_{now}_report.html"
         self.equity_curve.to_csv(results_dir / csv_file)
-        
+
         if self.print_stats:
             plot_performance(self.equity_curve, self.strategy_name)
-            plot_returns_and_dd(self.equity_curve, self.benchmark, self.strategy_name)
-            qs.plots.monthly_heatmap(returns, savefig=f"{results_dir}/{png_file}")
+            plot_returns_and_dd(self.equity_curve,
+                                self.benchmark, self.strategy_name)
+            qs.plots.monthly_heatmap(
+                returns, savefig=f"{results_dir}/{png_file}")
             plot_monthly_yearly_returns(self.equity_curve, self.strategy_name)
-            show_qs_stats(returns, self.benchmark, self.strategy_name, 
-                        save_dir=f"{results_dir}/{html_file}")
+            show_qs_stats(returns, self.benchmark, self.strategy_name,
+                          save_dir=f"{results_dir}/{html_file}")
 
         return stats
-