bbstrader 0.2.991__py3-none-any.whl → 0.3.1__py3-none-any.whl

bbstrader/metatrader/copier.py

@@ -1,10 +1,11 @@
 import multiprocessing
+import threading
 import time
 from datetime import datetime
 from pathlib import Path
 from typing import Dict, List, Literal, Tuple
 
-from loguru import logger
+from loguru import logger as log
 
 from bbstrader.config import BBSTRADER_DIR
 from bbstrader.metatrader.account import Account, check_mt5_connection
@@ -20,12 +21,14 @@ except ImportError:
 __all__ = ["TradeCopier", "RunCopier", "RunMultipleCopier", "config_copier"]
 
 
-logger.add(
+log.add(
     f"{BBSTRADER_DIR}/logs/copier.log",
     enqueue=True,
     level="INFO",
     format="{time:YYYY-MM-DD HH:mm:ss} | {level} | {name} | {message}",
 )
+global logger
+logger = log
 
 
 def fix_lot(fixed):
@@ -113,11 +116,21 @@ def calculate_copy_lot(
         raise ValueError("Invalid mode selected")
 
 
-def get_copy_symbols(destination: dict = None):
+def get_copy_symbols(destination: dict, source: dict):
     symbols = destination.get("symbols", "all")
-    account = Account(**destination)
+    src_account = Account(**source)
+    dest_account = Account(**destination)
     if symbols == "all" or symbols == "*":
-        return account.get_symbols()
+        src_symbols = src_account.get_symbols()
+        dest_symbols = dest_account.get_symbols()
+        for s in src_symbols:
+            if s not in dest_symbols:
+                err_msg = (
+                    f"To use 'all' or '*', Source account@{src_account.number} "
+                    f"and destination account@{dest_account.number} "
+                    f"must be the same type and have the same symbols"
+                )
+                raise ValueError(err_msg)
     elif isinstance(symbols, (list, dict)):
         return symbols
     elif isinstance(symbols, str):
@@ -127,22 +140,6 @@ def get_copy_symbols(destination: dict = None):
             return symbols.split()
 
 
-def get_copy_symbol(symbol, destination: dict = None, type="destination"):
-    symbols = get_copy_symbols(destination)
-    if isinstance(symbols, list):
-        if symbol in symbols:
-            return symbol
-    if isinstance(symbols, dict):
-        if type == "destination":
-            if symbol in symbols.keys():
-                return symbols[symbol]
-        if type == "source":
-            for k, v in symbols.items():
-                if v == symbol:
-                    return k
-    raise ValueError(f"Symbol {symbol} not found in {type} account")
-
-
 class TradeCopier(object):
     """
     ``TradeCopier`` responsible for copying trading orders and positions from a source account to multiple destination accounts.
@@ -159,7 +156,10 @@ class TradeCopier(object):
         "sleeptime",
         "start_time",
         "end_time",
+        "shutdown_event",
+        "custom_logger",
     )
+    shutdown_event: threading.Event
 
     def __init__(
         self,
@@ -168,6 +168,8 @@ class TradeCopier(object):
         sleeptime: float = 0.1,
         start_time: str = None,
         end_time: str = None,
+        shutdown_event=None,
+        custom_logger=None,
     ):
         """
         Initializes the ``TradeCopier`` instance, setting up the source and destination trading accounts for trade copying.
@@ -245,8 +247,15 @@ class TradeCopier(object):
         self.sleeptime = sleeptime
         self.start_time = start_time
         self.end_time = end_time
-        self.errors = set()
+        self.shutdown_event = shutdown_event
+        self._add_logger(custom_logger)
         self._add_copy()
+        self.errors = set()
+
+    def _add_logger(self, custom_logger):
+        if custom_logger:
+            global logger
+            logger = custom_logger
 
     def _add_copy(self):
         self.source["copy"] = True
@@ -269,6 +278,21 @@ class TradeCopier(object):
         check_mt5_connection(**destination)
         return Account(**destination).get_positions(symbol=symbol)
 
+    def get_copy_symbol(self, symbol, destination: dict = None, type="destination"):
+        symbols = get_copy_symbols(destination, self.source)
+        if isinstance(symbols, list):
+            if symbol in symbols:
+                return symbol
+        if isinstance(symbols, dict):
+            if type == "destination":
+                if symbol in symbols.keys():
+                    return symbols[symbol]
+            if type == "source":
+                for k, v in symbols.items():
+                    if v == symbol:
+                        return k
+        raise ValueError(f"Symbol {symbol} not found in {type} account")
+
     def isorder_modified(self, source: TradeOrder, dest: TradeOrder):
         if source.type == dest.type and source.ticket == dest.magic:
             return (
@@ -302,10 +326,9 @@ class TradeCopier(object):
         if self.start_time is None or self.end_time is None:
             return True
         else:
-            now = datetime.now()
             start_time = datetime.strptime(self.start_time, "%H:%M").time()
             end_time = datetime.strptime(self.end_time, "%H:%M").time()
-            if start_time <= now.time() <= end_time:
+            if start_time <= datetime.now().time() <= end_time:
                 return True
             return False
 
@@ -316,7 +339,7 @@ class TradeCopier(object):
             return
         check_mt5_connection(**destination)
         volume = trade.volume if hasattr(trade, "volume") else trade.volume_initial
-        symbol = get_copy_symbol(trade.symbol, destination)
+        symbol = self.get_copy_symbol(trade.symbol, destination)
         lot = calculate_copy_lot(
             volume,
             symbol,
@@ -327,7 +350,9 @@ class TradeCopier(object):
             dest_eqty=Account(**destination).get_account_info().margin_free,
         )
 
-        trade_instance = Trade(symbol=symbol, **destination, max_risk=100.0)
+        trade_instance = Trade(
+            symbol=symbol, **destination, max_risk=100.0, logger=None
+        )
         try:
             action = action_type[trade.type]
         except KeyError:
@@ -395,7 +420,7 @@ class TradeCopier(object):
 
     def remove_order(self, src_symbol, order: TradeOrder, destination: dict):
         check_mt5_connection(**destination)
-        trade = Trade(symbol=order.symbol, **destination)
+        trade = Trade(symbol=order.symbol, **destination, logger=None)
         if trade.close_order(order.ticket, id=order.magic):
             logger.info(
                 f"Close Order #{order.ticket} on @{destination.get('login')}::{order.symbol}, "
@@ -438,7 +463,7 @@ class TradeCopier(object):
 
     def remove_position(self, src_symbol, position: TradePosition, destination: dict):
         check_mt5_connection(**destination)
-        trade = Trade(symbol=position.symbol, **destination)
+        trade = Trade(symbol=position.symbol, **destination, logger=None)
         if trade.close_position(position.ticket, id=position.magic):
             logger.info(
                 f"Close Position #{position.ticket} on @{destination.get('login')}::{position.symbol}, "
@@ -464,7 +489,7 @@ class TradeCopier(object):
 
     def get_positions(self, destination: dict):
         source_positions = self.source_positions() or []
-        dest_symbols = get_copy_symbols(destination)
+        dest_symbols = get_copy_symbols(destination, self.source)
         dest_positions = self.destination_positions(destination) or []
         source_positions = self.filter_positions_and_orders(
             source_positions, symbols=dest_symbols
@@ -476,7 +501,7 @@ class TradeCopier(object):
 
     def get_orders(self, destination: dict):
         source_orders = self.source_orders() or []
-        dest_symbols = get_copy_symbols(destination)
+        dest_symbols = get_copy_symbols(destination, self.source)
         dest_orders = self.destination_orders(destination) or []
         source_orders = self.filter_positions_and_orders(
             source_orders, symbols=dest_symbols
@@ -512,7 +537,7 @@ class TradeCopier(object):
         source_ids = [order.ticket for order in source_orders]
         for destination_order in destination_orders:
             if destination_order.magic not in source_ids:
-                src_symbol = get_copy_symbol(
+                src_symbol = self.get_copy_symbol(
                     destination_order.symbol, destination, type="source"
                 )
                 self.remove_order(src_symbol, destination_order, destination)
@@ -548,7 +573,7 @@ class TradeCopier(object):
         if not destination.get("copy", False):
             raise ValueError("Destination account not set to copy mode")
         return destination.get("copy_what", "all")
-    
+
     def copy_orders(self, destination: dict):
         what = self._copy_what(destination)
         if what not in ["all", "orders"]:
@@ -588,7 +613,7 @@ class TradeCopier(object):
         source_ids = [pos.ticket for pos in source_positions]
         for destination_position in destination_positions:
             if destination_position.magic not in source_ids:
-                src_symbol = get_copy_symbol(
+                src_symbol = self.get_copy_symbol(
                     destination_position.symbol, destination, type="source"
                 )
                 self.remove_position(src_symbol, destination_position, destination)
@@ -613,8 +638,15 @@ class TradeCopier(object):
         logger.info("Trade Copier Running ...")
         logger.info(f"Source Account: {self.source.get('login')}")
         while True:
+            if self.shutdown_event and self.shutdown_event.is_set():
+                logger.info(
+                    "Shutdown event received, stopping Trade Copier gracefully."
+                )
+                break
             try:
                 for destination in self.destinations:
+                    if self.shutdown_event and self.shutdown_event.is_set():
+                        break
                     if destination.get("path") == self.source.get("path"):
                         err_msg = "Source and destination accounts are on the same \
                             MetaTrader 5 installation which is not allowed."
@@ -624,18 +656,52 @@ class TradeCopier(object):
                     self.copy_positions(destination)
                     Mt5.shutdown()
                     time.sleep(0.1)
+
+                if self.shutdown_event and self.shutdown_event.is_set():
+                    logger.info(
+                        "Shutdown event received during destination processing, exiting."
+                    )
+                    break
+
             except KeyboardInterrupt:
-                logger.info("Stopping the Trade Copier ...")
+                logger.info("KeyboardInterrupt received, stopping the Trade Copier ...")
+                if self.shutdown_event:
+                    self.shutdown_event.set()
                 break
             except Exception as e:
                 self.log_error(e)
+                if self.shutdown_event and self.shutdown_event.is_set():
+                    logger.error(
+                        "Error occurred after shutdown signaled, exiting loop."
+                    )
+                    break
+
+            # Check shutdown event before sleeping
+            if self.shutdown_event and self.shutdown_event.is_set():
+                logger.info("Shutdown event checked before sleep, exiting.")
+                break
             time.sleep(self.sleeptime)
+        logger.info("Trade Copier has shut down.")
 
 
 def RunCopier(
-    source: dict, destinations: list, sleeptime: float, start_time: str, end_time: str
+    source: dict,
+    destinations: list,
+    sleeptime: float,
+    start_time: str,
+    end_time: str,
+    shutdown_event=None,
+    custom_logger=None,
 ):
-    copier = TradeCopier(source, destinations, sleeptime, start_time, end_time)
+    copier = TradeCopier(
+        source,
+        destinations,
+        sleeptime,
+        start_time,
+        end_time,
+        shutdown_event,
+        custom_logger,
+    )
     copier.run()
 
 
@@ -645,6 +711,8 @@ def RunMultipleCopier(
     start_delay: float = 1.0,
     start_time: str = None,
     end_time: str = None,
+    shutdown_event=None,
+    custom_logger=None,
 ):
     processes = []
 
@@ -662,10 +730,16 @@ def RunMultipleCopier(
             )
             continue
         logger.info(f"Starting process for source account @{source.get('login')}")
-
         process = multiprocessing.Process(
             target=RunCopier,
-            args=(source, destinations, sleeptime, start_time, end_time),
+            args=(
+                source,
+                destinations,
+                sleeptime,
+                start_time,
+                end_time,
+            ),
+            kwargs=dict(shutdown_event=shutdown_event, custom_logger=custom_logger),
         )
         processes.append(process)
         process.start()
@@ -673,13 +747,14 @@ def RunMultipleCopier(
         if start_delay:
             time.sleep(start_delay)
 
-    # Wait for all processes to complete
     for process in processes:
         process.join()
 
 
 def _strtodict(string: str) -> dict:
     string = string.strip().replace("\n", "").replace(" ", "").replace('"""', "")
+    if string.endswith(","):
+        string = string[:-1]
     return dict(item.split(":") for item in string.split(","))
 
 

bbstrader/metatrader/rates.py

@@ -7,7 +7,7 @@ from pandas.tseries.holiday import USFederalHolidayCalendar
 from pandas.tseries.offsets import CustomBusinessDay
 
 from bbstrader.metatrader.account import AMG_EXCHANGES, Account, check_mt5_connection
-from bbstrader.metatrader.utils import TIMEFRAMES, TimeFrame, raise_mt5_error
+from bbstrader.metatrader.utils import TIMEFRAMES, TimeFrame, raise_mt5_error, SymbolType
 
 try:
     import MetaTrader5 as Mt5
@@ -46,13 +46,13 @@ COMD_CALENDARS = {
 }
 
 CALENDARS = {
-    "FX": "us_futures",
-    "STK": AMG_EXCHANGES,
-    "ETF": AMG_EXCHANGES,
-    "IDX": IDX_CALENDARS,
-    "COMD": COMD_CALENDARS,
-    "CRYPTO": "24/7",
-    "FUT": None,
+    SymbolType.FOREX: "us_futures",
+    SymbolType.STOCKS: AMG_EXCHANGES,
+    SymbolType.ETFs: AMG_EXCHANGES,
+    SymbolType.INDICES: IDX_CALENDARS,
+    SymbolType.COMMODITIES: COMD_CALENDARS,
+    SymbolType.CRYPTO: "24/7",
+    SymbolType.FUTURES: None,
 }
 
 SESSION_TIMEFRAMES = [
@@ -206,6 +206,7 @@ class Rates(object):
     ) -> Union[pd.DataFrame, None]:
         """Fetches data from MT5 and returns a DataFrame or None."""
         try:
+            rates = None
             if isinstance(start, int) and isinstance(count, int):
                 rates = Mt5.copy_rates_from_pos(
                     self.symbol, self.time_frame, start, count
@@ -248,7 +249,7 @@ class Rates(object):
         currencies = self.__account.get_currency_rates(self.symbol)
         s_info = self.__account.get_symbol_info(self.symbol)
         if symbol_type in CALENDARS:
-            if symbol_type == "STK" or symbol_type == "ETF":
+            if symbol_type == SymbolType.STOCKS or symbol_type == SymbolType.ETFs:
                 for exchange in CALENDARS[symbol_type]:
                     if exchange in get_calendar_names():
                         symbols = self.__account.get_stocks_from_exchange(
@@ -257,20 +258,20 @@ class Rates(object):
                         if self.symbol in symbols:
                             calendar = get_calendar(exchange, side="right")
                             break
-            elif symbol_type == "IDX":
+            elif symbol_type == SymbolType.INDICES:
                 calendar = get_calendar(
                     CALENDARS[symbol_type][currencies["mc"]], side="right"
                 )
-            elif symbol_type == "COMD":
+            elif symbol_type == SymbolType.COMMODITIES:
                 for commodity in CALENDARS[symbol_type]:
                     if commodity in s_info.path:
                         calendar = get_calendar(
                             CALENDARS[symbol_type][commodity], side="right"
                         )
-            elif symbol_type == "FUT":
+            elif symbol_type == SymbolType.FUTURES:
                 if "Index" in s_info.path:
                     calendar = get_calendar(
-                        CALENDARS["IDX"][currencies["mc"]], side="right"
+                        CALENDARS[SymbolType.INDICES][currencies["mc"]], side="right"
                     )
                 else:
                     for commodity, cal in COMD_CALENDARS.items():

bbstrader/metatrader/risk.py

@@ -6,7 +6,7 @@ from scipy.stats import norm
 
 from bbstrader.metatrader.account import Account
 from bbstrader.metatrader.rates import Rates
-from bbstrader.metatrader.utils import TIMEFRAMES, TimeFrame
+from bbstrader.metatrader.utils import TIMEFRAMES, TimeFrame, SymbolType
 
 try:
     import MetaTrader5 as Mt5
@@ -275,10 +275,12 @@ class RiskManagement(Account):
             swap = df["swap"].sum()
             total_profit = commisions + fees + swap + profit
             initial_balance = balance - total_profit
-            if balance != 0:
+            if equity != 0:
                 risk_alowed = (((equity - initial_balance) / equity) * 100) * -1
                 return round(risk_alowed, 2)
-        return 0.0
+            else: # Handle equity is zero
+                return 0.0
+        return 0.0 # This is for the case where df is None
 
     def get_lot(self) -> float:
         """ "Get the approprite lot size for a trade"""
@@ -498,10 +500,10 @@ class RiskManagement(Account):
         av_price = (s_info.bid + s_info.ask) / 2
         trade_risk = self.get_trade_risk()
         symbol_type = self.get_symbol_type(self.symbol)
-        FX = symbol_type == "FX"
-        COMD = symbol_type == "COMD"
-        FUT = symbol_type == "FUT"
-        CRYPTO = symbol_type == "CRYPTO"
+        FX = symbol_type == SymbolType.FOREX
+        COMD = symbol_type == SymbolType.COMMODITIES
+        FUT = symbol_type == SymbolType.FUTURES
+        CRYPTO = symbol_type == SymbolType.CRYPTO
         if COMD:
             supported = _COMMD_SUPPORTED_
             if "." in self.symbol:
@@ -652,14 +654,14 @@ class RiskManagement(Account):
         lot = self._check_lot(_lot)
 
         volume = round(lot * size * av_price)
-        if self.get_symbol_type(self.symbol) == "FX":
+        if self.get_symbol_type(self.symbol) == SymbolType.FOREX:
             volume = round((trade_loss * size) / loss)
             __lot = round((volume / size), 2)
             lot = self._check_lot(__lot)
 
         if (
-            self.get_symbol_type(self.symbol) == "COMD"
-            or self.get_symbol_type(self.symbol) == "CRYPTO"
+            self.get_symbol_type(self.symbol) == SymbolType.COMMODITIES
+            or self.get_symbol_type(self.symbol) == SymbolType.CRYPTO
             and size > 1
         ):
             lot = currency_risk / (sl * loss * size)
@@ -705,7 +707,7 @@ class RiskManagement(Account):
         if account:
             return AL
 
-        if self.get_symbol_type(self.symbol) == "FX":
+        if self.get_symbol_type(self.symbol) == SymbolType.FOREX:
             return AL
         else:
             s_info = self.symbol_info

bbstrader/metatrader/scripts.py

@@ -2,9 +2,18 @@ import argparse
 import sys
 
 from bbstrader.metatrader.copier import RunCopier, config_copier
+from bbstrader.apps._copier import main as RunCopyAPP
 
 
 def copier_args(parser: argparse.ArgumentParser):
+    parser.add_argument(
+        "-m",
+        "--mode",
+        type=str,
+        default="CLI",
+        choices=("CLI", "GUI"),
+        help="Run the copier in the terminal or using the GUI",
+    )
     parser.add_argument(
         "-s", "--source", type=str, nargs="?", default=None, help="Source section name"
     )
@@ -52,6 +61,7 @@ def copy_trades(unknown):
         python -m bbstrader --run copier [options]
 
     Options:
+        -m, --mode: CLI for terminal app and GUI for Desktop app
         -s, --source: Source Account section name
         -d, --destinations: Destination Account section names (multiple allowed)
         -i, --interval: Update interval in seconds
@@ -67,15 +77,19 @@ def copy_trades(unknown):
     copy_parser = copier_args(copy_parser)
     copy_args = copy_parser.parse_args(unknown)
 
-    source, destinations = config_copier(
-        source_section=copy_args.source,
-        dest_sections=copy_args.destinations,
-        inifile=copy_args.config,
-    )
-    RunCopier(
-        source,
-        destinations,
-        copy_args.interval,
-        copy_args.start,
-        copy_args.end,
-    )
+    if copy_args.mode == "GUI":
+        RunCopyAPP()
+    
+    elif copy_args.mode == "CLI":
+        source, destinations = config_copier(
+            source_section=copy_args.source,
+            dest_sections=copy_args.destinations,
+            inifile=copy_args.config,
+        )
+        RunCopier(
+            source,
+            destinations,
+            copy_args.interval,
+            copy_args.start,
+            copy_args.end,
+        )