bbstrader 0.2.92__py3-none-any.whl → 0.2.94__py3-none-any.whl

bbstrader/compat.py

@@ -1,19 +1,19 @@
-import platform
-import sys
-
-
-def setup_mock_metatrader():
-    """Mock MetaTrader5 on Linux to prevent import errors."""
-    if platform.system() != "Windows":
-        from unittest.mock import MagicMock
-
-        class Mock(MagicMock):
-            @classmethod
-            def __getattr__(cls, name):
-                return MagicMock()
-
-        MOCK_MODULES = ["MetaTrader5"]
-        sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-
-
-setup_mock_metatrader()
+import platform
+import sys
+
+
+def setup_mock_metatrader():
+    """Mock MetaTrader5 on Linux and MacOS to prevent import errors."""
+    if platform.system() != "Windows":
+        from unittest.mock import MagicMock
+
+        class Mock(MagicMock):
+            @classmethod
+            def __getattr__(cls, name):
+                return MagicMock()
+
+        MOCK_MODULES = ["MetaTrader5"]
+        sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+
+setup_mock_metatrader()

bbstrader/config.py

@@ -1,137 +1,137 @@
-import logging
-from pathlib import Path
-from typing import List
-
-
-TERMINAL = "\\terminal64.exe"
-BASE_FOLDER = "C:\\Program Files\\"
-
-AMG_PATH = BASE_FOLDER + "Admirals Group MT5 Terminal" + TERMINAL
-PGL_PATH = BASE_FOLDER + "Pepperstone MetaTrader 5" + TERMINAL
-FTMO_PATH = BASE_FOLDER + "FTMO MetaTrader 5" + TERMINAL
-JGM_PATH = BASE_FOLDER + "JustMarkets MetaTrader 5" + TERMINAL
-
-BROKERS_PATHS = {
-    "AMG": AMG_PATH,
-    "FTMO": FTMO_PATH,
-    "PGL": PGL_PATH,
-    "JGM": JGM_PATH,
-}
-
-
-def get_config_dir(name: str = ".bbstrader") -> Path:
-    """
-    Get the path to the configuration directory.
-
-    Args:
-        name: The name of the configuration directory.
-
-    Returns:
-        The path to the configuration directory.
-    """
-    home_dir = Path.home() / name
-    if not home_dir.exists():
-        home_dir.mkdir()
-    return home_dir
-
-
-BBSTRADER_DIR = get_config_dir()
-
-
-class LogLevelFilter(logging.Filter):
-    def __init__(self, levels: List[int]):
-        """
-        Initializes the filter with specific logging levels.
-
-        Args:
-            levels: A list of logging level values (integers) to include.
-        """
-        super().__init__()
-        self.levels = levels
-
-    def filter(self, record: logging.LogRecord) -> bool:
-        """
-        Filters log records based on their level.
-
-        Args:
-            record: The log record to check.
-
-        Returns:
-            True if the record's level is in the allowed levels, False otherwise.
-        """
-        return record.levelno in self.levels
-
-
-class CustomFormatter(logging.Formatter):
-    def formatTime(self, record, datefmt=None):
-        if hasattr(record, "custom_time"):
-            # Use the custom time if provided
-            record.created = record.custom_time.timestamp()
-        return super().formatTime(record, datefmt)
-
-
-class CustomLogger(logging.Logger):
-    def __init__(self, name, level=logging.NOTSET):
-        super().__init__(name, level)
-
-    def _log(
-        self,
-        level,
-        msg,
-        args,
-        exc_info=None,
-        extra=None,
-        stack_info=False,
-        stacklevel=1,
-        custom_time=None,
-    ):
-        if extra is None:
-            extra = {}
-        # Add custom_time to the extra dictionary if provided
-        if custom_time:
-            extra["custom_time"] = custom_time
-        super()._log(level, msg, args, exc_info, extra, stack_info, stacklevel)
-
-    def info(self, msg, *args, custom_time=None, **kwargs):
-        self._log(logging.INFO, msg, args, custom_time=custom_time, **kwargs)
-
-    def debug(self, msg, *args, custom_time=None, **kwargs):
-        self._log(logging.DEBUG, msg, args, custom_time=custom_time, **kwargs)
-
-    def warning(self, msg, *args, custom_time=None, **kwargs):
-        self._log(logging.WARNING, msg, args, custom_time=custom_time, **kwargs)
-
-    def error(self, msg, *args, custom_time=None, **kwargs):
-        self._log(logging.ERROR, msg, args, custom_time=custom_time, **kwargs)
-
-    def critical(self, msg, *args, custom_time=None, **kwargs):
-        self._log(logging.CRITICAL, msg, args, custom_time=custom_time, **kwargs)
-
-
-def config_logger(log_file: str, console_log=True):
-    # Use the CustomLogger
-    logging.setLoggerClass(CustomLogger)
-    logger = logging.getLogger(__name__)
-    logger.setLevel(logging.DEBUG)
-
-    # File handler
-    file_handler = logging.FileHandler(log_file)
-    file_handler.setLevel(logging.INFO)
-
-    # Custom formatter
-    formatter = CustomFormatter(
-        "%(asctime)s - %(levelname)s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
-    )
-    file_handler.setFormatter(formatter)
-
-    # Add the handler to the logger
-    logger.addHandler(file_handler)
-
-    if console_log:
-        # Handler for the console with a different level
-        console_handler = logging.StreamHandler()
-        console_handler.setLevel(logging.DEBUG)
-        console_handler.setFormatter(formatter)
-        logger.addHandler(console_handler)
-
-    return logger
+import logging
+from pathlib import Path
+from typing import List
+
+
+TERMINAL = "\\terminal64.exe"
+BASE_FOLDER = "C:\\Program Files\\"
+
+AMG_PATH = BASE_FOLDER + "Admirals Group MT5 Terminal" + TERMINAL
+PGL_PATH = BASE_FOLDER + "Pepperstone MetaTrader 5" + TERMINAL
+FTMO_PATH = BASE_FOLDER + "FTMO MetaTrader 5" + TERMINAL
+JGM_PATH = BASE_FOLDER + "JustMarkets MetaTrader 5" + TERMINAL
+
+BROKERS_PATHS = {
+    "AMG": AMG_PATH,
+    "FTMO": FTMO_PATH,
+    "PGL": PGL_PATH,
+    "JGM": JGM_PATH,
+}
+
+
+def get_config_dir(name: str = ".bbstrader") -> Path:
+    """
+    Get the path to the configuration directory.
+
+    Args:
+        name: The name of the configuration directory.
+
+    Returns:
+        The path to the configuration directory.
+    """
+    home_dir = Path.home() / name
+    if not home_dir.exists():
+        home_dir.mkdir()
+    return home_dir
+
+
+BBSTRADER_DIR = get_config_dir()
+
+
+class LogLevelFilter(logging.Filter):
+    def __init__(self, levels: List[int]):
+        """
+        Initializes the filter with specific logging levels.
+
+        Args:
+            levels: A list of logging level values (integers) to include.
+        """
+        super().__init__()
+        self.levels = levels
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """
+        Filters log records based on their level.
+
+        Args:
+            record: The log record to check.
+
+        Returns:
+            True if the record's level is in the allowed levels, False otherwise.
+        """
+        return record.levelno in self.levels
+
+
+class CustomFormatter(logging.Formatter):
+    def formatTime(self, record, datefmt=None):
+        if hasattr(record, "custom_time"):
+            # Use the custom time if provided
+            record.created = record.custom_time.timestamp()
+        return super().formatTime(record, datefmt)
+
+
+class CustomLogger(logging.Logger):
+    def __init__(self, name, level=logging.NOTSET):
+        super().__init__(name, level)
+
+    def _log(
+        self,
+        level,
+        msg,
+        args,
+        exc_info=None,
+        extra=None,
+        stack_info=False,
+        stacklevel=1,
+        custom_time=None,
+    ):
+        if extra is None:
+            extra = {}
+        # Add custom_time to the extra dictionary if provided
+        if custom_time:
+            extra["custom_time"] = custom_time
+        super()._log(level, msg, args, exc_info, extra, stack_info, stacklevel)
+
+    def info(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.INFO, msg, args, custom_time=custom_time, **kwargs)
+
+    def debug(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.DEBUG, msg, args, custom_time=custom_time, **kwargs)
+
+    def warning(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.WARNING, msg, args, custom_time=custom_time, **kwargs)
+
+    def error(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.ERROR, msg, args, custom_time=custom_time, **kwargs)
+
+    def critical(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.CRITICAL, msg, args, custom_time=custom_time, **kwargs)
+
+
+def config_logger(log_file: str, console_log=True):
+    # Use the CustomLogger
+    logging.setLoggerClass(CustomLogger)
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.DEBUG)
+
+    # File handler
+    file_handler = logging.FileHandler(log_file)
+    file_handler.setLevel(logging.INFO)
+
+    # Custom formatter
+    formatter = CustomFormatter(
+        "%(asctime)s - %(levelname)s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
+    )
+    file_handler.setFormatter(formatter)
+
+    # Add the handler to the logger
+    logger.addHandler(file_handler)
+
+    if console_log:
+        # Handler for the console with a different level
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(logging.DEBUG)
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+
+    return logger

bbstrader/core/data.py

@@ -1,22 +1,22 @@
-from financetoolkit import Toolkit
-
-__all__ = [
-    'FMP',
-]
-
-
-class FMP(Toolkit):
-    """
-    FMPData class for fetching data from Financial Modeling Prep API
-    using the Toolkit class from financetoolkit package.
-
-    See `financetoolkit` for more details.
-
-    """
-
-    def __init__(self, api_key: str = '', symbols: str | list = 'AAPL'):
-        super().__init__(tickers=symbols, api_key=api_key)
-
-
-class DataBendo:
-    ...
+from financetoolkit import Toolkit
+
+__all__ = [
+    'FMP',
+]
+
+
+class FMP(Toolkit):
+    """
+    FMPData class for fetching data from Financial Modeling Prep API
+    using the Toolkit class from financetoolkit package.
+
+    See `financetoolkit` for more details.
+
+    """
+
+    def __init__(self, api_key: str = '', symbols: str | list = 'AAPL'):
+        super().__init__(tickers=symbols, api_key=api_key)
+
+
+class DataBendo:
+    ...

bbstrader/core/utils.py

@@ -1,146 +1,146 @@
-import configparser
-import importlib
-import importlib.util
-import os
-from dataclasses import dataclass
-from enum import Enum
-from typing import Any, Dict, List
-
-
-def load_module(file_path):
-    """Load a module from a file path.
-
-    Args:
-        file_path: Path to the file to load.
-
-    Returns:
-        The loaded module.
-    """
-    if not os.path.exists(file_path):
-        raise FileNotFoundError(
-            f"Strategy file {file_path} not found. Please create it."
-        )
-    spec = importlib.util.spec_from_file_location("strategies", file_path)
-    module = importlib.util.module_from_spec(spec)
-    spec.loader.exec_module(module)
-    return module
-
-
-def load_class(module, class_name, base_class):
-    """Load a class from a module.
-
-    Args:
-        module: The module to load the class from.
-        class_name: The name of the class to load.
-        base_class: The base class that the class must inherit from.
-    """
-    if not hasattr(module, class_name):
-        raise AttributeError(f"{class_name} not found in {module}")
-    class_ = getattr(module, class_name)
-    if not issubclass(class_, base_class):
-        raise TypeError(f"{class_name} must inherit from {base_class}.")
-    return class_
-
-
-def auto_convert(value):
-    """Convert string values to appropriate data types"""
-    if value.lower() in {"true", "false"}:  # Boolean
-        return value.lower() == "true"
-    elif value.lower() in {"none", "null"}:  # None
-        return None
-    elif value.isdigit():
-        return int(value)
-    try:
-        return float(value)
-    except ValueError:
-        return value
-
-
-def dict_from_ini(file_path, sections: str | List[str] = None) -> Dict[str, Any]:
-    """Reads an INI file and converts it to a dictionary with proper data types.
-
-    Args:
-        file_path: Path to the INI file to read.
-        sections: Optional list of sections to read from the INI file.
-
-    Returns:
-        A dictionary containing the INI file contents with proper data types.
-    """
-    config = configparser.ConfigParser()
-    config.read(file_path)
-
-    ini_dict = {}
-    for section in config.sections():
-        ini_dict[section] = {
-            key: auto_convert(value) for key, value in config.items(section)
-        }
-
-    if isinstance(sections, str):
-        try:
-            return ini_dict[sections]
-        except KeyError:
-            raise KeyError(f"{sections} not found in the {file_path} file")
-    if isinstance(sections, list):
-        sect_dict = {}
-        for section in sections:
-            try:
-                sect_dict[section] = ini_dict[section]
-            except KeyError:
-                raise KeyError(f"{section} not found in the {file_path} file")
-    return ini_dict
-
-
-class TradeAction(Enum):
-    """
-    An enumeration class for trade actions.
-    """
-
-    BUY = "LONG"
-    LONG = "LONG"
-    SELL = "SHORT"
-    EXIT = "EXIT"
-    BMKT = "BMKT"
-    SMKT = "SMKT"
-    BLMT = "BLMT"
-    SLMT = "SLMT"
-    BSTP = "BSTP"
-    SSTP = "SSTP"
-    SHORT = "SHORT"
-    BSTPLMT = "BSTPLMT"
-    SSTPLMT = "SSTPLMT"
-    EXIT_LONG = "EXIT_LONG"
-    EXIT_SHORT = "EXIT_SHORT"
-    EXIT_STOP = "EXIT_STOP"
-    EXIT_LIMIT = "EXIT_LIMIT"
-    EXIT_LONG_STOP = "EXIT_LONG_STOP"
-    EXIT_LONG_LIMIT = "EXIT_LONG_LIMIT"
-    EXIT_SHORT_STOP = "EXIT_SHORT_STOP"
-    EXIT_SHORT_LIMIT = "EXIT_SHORT_LIMIT"
-    EXIT_LONG_STOP_LIMIT = "EXIT_LONG_STOP_LIMIT"
-    EXIT_SHORT_STOP_LIMIT = "EXIT_SHORT_STOP_LIMIT"
-    EXIT_PROFITABLES = "EXIT_PROFITABLES"
-    EXIT_LOSINGS = "EXIT_LOSINGS"
-    EXIT_ALL_POSITIONS = "EXIT_ALL_POSITIONS"
-    EXIT_ALL_ORDERS = "EXIT_ALL_ORDERS"
-
-    def __str__(self):
-        return self.value
-
-
-@dataclass()
-class TradeSignal:
-    """
-    A dataclass for storing trading signal.
-    """
-
-    id: int
-    symbol: str
-    action: TradeAction
-    price: float = None
-    stoplimit: float = None
-
-    def __repr__(self):
-        return (
-            f"TradeSignal(id={self.id}, symbol='{self.symbol}', "
-            f"action='{self.action.value}', price={self.price}, stoplimit={self.stoplimit})"
-        )
+import configparser
+import importlib
+import importlib.util
+import os
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Dict, List
+
+
+def load_module(file_path):
+    """Load a module from a file path.
+
+    Args:
+        file_path: Path to the file to load.
+
+    Returns:
+        The loaded module.
+    """
+    if not os.path.exists(file_path):
+        raise FileNotFoundError(
+            f"Strategy file {file_path} not found. Please create it."
+        )
+    spec = importlib.util.spec_from_file_location("bbstrader.cli", file_path)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+
+def load_class(module, class_name, base_class):
+    """Load a class from a module.
+
+    Args:
+        module: The module to load the class from.
+        class_name: The name of the class to load.
+        base_class: The base class that the class must inherit from.
+    """
+    if not hasattr(module, class_name):
+        raise AttributeError(f"{class_name} not found in {module}")
+    class_ = getattr(module, class_name)
+    if not issubclass(class_, base_class):
+        raise TypeError(f"{class_name} must inherit from {base_class}.")
+    return class_
+
+
+def auto_convert(value):
+    """Convert string values to appropriate data types"""
+    if value.lower() in {"true", "false"}:  # Boolean
+        return value.lower() == "true"
+    elif value.lower() in {"none", "null"}:  # None
+        return None
+    elif value.isdigit():
+        return int(value)
+    try:
+        return float(value)
+    except ValueError:
+        return value
+
+
+def dict_from_ini(file_path, sections: str | List[str] = None) -> Dict[str, Any]:
+    """Reads an INI file and converts it to a dictionary with proper data types.
+
+    Args:
+        file_path: Path to the INI file to read.
+        sections: Optional list of sections to read from the INI file.
+
+    Returns:
+        A dictionary containing the INI file contents with proper data types.
+    """
+    config = configparser.ConfigParser(interpolation=None)
+    config.read(file_path)
+
+    ini_dict = {}
+    for section in config.sections():
+        ini_dict[section] = {
+            key: auto_convert(value) for key, value in config.items(section)
+        }
+
+    if isinstance(sections, str):
+        try:
+            return ini_dict[sections]
+        except KeyError:
+            raise KeyError(f"{sections} not found in the {file_path} file")
+    if isinstance(sections, list):
+        sect_dict = {}
+        for section in sections:
+            try:
+                sect_dict[section] = ini_dict[section]
+            except KeyError:
+                raise KeyError(f"{section} not found in the {file_path} file")
+    return ini_dict
+
+
+class TradeAction(Enum):
+    """
+    An enumeration class for trade actions.
+    """
+
+    BUY = "LONG"
+    LONG = "LONG"
+    SELL = "SHORT"
+    EXIT = "EXIT"
+    BMKT = "BMKT"
+    SMKT = "SMKT"
+    BLMT = "BLMT"
+    SLMT = "SLMT"
+    BSTP = "BSTP"
+    SSTP = "SSTP"
+    SHORT = "SHORT"
+    BSTPLMT = "BSTPLMT"
+    SSTPLMT = "SSTPLMT"
+    EXIT_LONG = "EXIT_LONG"
+    EXIT_SHORT = "EXIT_SHORT"
+    EXIT_STOP = "EXIT_STOP"
+    EXIT_LIMIT = "EXIT_LIMIT"
+    EXIT_LONG_STOP = "EXIT_LONG_STOP"
+    EXIT_LONG_LIMIT = "EXIT_LONG_LIMIT"
+    EXIT_SHORT_STOP = "EXIT_SHORT_STOP"
+    EXIT_SHORT_LIMIT = "EXIT_SHORT_LIMIT"
+    EXIT_LONG_STOP_LIMIT = "EXIT_LONG_STOP_LIMIT"
+    EXIT_SHORT_STOP_LIMIT = "EXIT_SHORT_STOP_LIMIT"
+    EXIT_PROFITABLES = "EXIT_PROFITABLES"
+    EXIT_LOSINGS = "EXIT_LOSINGS"
+    EXIT_ALL_POSITIONS = "EXIT_ALL_POSITIONS"
+    EXIT_ALL_ORDERS = "EXIT_ALL_ORDERS"
+
+    def __str__(self):
+        return self.value
+
+
+@dataclass()
+class TradeSignal:
+    """
+    A dataclass for storing trading signal.
+    """
+
+    id: int
+    symbol: str
+    action: TradeAction
+    price: float = None
+    stoplimit: float = None
+
+    def __repr__(self):
+        return (
+            f"TradeSignal(id={self.id}, symbol='{self.symbol}', "
+            f"action='{self.action.value}', price={self.price}, stoplimit={self.stoplimit})"
+        )

bbstrader/metatrader/__init__.py

@@ -1,7 +1,7 @@
-
-from bbstrader.metatrader.account import *  # noqa: F403
-from bbstrader.metatrader.rates import *  # noqa: F403
-from bbstrader.metatrader.risk import *  # noqa: F403
-from bbstrader.metatrader.trade import *  # noqa: F403
-from bbstrader.metatrader.utils import *  # noqa: F403*
+
+from bbstrader.metatrader.account import *  # noqa: F403
+from bbstrader.metatrader.rates import *  # noqa: F403
+from bbstrader.metatrader.risk import *  # noqa: F403
+from bbstrader.metatrader.trade import *  # noqa: F403
+from bbstrader.metatrader.utils import *  # noqa: F403*
 from bbstrader.metatrader.copier import *  # noqa: F403