pdmt5 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

pdmt5/trading.py

@@ -2,13 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Any, Literal
+from datetime import timedelta
+from typing import TYPE_CHECKING, Any, Literal
 
 from pydantic import ConfigDict, Field
 
 from .dataframe import Mt5DataClient
 from .mt5 import Mt5RuntimeError
 
+if TYPE_CHECKING:
+    import pandas as pd
+
 
 class Mt5TradingError(Mt5RuntimeError):
     """MetaTrader5 trading error."""
@@ -32,6 +36,7 @@ class Mt5TradingClient(Mt5DataClient):
     def close_open_positions(
         self,
         symbols: str | list[str] | tuple[str, ...] | None = None,
+        dry_run: bool | None = None,
         **kwargs: Any,  # noqa: ANN401
     ) -> dict[str, list[dict[str, Any]]]:
         """Close all open positions for specified symbols.
@@ -39,6 +44,8 @@ class Mt5TradingClient(Mt5DataClient):
         Args:
             symbols: Optional symbol or list of symbols to filter positions.
                 If None, all symbols will be considered.
+            dry_run: Optional flag to enable dry run mode. If None, uses the instance's
+                `dry_run` attribute.
             **kwargs: Additional keyword arguments for request parameters.
 
         Returns:
@@ -53,18 +60,22 @@ class Mt5TradingClient(Mt5DataClient):
             symbol_list = self.symbols_get()
         self.logger.info("Fetching and closing positions for symbols: %s", symbol_list)
         return {
-            s: self._fetch_and_close_position(symbol=s, **kwargs) for s in symbol_list
+            s: self._fetch_and_close_position(symbol=s, dry_run=dry_run, **kwargs)
+            for s in symbol_list
         }
 
     def _fetch_and_close_position(
         self,
         symbol: str | None = None,
+        dry_run: bool | None = None,
         **kwargs: Any,  # noqa: ANN401
     ) -> list[dict[str, Any]]:
         """Close all open positions for a specific symbol.
 
         Args:
             symbol: Optional symbol filter.
+            dry_run: Optional flag to enable dry run mode. If None, uses the instance's
+                `dry_run` attribute.
             **kwargs: Additional keyword arguments for request parameters.
 
         Returns:
@@ -96,6 +107,7 @@ class Mt5TradingClient(Mt5DataClient):
                         "position": p["ticket"],
                         **kwargs,
                     },
+                    dry_run=dry_run,
                 )
                 for p in positions_dict
             ]
@@ -182,3 +194,84 @@ class Mt5TradingClient(Mt5DataClient):
                 f"Failed to calculate minimum order margins for symbol: {symbol}."
             )
             raise Mt5TradingError(error_message)
+
+    def calculate_spread_ratio(
+        self,
+        symbol: str,
+    ) -> float:
+        """Calculate the spread ratio for a given symbol.
+
+        Args:
+            symbol: Symbol for which to calculate the spread ratio.
+
+        Returns:
+            Spread ratio as a float.
+        """
+        symbol_info_tick = self.symbol_info_tick_as_dict(symbol=symbol)
+        return (
+            (symbol_info_tick["ask"] - symbol_info_tick["bid"])
+            / (symbol_info_tick["ask"] + symbol_info_tick["bid"])
+            * 2
+        )
+
+    def copy_latest_rates_as_df(
+        self,
+        symbol: str,
+        granularity: str = "M1",
+        count: int = 1440,
+        index_keys: str | None = "time",
+    ) -> pd.DataFrame:
+        """Fetch rate (OHLC) data as a DataFrame.
+
+        Args:
+            symbol: Symbol to fetch data for.
+            granularity: Time granularity as a timeframe suffix (e.g., "M1", "H1").
+            count: Number of bars to fetch.
+            index_keys: Optional index keys for the DataFrame.
+
+        Returns:
+            pd.DataFrame: OHLC data with time index.
+
+        Raises:
+            Mt5TradingError: If the granularity is not supported by MetaTrader5.
+        """
+        try:
+            timeframe = getattr(self.mt5, f"TIMEFRAME_{granularity.upper()}")
+        except AttributeError as e:
+            error_message = (
+                f"MetaTrader5 does not support the given granularity: {granularity}"
+            )
+            raise Mt5TradingError(error_message) from e
+        else:
+            return self.copy_rates_from_pos_as_df(
+                symbol=symbol,
+                timeframe=timeframe,
+                start_pos=0,
+                count=count,
+                index_keys=index_keys,
+            )
+
+    def copy_latest_ticks_as_df(
+        self,
+        symbol: str,
+        seconds: int = 300,
+        index_keys: str | None = "time_msc",
+    ) -> pd.DataFrame:
+        """Fetch tick data as a DataFrame.
+
+        Args:
+            symbol: Symbol to fetch tick data for.
+            seconds: Time range in seconds to fetch ticks around the last tick time.
+            index_keys: Optional index keys for the DataFrame.
+
+        Returns:
+            pd.DataFrame: Tick data with time index.
+        """
+        last_tick_time = self.symbol_info_tick_as_dict(symbol=symbol)["time"]
+        return self.copy_ticks_range_as_df(
+            symbol=symbol,
+            date_from=(last_tick_time - timedelta(seconds=seconds)),
+            date_to=(last_tick_time + timedelta(seconds=seconds)),
+            flags=self.mt5.COPY_TICKS_ALL,
+            index_keys=index_keys,
+        )

{pdmt5-0.1.1.dist-info → pdmt5-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdmt5
-Version: 0.1.1
+Version: 0.1.3
 Summary: Pandas-based data handler for MetaTrader 5
 Project-URL: Repository, https://github.com/dceoy/pdmt5.git
 Author-email: dceoy <dceoy@users.noreply.github.com>

{pdmt5-0.1.1.dist-info → pdmt5-0.1.3.dist-info}/RECORD

@@ -1,9 +1,9 @@
 pdmt5/__init__.py,sha256=QbSFrsi7_bgFzb-ma4DmmUjR90UvrqKMnRZq1wPRmoI,446
 pdmt5/dataframe.py,sha256=rUWtR23hrXBdBqzJhbOlIemNy73RrjSTZZJUhwoL6io,38084
 pdmt5/mt5.py,sha256=KgxHapIrh5b4L0wIOAQIjfXNZafalihbFrh9fhYHmrI,32254
-pdmt5/trading.py,sha256=4rT0WgK0JyLMv8XatXur8-NWqG6gh_8XQ-g5sVX9xq0,6987
+pdmt5/trading.py,sha256=FsLC_X_bwBnnQ9l54wPA4OlwD2HlO1RnPvOCnMopNNE,10113
 pdmt5/utils.py,sha256=Ll5Q3OE5h1A_sZ_qVEnOPGniFlT6_MmHfuu0zqeLdeU,3913
-pdmt5-0.1.1.dist-info/METADATA,sha256=q-ucK2453_zDdVKufYI03PmkfRqwt3WcNdTdwu1OPkw,9029
-pdmt5-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pdmt5-0.1.1.dist-info/licenses/LICENSE,sha256=iABrdaUGOBWLYotFupB_PGe8arV5o7rVhn-_vK6P704,1073
-pdmt5-0.1.1.dist-info/RECORD,,
+pdmt5-0.1.3.dist-info/METADATA,sha256=UpjES_3YPgMHCpmX4da8ox0OlqJ36nE5B-cYNKvv2A8,9029
+pdmt5-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pdmt5-0.1.3.dist-info/licenses/LICENSE,sha256=iABrdaUGOBWLYotFupB_PGe8arV5o7rVhn-_vK6P704,1073
+pdmt5-0.1.3.dist-info/RECORD,,