Pytest rates

Author: Joaopeuko

example.py

@@ -10,7 +10,7 @@
 # Initialize the trading strategy
 trade = Trade(
     expert_name="Moving Average Crossover",
-    version=1.0,
+    version="1.0",
     symbol="EURUSD",
     magic_number=567,
     lot=0.1,

mqpy/book.py

@@ -39,11 +39,11 @@ def __init__(self, symbol: str) -> None:
         else:
             logger.error(f"Error adding {self.symbol} to the market book. Error: {Mt5.last_error()}")
 
-    def get(self) -> dict[str, Any] | None:
+    def get(self) -> list[Any] | None:
         """Get the market book for the financial instrument.
 
         Returns:
-            dict[str, Any] | None: The market book data if successful, None otherwise.
+            list[Any] | None: The market book data if successful, None otherwise.
         """
         return Mt5.market_book_get(self.symbol)
 

mqpy/rates.py

@@ -5,6 +5,8 @@
 
 from __future__ import annotations
 
+from typing import Any
+
 import MetaTrader5 as Mt5
 
 
@@ -40,11 +42,11 @@ def _raise_value_error(msg: str) -> None:
             self._tick_volume = [rate[5] for rate in rates]
             self._spread = [rate[6] for rate in rates]
             self._real_volume = [rate[7] for rate in rates]
-        except Mt5.Error as e:
+        except Exception as e:
             raise ValueError(f"Failed to create Rates object for symbol {symbol}") from e
 
     @property
-    def time(self) -> list[int | float]:
+    def time(self) -> list[Any]:
         """List of timestamps."""
         return self._time
 
@@ -69,16 +71,16 @@ def close(self) -> list[float]:
         return self._close
 
     @property
-    def tick_volume(self) -> list[int]:
+    def tick_volume(self) -> list[int | float]:
         """List of tick volumes."""
         return self._tick_volume
 
     @property
-    def spread(self) -> list[int]:
+    def spread(self) -> list[int | float]:
         """List of spreads."""
         return self._spread
 
     @property
-    def real_volume(self) -> list[int]:
+    def real_volume(self) -> list[int | float]:
         """List of real volumes."""
         return self._real_volume

mqpy/trade.py

@@ -113,7 +113,7 @@ def select_symbol(self) -> None:
         Returns:
             None
         """
-        Mt5.symbol_select(self.symbol, True)
+        Mt5.symbol_select(self.symbol, select=True)
 
     def prepare_symbol(self) -> None:
         """Prepare the trading symbol for opening positions.
@@ -130,7 +130,7 @@ def prepare_symbol(self) -> None:
 
         if not symbol_info.visible:
             logger.warning(f"The {self.symbol} is not visible, needed to be switched on.")
-            if not Mt5.symbol_select(self.symbol, True):
+            if not Mt5.symbol_select(self.symbol, select=True):
                 logger.error(
                     f"The expert advisor {self.expert_name} failed in select the symbol {self.symbol}, turning off."
                 )

pyproject.toml

@@ -67,6 +67,15 @@ disable_error_code = [
 ]
 show_error_codes = true
 files = "**/*.py"
+exclude = ["venv", "mt5", "site-packages", ".*"]
+
+[[tool.mypy.overrides]]
+module = "MetaTrader5.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "_virtualenv"
+ignore_errors = true
 
 [tool.ruff]
 line-length = 120

setup.py

@@ -1,11 +1,17 @@
-# """Setup script for the mqpy package.
+"""Setup script for the mqpy package.
 
-# This module contains the setup configuration for the mqpy package, which provides a Python interface
-# for creating Expert Advisors in MetaTrader 5.
-# """
+This module contains the setup configuration for the mqpy package, which provides a Python interface
+for creating Expert Advisors in MetaTrader 5.
+"""
+
+from pathlib import Path
 
 from setuptools import find_packages, setup
 
+# Read the README for the long description
+with Path("README.md").open() as f:
+    long_description = f.read()
+
 setup(
     name="mqpy",
     version="0.6.9",
@@ -14,7 +20,7 @@
     author="Joao Euko",
     author_email="",
     description="A library to simplify creating Expert Advisors in MQL5",
-    long_description=open("README.md").read(),
+    long_description=long_description,
     long_description_content_type="text/markdown",
     license="MIT",
     entry_points={

tests/conftest.py

@@ -1,17 +1,22 @@
+"""Test fixtures and configuration shared across test modules."""
+
+from __future__ import annotations
+
+import logging
+from typing import Generator
+
 import pytest
 
 
 @pytest.fixture
-def test_symbols():
+def test_symbols() -> dict[str, str]:
     """Provides common test symbols that can be used across tests."""
     return {"forex": "EURUSD", "indices": "US500", "commodities": "XAUUSD", "crypto": "BTCUSD", "invalid": "INVALID"}
 
 
 @pytest.fixture
-def configure_logging():
+def configure_logging() -> Generator[None, None, None]:
     """Sets up logging configuration for tests."""
-    import logging
-
     root = logging.getLogger()
     for handler in root.handlers[:]:
         root.removeHandler(handler)

tests/test_book.py

@@ -1,14 +1,22 @@
+"""Tests for the Book class that manages market depth information from MetaTrader 5."""
+
+from __future__ import annotations
+
 import logging
 import time
+from typing import TYPE_CHECKING, Generator
 
 import MetaTrader5 as Mt5
 import pytest
 
+if TYPE_CHECKING:
+    from _pytest.logging import LogCaptureFixture
+
 from mqpy.book import Book
 
 
 @pytest.fixture(scope="module", autouse=True)
-def setup_teardown():
+def setup_teardown() -> Generator[None, None, None]:
     """Set up and tear down MetaTrader5 connection for the test module."""
     if not Mt5.initialize():
         pytest.skip("MetaTrader5 could not be initialized")
@@ -21,7 +29,7 @@ def setup_teardown():
 
 
 @pytest.fixture
-def symbol():
+def symbol() -> str:
     """Provides a valid trading symbol for testing."""
     time.sleep(1)
 
@@ -36,15 +44,16 @@ def symbol():
     return symbols[0].name
 
 
-def test_book_initialization(symbol, caplog):
+def test_book_initialization(symbol: str, caplog: LogCaptureFixture) -> None:
     """Test initialization of Book with a real symbol."""
     caplog.set_level(logging.INFO)
-    book = Book(symbol)
+    # Create book instance (used to trigger log message)
+    Book(symbol)
 
     assert f"The symbol {symbol} was successfully added to the market book" in caplog.text
 
 
-def test_book_get(symbol):
+def test_book_get(symbol: str) -> None:
     """Test getting real market book data."""
     book = Book(symbol)
 
@@ -57,16 +66,23 @@ def test_book_get(symbol):
     if market_data:
         assert isinstance(market_data, list)
 
-        has_bids = any(item.type == Mt5.BOOK_TYPE_SELL for item in market_data)
-        has_asks = any(item.type == Mt5.BOOK_TYPE_BUY for item in market_data)
+        # Loop separately to check for bids and asks
+        has_bids = False
+        has_asks = False
+
+        for item in market_data:
+            if item.type == Mt5.BOOK_TYPE_SELL:
+                has_bids = True
+            if item.type == Mt5.BOOK_TYPE_BUY:
+                has_asks = True
 
         if not (has_bids or has_asks):
-            print(f"Warning: No bids or asks found in market book for {symbol}")
+            logging.warning(f"No bids or asks found in market book for {symbol}")
 
     book.release()
 
 
-def test_book_release(symbol):
+def test_book_release(symbol: str) -> None:
     """Test releasing the market book."""
     book = Book(symbol)
 
@@ -75,7 +91,7 @@ def test_book_release(symbol):
     assert result is True
 
 
-def test_full_workflow(symbol):
+def test_full_workflow(symbol: str) -> None:
     """Test a complete workflow with the real market book."""
     book = Book(symbol)
 
@@ -92,10 +108,10 @@ def test_full_workflow(symbol):
     data_after_release = book.get()
 
     if data_after_release is not None and len(data_after_release) > 0:
-        print("Note: Market book data still available after release")
+        logging.info("Market book data still available after release")
 
 
-def test_multiple_symbols():
+def test_multiple_symbols() -> None:
     """Test using Book with multiple symbols simultaneously."""
     symbols = Mt5.symbols_get()
     if len(symbols) < 2:
@@ -119,7 +135,7 @@ def test_multiple_symbols():
     book2.release()
 
 
-def test_unavailable_symbol(caplog):
+def test_unavailable_symbol(caplog: LogCaptureFixture) -> None:
     """Test behavior with an unavailable symbol."""
     caplog.set_level(logging.ERROR)