add logger

Author: Joaopeuko

mqpy/__init__.py

@@ -3,3 +3,7 @@
 This package provides a bridge between Python and MetaTrader 5, allowing users to
 create Expert Advisors and implement trading strategies in Python.
 """
+
+from mqpy.logger import get_logger
+
+__all__ = ["get_logger"]

mqpy/book.py

@@ -5,20 +5,14 @@
 
 from __future__ import annotations
 
-import logging
 from typing import Any
 
 import MetaTrader5 as Mt5
 
+from mqpy.logger import get_logger
+
 # Configure logging
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-# Create console handler with formatting
-console_handler = logging.StreamHandler()
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-console_handler.setFormatter(formatter)
-logger.addHandler(console_handler)
+logger = get_logger(__name__)
 
 
 class Book:

mqpy/indicator_connector.py

@@ -7,19 +7,13 @@
 
 import ast
 import json
-import logging
 import socket
 from typing import Any
 
+from mqpy.logger import get_logger
+
 # Configure logging
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-# Create console handler with formatting
-console_handler = logging.StreamHandler()
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-console_handler.setFormatter(formatter)
-logger.addHandler(console_handler)
+logger = get_logger(__name__)
 
 # To be able to use it you need the MQL5 Service to send the data, it is possible to found it here:
 # -------------------------------------------------------------------- #

mqpy/logger.py

@@ -0,0 +1,50 @@
+"""Logging configuration for the MqPy application.
+
+This module provides a centralized logging configuration for the entire application.
+Import this module instead of directly importing the logging module to ensure consistent
+logging behavior across the application.
+"""
+
+from __future__ import annotations
+
+import logging
+import sys
+
+
+def get_logger(name: str, level: int | None = None) -> logging.Logger:
+    """Get a logger with the specified name and level.
+
+    Args:
+        name (str): The name of the logger, typically __name__.
+        level (int | None): The logging level. Defaults to INFO if None.
+
+    Returns:
+        logging.Logger: A configured logger instance.
+    """
+    logger = logging.getLogger(name)
+
+    # Only configure the logger if it doesn't already have handlers
+    if not logger.handlers:
+        # Set default level if not specified
+        if level is None:
+            level = logging.INFO
+
+        logger.setLevel(level)
+
+        # Create console handler with a specific format
+        console_handler = logging.StreamHandler(sys.stdout)
+        formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+
+    return logger
+
+
+# Configure the root logger
+root_logger = logging.getLogger()
+if not root_logger.handlers:
+    root_logger.setLevel(logging.WARNING)
+    console_handler = logging.StreamHandler(sys.stdout)
+    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    console_handler.setFormatter(formatter)
+    root_logger.addHandler(console_handler)

mqpy/template.py

@@ -6,12 +6,13 @@
 from __future__ import annotations
 
 import argparse
-import logging
 from pathlib import Path
 from typing import Any, Callable
 
+from mqpy.logger import get_logger
+
 # Configure logging
-logging.basicConfig(level=logging.INFO, format="%(message)s")
+logger = get_logger(__name__)
 
 
 def get_arguments() -> dict[str, Any]:
@@ -539,9 +540,9 @@ def main() -> None:
     with output_file.open("w", encoding="utf-8") as file:
         file.write(template_content)
 
-    logging.info(f"Strategy template generated: {output_file.absolute()}")
-    logging.info(f"Strategy type: {args['strategy']}")
-    logging.info(f"Trading symbol: {args['symbol']}")
+    logger.info(f"Strategy template generated: {output_file.absolute()}")
+    logger.info(f"Strategy type: {args['strategy']}")
+    logger.info(f"Trading symbol: {args['symbol']}")
 
 
 if __name__ == "__main__":

mqpy/trade.py

@@ -12,21 +12,15 @@
 The Trade class automatically respects these limitations when attempting to open or close positions.
 """
 
-import logging
 import sys
 from datetime import datetime, timedelta, timezone
 
 import MetaTrader5 as Mt5
 
+from mqpy.logger import get_logger
+
 # Configure logging
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-# Create console handler with formatting
-console_handler = logging.StreamHandler()
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-console_handler.setFormatter(formatter)
-logger.addHandler(console_handler)
+logger = get_logger(__name__)
 
 
 class Trade:

mqpy/utilities.py

@@ -3,20 +3,14 @@
 Provides helper functions and classes for trading operations.
 """
 
-import logging
 from datetime import datetime, timezone
 
 import MetaTrader5 as Mt5
 
+from mqpy.logger import get_logger
+
 # Configure logging
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-# Create console handler with formatting
-console_handler = logging.StreamHandler()
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-console_handler.setFormatter(formatter)
-logger.addHandler(console_handler)
+logger = get_logger(__name__)
 
 
 class Utilities:

setup.py

@@ -9,7 +9,7 @@
 from setuptools import find_packages, setup
 
 # Read the README for the long description
-with Path("README.md").open() as f:
+with Path("README.md").open(encoding="utf-8") as f:
     long_description = f.read()
 
 setup(