Pre-commit book

Author: Joaopeuko

mqpy/book.py

@@ -1,13 +1,31 @@
-from typing import Any, Dict, Optional
+"""Module for managing a market book for a financial instrument.
+
+Provides the Book class for accessing market depth information.
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
 
 import MetaTrader5 as Mt5
 
+# 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)
+
 
 class Book:
     """Represents a market book for a financial instrument."""
 
     def __init__(self, symbol: str) -> None:
-        """Initialize the Book object.
+        """Initialize a Book object.
 
         Args:
             symbol (str): The financial instrument symbol.
@@ -17,15 +35,15 @@ def __init__(self, symbol: str) -> None:
         """
         self.symbol: str = symbol
         if Mt5.market_book_add(self.symbol):
-            print(f"The symbol {self.symbol} was successfully added to the market book.")
+            logger.info(f"The symbol {self.symbol} was successfully added to the market book.")
         else:
-            print(f"Error adding {self.symbol} to the market book. Error: {Mt5.last_error()}")
+            logger.error(f"Error adding {self.symbol} to the market book. Error: {Mt5.last_error()}")
 
-    def get(self) -> Optional[Dict[str, Any]]:
+    def get(self) -> dict[str, Any] | None:
         """Get the market book for the financial instrument.
 
         Returns:
-            Optional[Dict[str, Any]]: A dictionary representing the market book, or None if unsuccessful.
+            dict[str, Any] | None: The market book data if successful, None otherwise.
         """
         return Mt5.market_book_get(self.symbol)