pdmt5 0.1.8__tar.gz → 0.1.9__tar.gz

{pdmt5-0.1.8 → pdmt5-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdmt5
-Version: 0.1.8
+Version: 0.1.9
 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>
@@ -53,14 +53,14 @@ Pandas-based data handler for MetaTrader 5
 
 ## Installation
 
-### From GitHub
+### Using pip
 
 ```bash
-git clone https://github.com/dceoy/pdmt5.git
-pip install -U --no-cache-dir ./pdmt5
+pip install -U pdmt5
+pip install -U MetaTrader5
 ```
 
-### Using uv (recommended for development)
+### Using uv
 
 ```bash
 git clone https://github.com/dceoy/pdmt5.git

{pdmt5-0.1.8 → pdmt5-0.1.9}/README.md

@@ -30,14 +30,14 @@ Pandas-based data handler for MetaTrader 5
 
 ## Installation
 
-### From GitHub
+### Using pip
 
 ```bash
-git clone https://github.com/dceoy/pdmt5.git
-pip install -U --no-cache-dir ./pdmt5
+pip install -U pdmt5
+pip install -U MetaTrader5
 ```
 
-### Using uv (recommended for development)
+### Using uv
 
 ```bash
 git clone https://github.com/dceoy/pdmt5.git

{pdmt5-0.1.8 → pdmt5-0.1.9}/pdmt5/trading.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from datetime import timedelta
+from functools import cached_property
 from math import floor
 from typing import TYPE_CHECKING, Any, Literal
 
@@ -28,6 +29,67 @@ class Mt5TradingClient(Mt5DataClient):
 
     model_config = ConfigDict(frozen=True)
 
+    @cached_property
+    def mt5_successful_trade_retcodes(self) -> set[int]:
+        """Set of successful trade return codes.
+
+        Returns:
+            Set of successful trade return codes.
+        """
+        return {
+            self.mt5.TRADE_RETCODE_PLACED,  # 10008
+            self.mt5.TRADE_RETCODE_DONE,  # 10009
+            self.mt5.TRADE_RETCODE_DONE_PARTIAL,  # 10010
+        }
+
+    @cached_property
+    def mt5_failed_trade_retcodes(self) -> set[int]:
+        """Set of failed trade return codes.
+
+        Returns:
+            Set of failed trade return codes.
+        """
+        return {
+            self.mt5.TRADE_RETCODE_REQUOTE,  # 10004
+            self.mt5.TRADE_RETCODE_REJECT,  # 10006
+            self.mt5.TRADE_RETCODE_CANCEL,  # 10007
+            self.mt5.TRADE_RETCODE_ERROR,  # 10011
+            self.mt5.TRADE_RETCODE_TIMEOUT,  # 10012
+            self.mt5.TRADE_RETCODE_INVALID,  # 10013
+            self.mt5.TRADE_RETCODE_INVALID_VOLUME,  # 10014
+            self.mt5.TRADE_RETCODE_INVALID_PRICE,  # 10015
+            self.mt5.TRADE_RETCODE_INVALID_STOPS,  # 10016
+            self.mt5.TRADE_RETCODE_TRADE_DISABLED,  # 10017
+            self.mt5.TRADE_RETCODE_MARKET_CLOSED,  # 10018
+            self.mt5.TRADE_RETCODE_NO_MONEY,  # 10019
+            self.mt5.TRADE_RETCODE_PRICE_CHANGED,  # 10020
+            self.mt5.TRADE_RETCODE_PRICE_OFF,  # 10021
+            self.mt5.TRADE_RETCODE_INVALID_EXPIRATION,  # 10022
+            self.mt5.TRADE_RETCODE_ORDER_CHANGED,  # 10023
+            self.mt5.TRADE_RETCODE_TOO_MANY_REQUESTS,  # 10024
+            self.mt5.TRADE_RETCODE_NO_CHANGES,  # 10025
+            self.mt5.TRADE_RETCODE_SERVER_DISABLES_AT,  # 10026
+            self.mt5.TRADE_RETCODE_CLIENT_DISABLES_AT,  # 10027
+            self.mt5.TRADE_RETCODE_LOCKED,  # 10028
+            self.mt5.TRADE_RETCODE_FROZEN,  # 10029
+            self.mt5.TRADE_RETCODE_INVALID_FILL,  # 10030
+            self.mt5.TRADE_RETCODE_CONNECTION,  # 10031
+            self.mt5.TRADE_RETCODE_ONLY_REAL,  # 10032
+            self.mt5.TRADE_RETCODE_LIMIT_ORDERS,  # 10033
+            self.mt5.TRADE_RETCODE_LIMIT_VOLUME,  # 10034
+            self.mt5.TRADE_RETCODE_INVALID_ORDER,  # 10035
+            self.mt5.TRADE_RETCODE_POSITION_CLOSED,  # 10036
+            self.mt5.TRADE_RETCODE_INVALID_CLOSE_VOLUME,  # 10038
+            self.mt5.TRADE_RETCODE_CLOSE_ORDER_EXIST,  # 10039
+            self.mt5.TRADE_RETCODE_LIMIT_POSITIONS,  # 10040
+            self.mt5.TRADE_RETCODE_REJECT_CANCEL,  # 10041
+            self.mt5.TRADE_RETCODE_LONG_ONLY,  # 10042
+            self.mt5.TRADE_RETCODE_SHORT_ONLY,  # 10043
+            self.mt5.TRADE_RETCODE_CLOSE_ONLY,  # 10044
+            self.mt5.TRADE_RETCODE_FIFO_CLOSE,  # 10045
+            self.mt5.TRADE_RETCODE_HEDGE_PROHIBITED,  # 10046
+        }
+
     def close_open_positions(
         self,
         symbols: str | list[str] | tuple[str, ...] | None = None,
@@ -116,12 +178,14 @@ class Mt5TradingClient(Mt5DataClient):
     def _send_or_check_order(
         self,
         request: dict[str, Any],
+        raise_on_error: bool = False,
         dry_run: bool = False,
     ) -> dict[str, Any]:
         """Send or check an order request.
 
         Args:
             request: Order request dictionary.
+            raise_on_error: If True, raise an error on operation failure.
             dry_run: If True, only check the order without sending it.
 
         Returns:
@@ -138,25 +202,21 @@ class Mt5TradingClient(Mt5DataClient):
             response = self.order_send_as_dict(request=request)
             order_func = "order_send"
         retcode = response.get("retcode")
-        if ((not dry_run) and retcode == self.mt5.TRADE_RETCODE_DONE) or (
-            dry_run and retcode == 0
+        if (dry_run and retcode == 0) or (
+            not dry_run and retcode in self.mt5_successful_trade_retcodes
         ):
             self.logger.info("response: %s", response)
             return response
-        elif retcode in {
-            self.mt5.TRADE_RETCODE_TRADE_DISABLED,
-            self.mt5.TRADE_RETCODE_MARKET_CLOSED,
-            self.mt5.TRADE_RETCODE_NO_CHANGES,
-        }:
-            self.logger.info("response: %s", response)
-            comment = response.get("comment", "Unknown error")
-            self.logger.warning("%s() failed and skipped. <= `%s`", order_func, comment)
-            return response
-        else:
+        elif raise_on_error:
             self.logger.error("response: %s", response)
-            comment = response.get("comment", "Unknown error")
+            comment = response.get("comment")
             error_message = f"{order_func}() failed and aborted. <= `{comment}`"
             raise Mt5TradingError(error_message)
+        else:
+            self.logger.warning("response: %s", response)
+            comment = response.get("comment")
+            self.logger.warning("%s() failed and skipped. <= `%s`", order_func, comment)
+            return response
 
     def place_market_order(
         self,

{pdmt5-0.1.8 → pdmt5-0.1.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pdmt5"
-version = "0.1.8"
+version = "0.1.9"
 description = "Pandas-based data handler for MetaTrader 5"
 authors = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
 maintainers = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]

{pdmt5-0.1.8 → pdmt5-0.1.9}/tests/test_trading.py

@@ -20,7 +20,7 @@ Mt5TradingClient.model_rebuild()
 
 
 @pytest.fixture(autouse=True)
-def mock_mt5_import(
+def mock_mt5_import(  # noqa: PLR0915
     request: pytest.FixtureRequest,
     mocker: MockerFixture,
 ) -> Generator[ModuleType | None, None, None]:
@@ -69,10 +69,50 @@ def mock_mt5_import(
         mock_mt5.ORDER_FILLING_FOK = 2
         mock_mt5.ORDER_FILLING_RETURN = 3
         mock_mt5.ORDER_TIME_GTC = 0
+
+        # Trade return codes
+        mock_mt5.TRADE_RETCODE_REQUOTE = 10004
+        mock_mt5.TRADE_RETCODE_REJECT = 10006
+        mock_mt5.TRADE_RETCODE_CANCEL = 10007
+        mock_mt5.TRADE_RETCODE_PLACED = 10008
         mock_mt5.TRADE_RETCODE_DONE = 10009
+        mock_mt5.TRADE_RETCODE_DONE_PARTIAL = 10010
+        mock_mt5.TRADE_RETCODE_ERROR = 10011
+        mock_mt5.TRADE_RETCODE_TIMEOUT = 10012
+        mock_mt5.TRADE_RETCODE_INVALID = 10013
+        mock_mt5.TRADE_RETCODE_INVALID_VOLUME = 10014
+        mock_mt5.TRADE_RETCODE_INVALID_PRICE = 10015
+        mock_mt5.TRADE_RETCODE_INVALID_STOPS = 10016
         mock_mt5.TRADE_RETCODE_TRADE_DISABLED = 10017
         mock_mt5.TRADE_RETCODE_MARKET_CLOSED = 10018
+        mock_mt5.TRADE_RETCODE_NO_MONEY = 10019
+        mock_mt5.TRADE_RETCODE_PRICE_CHANGED = 10020
+        mock_mt5.TRADE_RETCODE_PRICE_OFF = 10021
+        mock_mt5.TRADE_RETCODE_INVALID_EXPIRATION = 10022
+        mock_mt5.TRADE_RETCODE_ORDER_CHANGED = 10023
+        mock_mt5.TRADE_RETCODE_TOO_MANY_REQUESTS = 10024
         mock_mt5.TRADE_RETCODE_NO_CHANGES = 10025
+        mock_mt5.TRADE_RETCODE_SERVER_DISABLES_AT = 10026
+        mock_mt5.TRADE_RETCODE_CLIENT_DISABLES_AT = 10027
+        mock_mt5.TRADE_RETCODE_LOCKED = 10028
+        mock_mt5.TRADE_RETCODE_FROZEN = 10029
+        mock_mt5.TRADE_RETCODE_INVALID_FILL = 10030
+        mock_mt5.TRADE_RETCODE_CONNECTION = 10031
+        mock_mt5.TRADE_RETCODE_ONLY_REAL = 10032
+        mock_mt5.TRADE_RETCODE_LIMIT_ORDERS = 10033
+        mock_mt5.TRADE_RETCODE_LIMIT_VOLUME = 10034
+        mock_mt5.TRADE_RETCODE_INVALID_ORDER = 10035
+        mock_mt5.TRADE_RETCODE_POSITION_CLOSED = 10036
+        mock_mt5.TRADE_RETCODE_INVALID_CLOSE_VOLUME = 10038
+        mock_mt5.TRADE_RETCODE_CLOSE_ORDER_EXIST = 10039
+        mock_mt5.TRADE_RETCODE_LIMIT_POSITIONS = 10040
+        mock_mt5.TRADE_RETCODE_REJECT_CANCEL = 10041
+        mock_mt5.TRADE_RETCODE_LONG_ONLY = 10042
+        mock_mt5.TRADE_RETCODE_SHORT_ONLY = 10043
+        mock_mt5.TRADE_RETCODE_CLOSE_ONLY = 10044
+        mock_mt5.TRADE_RETCODE_FIFO_CLOSE = 10045
+        mock_mt5.TRADE_RETCODE_HEDGE_PROHIBITED = 10046
+
         mock_mt5.RES_S_OK = 1
         mock_mt5.DEAL_TYPE_BUY = 0
         mock_mt5.DEAL_TYPE_SELL = 1
@@ -612,15 +652,15 @@ class TestMt5TradingClient:
             "type": 1,
         }
 
-        # Mock failure response
-        mock_mt5_import.order_send.return_value.retcode = 10004
+        # Mock failure response with error retcode
+        mock_mt5_import.order_send.return_value.retcode = 10006
         mock_mt5_import.order_send.return_value._asdict.return_value = {
-            "retcode": 10004,
+            "retcode": 10006,
             "comment": "Invalid request",
         }
 
         with pytest.raises(Mt5TradingError, match=r"order_send\(\) failed and aborted"):
-            client._send_or_check_order(request)
+            client._send_or_check_order(request, raise_on_error=True)
 
     def test_send_or_check_order_dry_run_failure(
         self,
@@ -638,17 +678,17 @@ class TestMt5TradingClient:
             "type": 1,
         }
 
-        # Mock failure response
-        mock_mt5_import.order_check.return_value.retcode = 10004
+        # Mock failure response with non-zero retcode for dry run
+        mock_mt5_import.order_check.return_value.retcode = 10013
         mock_mt5_import.order_check.return_value._asdict.return_value = {
-            "retcode": 10004,
+            "retcode": 10013,
             "comment": "Invalid request",
         }
 
         with pytest.raises(
             Mt5TradingError, match=r"order_check\(\) failed and aborted"
         ):
-            client._send_or_check_order(request, dry_run=True)
+            client._send_or_check_order(request, raise_on_error=True, dry_run=True)
 
     def test_send_or_check_order_dry_run_override(
         self,
@@ -1896,3 +1936,79 @@ class TestMt5TradingClient:
         assert isinstance(result, list)
         assert len(result) == 2
         assert all(r["retcode"] == 10009 for r in result)
+
+    def test_mt5_successful_trade_retcodes_property(
+        self, mock_mt5_import: ModuleType
+    ) -> None:
+        """Test mt5_successful_trade_retcodes property returns correct set of codes."""
+        client = Mt5TradingClient(mt5=mock_mt5_import)
+
+        # Get the property value
+        retcodes = client.mt5_successful_trade_retcodes
+
+        # Verify it's a set
+        assert isinstance(retcodes, set)
+
+        # Verify the expected codes are present
+        assert retcodes == {
+            mock_mt5_import.TRADE_RETCODE_PLACED,  # 10008
+            mock_mt5_import.TRADE_RETCODE_DONE,  # 10009
+            mock_mt5_import.TRADE_RETCODE_DONE_PARTIAL,  # 10010
+        }
+
+    def test_mt5_failed_trade_retcodes_property(
+        self, mock_mt5_import: ModuleType
+    ) -> None:
+        """Test mt5_failed_trade_retcodes property returns correct set of codes."""
+        client = Mt5TradingClient(mt5=mock_mt5_import)
+
+        # Get the property value
+        retcodes = client.mt5_failed_trade_retcodes
+
+        # Verify it's a set
+        assert isinstance(retcodes, set)
+
+        # Verify it contains the expected codes
+        expected_codes = {
+            mock_mt5_import.TRADE_RETCODE_REQUOTE,  # 10004
+            mock_mt5_import.TRADE_RETCODE_REJECT,  # 10006
+            mock_mt5_import.TRADE_RETCODE_CANCEL,  # 10007
+            mock_mt5_import.TRADE_RETCODE_ERROR,  # 10011
+            mock_mt5_import.TRADE_RETCODE_TIMEOUT,  # 10012
+            mock_mt5_import.TRADE_RETCODE_INVALID,  # 10013
+            mock_mt5_import.TRADE_RETCODE_INVALID_VOLUME,  # 10014
+            mock_mt5_import.TRADE_RETCODE_INVALID_PRICE,  # 10015
+            mock_mt5_import.TRADE_RETCODE_INVALID_STOPS,  # 10016
+            mock_mt5_import.TRADE_RETCODE_TRADE_DISABLED,  # 10017
+            mock_mt5_import.TRADE_RETCODE_MARKET_CLOSED,  # 10018
+            mock_mt5_import.TRADE_RETCODE_NO_MONEY,  # 10019
+            mock_mt5_import.TRADE_RETCODE_PRICE_CHANGED,  # 10020
+            mock_mt5_import.TRADE_RETCODE_PRICE_OFF,  # 10021
+            mock_mt5_import.TRADE_RETCODE_INVALID_EXPIRATION,  # 10022
+            mock_mt5_import.TRADE_RETCODE_ORDER_CHANGED,  # 10023
+            mock_mt5_import.TRADE_RETCODE_TOO_MANY_REQUESTS,  # 10024
+            mock_mt5_import.TRADE_RETCODE_NO_CHANGES,  # 10025
+            mock_mt5_import.TRADE_RETCODE_SERVER_DISABLES_AT,  # 10026
+            mock_mt5_import.TRADE_RETCODE_CLIENT_DISABLES_AT,  # 10027
+            mock_mt5_import.TRADE_RETCODE_LOCKED,  # 10028
+            mock_mt5_import.TRADE_RETCODE_FROZEN,  # 10029
+            mock_mt5_import.TRADE_RETCODE_INVALID_FILL,  # 10030
+            mock_mt5_import.TRADE_RETCODE_CONNECTION,  # 10031
+            mock_mt5_import.TRADE_RETCODE_ONLY_REAL,  # 10032
+            mock_mt5_import.TRADE_RETCODE_LIMIT_ORDERS,  # 10033
+            mock_mt5_import.TRADE_RETCODE_LIMIT_VOLUME,  # 10034
+            mock_mt5_import.TRADE_RETCODE_INVALID_ORDER,  # 10035
+            mock_mt5_import.TRADE_RETCODE_POSITION_CLOSED,  # 10036
+            mock_mt5_import.TRADE_RETCODE_INVALID_CLOSE_VOLUME,  # 10038
+            mock_mt5_import.TRADE_RETCODE_CLOSE_ORDER_EXIST,  # 10039
+            mock_mt5_import.TRADE_RETCODE_LIMIT_POSITIONS,  # 10040
+            mock_mt5_import.TRADE_RETCODE_REJECT_CANCEL,  # 10041
+            mock_mt5_import.TRADE_RETCODE_LONG_ONLY,  # 10042
+            mock_mt5_import.TRADE_RETCODE_SHORT_ONLY,  # 10043
+            mock_mt5_import.TRADE_RETCODE_CLOSE_ONLY,  # 10044
+            mock_mt5_import.TRADE_RETCODE_FIFO_CLOSE,  # 10045
+            mock_mt5_import.TRADE_RETCODE_HEDGE_PROHIBITED,  # 10046
+        }
+
+        # Verify all expected codes are present
+        assert retcodes == expected_codes

{pdmt5-0.1.8 → pdmt5-0.1.9}/uv.lock

@@ -613,7 +613,7 @@ wheels = [
 
 [[package]]
 name = "pdmt5"
-version = "0.1.8"
+version = "0.1.9"
 source = { editable = "." }
 dependencies = [
     { name = "metatrader5", marker = "sys_platform == 'win32'" },