Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| dfe80ce500 | |||
| 15bfd17db3 | |||
| 37eef16e99 | |||
| 96c75f7852 |
@@ -92,16 +92,21 @@ Schema contracts live in `mt5cli.schemas` (`DataKind`, `validate_schema`, `norma
|
|||||||
Trading applications can depend on `mt5cli` imports only; terminal path,
|
Trading applications can depend on `mt5cli` imports only; terminal path,
|
||||||
credentials, server, and timeout are forwarded to `pdmt5.Mt5Config`, numeric
|
credentials, server, and timeout are forwarded to `pdmt5.Mt5Config`, numeric
|
||||||
login strings are coerced to integers, and empty login strings are treated as
|
login strings are coerced to integers, and empty login strings are treated as
|
||||||
unset.
|
unset. Pass `allow_whole_dollar_env=True` to expand `${ENV_VAR}` and bare
|
||||||
|
`$ENV_NAME` placeholders in connection string parameters before coercion.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from mt5cli import (
|
from mt5cli import (
|
||||||
|
build_config,
|
||||||
calculate_spread_ratio,
|
calculate_spread_ratio,
|
||||||
create_trading_client,
|
create_trading_client,
|
||||||
get_account_snapshot,
|
get_account_snapshot,
|
||||||
mt5_trading_session,
|
mt5_trading_session,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Login from environment — numeric string is coerced to int automatically
|
||||||
|
config = build_config(login="$MT5_LOGIN", allow_whole_dollar_env=True)
|
||||||
|
|
||||||
with mt5_trading_session(
|
with mt5_trading_session(
|
||||||
path=r"C:\Program Files\MetaTrader 5\terminal64.exe",
|
path=r"C:\Program Files\MetaTrader 5\terminal64.exe",
|
||||||
login="12345",
|
login="12345",
|
||||||
@@ -173,10 +178,13 @@ python -m mt5cli -o account.csv account-info
|
|||||||
| `recent-history-deals` | Export historical deals from a recent trailing window |
|
| `recent-history-deals` | Export historical deals from a recent trailing window |
|
||||||
| `mt5-summary` | Export terminal/account status summary |
|
| `mt5-summary` | Export terminal/account status summary |
|
||||||
| `order-check` | Check funds sufficiency for a trade request |
|
| `order-check` | Check funds sufficiency for a trade request |
|
||||||
| `order-send` | Send a trade request to the trade server (`--yes` required) |
|
| `order-send` | Send a raw trade request to the trade server (`--yes` required; expert path) |
|
||||||
|
| `close-positions` | Close open positions by `--symbol` or `--ticket` (`--yes` required for live; `--dry-run` available) |
|
||||||
| `collect-history` | Bundle rates, ticks, history-orders, and history-deals for one or more symbols into a single SQLite database |
|
| `collect-history` | Bundle rates, ticks, history-orders, and history-deals for one or more symbols into a single SQLite database |
|
||||||
|
|
||||||
Use `order-check` to validate a request payload before running `order-send --yes`.
|
Use `order-check` to validate a request payload before running `order-send --yes`.
|
||||||
|
`close-positions` is the safer high-level alternative that builds correct close
|
||||||
|
requests automatically. At least one `--symbol` or `--ticket` must be provided.
|
||||||
|
|
||||||
### `collect-history`
|
### `collect-history`
|
||||||
|
|
||||||
@@ -248,7 +256,7 @@ rates = collect_latest_closed_rates_by_granularity(
|
|||||||
eurusd_m1 = rates["EURUSD", "M1"] # closed bars only
|
eurusd_m1 = rates["EURUSD", "M1"] # closed bars only
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Credential resolution**: use `resolve_account_spec()` / `resolve_account_specs()` to merge explicit override values over `AccountSpec` fields and expand `${ENV_VAR}` placeholders (via `substitute_env_placeholders()`), raising `ValueError` for missing variables. This keeps secrets out of plan/config files without coupling to any strategy code.
|
- **Credential resolution**: use `resolve_account_spec()` / `resolve_account_specs()` to merge explicit override values over `AccountSpec` fields and expand `${ENV_VAR}` placeholders (via `substitute_env_placeholders()`), raising `ValueError` for missing variables. This keeps secrets out of plan/config files without coupling to any strategy code. For config dicts or nested structures loaded from YAML/TOML, use `substitute_mapping_values(data, keys={"login", "password"})` to expand placeholders only for caller-specified keys — key names are never hard-coded in mt5cli.
|
||||||
- **Throttled history updates**: use `ThrottledHistoryUpdater` to wrap `update_history()` with a minimum `interval_seconds` between successful runs (monotonic clock). Call `should_update()` / `update(client, symbols)` from an application loop; errors propagate by default, or pass `suppress_errors=True` to swallow recoverable `Mt5*Error`, `sqlite3.Error`, `ValueError`, `OSError`, and MT5 client capability errors for history API methods without advancing the throttle (other `AttributeError` / `TypeError` values always propagate). Pass `update_backend` to inject a custom history update callable (same keyword arguments as `update_history`) instead of monkey-patching `mt5cli.sdk.update_history`.
|
- **Throttled history updates**: use `ThrottledHistoryUpdater` to wrap `update_history()` with a minimum `interval_seconds` between successful runs (monotonic clock). Call `should_update()` / `update(client, symbols)` from an application loop; errors propagate by default, or pass `suppress_errors=True` to swallow recoverable `Mt5*Error`, `sqlite3.Error`, `ValueError`, `OSError`, and MT5 client capability errors for history API methods without advancing the throttle (other `AttributeError` / `TypeError` values always propagate). Pass `update_backend` to inject a custom history update callable (same keyword arguments as `update_history`) instead of monkey-patching `mt5cli.sdk.update_history`.
|
||||||
- **Trading session helpers**: use `mt5_trading_session()` for a trading-capable `pdmt5.Mt5TradingClient` that initializes/logs in via `Mt5Config.path` and always shuts down safely. Pair with `detect_position_side()`, `calculate_margin_and_volume()`, and `determine_order_limits()` for generic position and sizing utilities. Keep read-only collection on `mt5_session()` / `MT5Client`.
|
- **Trading session helpers**: use `mt5_trading_session()` for a trading-capable `pdmt5.Mt5TradingClient` that initializes/logs in via `Mt5Config.path` and always shuts down safely. Pair with `detect_position_side()`, `calculate_margin_and_volume()`, and `determine_order_limits()` for generic position and sizing utilities. Keep read-only collection on `mt5_session()` / `MT5Client`.
|
||||||
- **Granularity-keyed rate loading**: `load_rate_series_by_granularity()` builds targets with `build_rate_targets()`, loads them with `load_rate_series_from_sqlite()`, and returns a mapping keyed by `(symbol | None, granularity_name)` such as `("EURUSD", "M1")` to reduce downstream boilerplate.
|
- **Granularity-keyed rate loading**: `load_rate_series_by_granularity()` builds targets with `build_rate_targets()`, loads them with `load_rate_series_from_sqlite()`, and returns a mapping keyed by `(symbol | None, granularity_name)` such as `("EURUSD", "M1")` to reduce downstream boilerplate.
|
||||||
|
|||||||
+46
-30
@@ -28,23 +28,25 @@ These names are exported from `mt5cli` and covered by the contract in
|
|||||||
|
|
||||||
### Session lifecycle and configuration
|
### Session lifecycle and configuration
|
||||||
|
|
||||||
| Symbol | Role |
|
| Symbol | Role |
|
||||||
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `MT5Client` | Read-only data client with optional `order_check` / `order_send` |
|
| `MT5Client` | Read-only data client with optional `order_check` / `order_send` |
|
||||||
| `build_config` | Build `pdmt5.Mt5Config` from connection fields |
|
| `build_config` | Build `pdmt5.Mt5Config` from connection fields; `login` accepts `int \| str \| None` — numeric strings are coerced to `int`, blank strings are treated as unset, and `${ENV_VAR}` / `$ENV_NAME` placeholders in string parameters are expanded when `allow_whole_dollar_env=True` |
|
||||||
| `mt5_session` | Context manager: initialize, login, yield client, shutdown |
|
| `mt5_session` | Context manager: initialize, login, yield client, shutdown |
|
||||||
| `create_trading_client`, `mt5_trading_session` | Trading-capable `pdmt5.Mt5TradingClient` lifecycle |
|
| `create_trading_client`, `mt5_trading_session` | Trading-capable `pdmt5.Mt5TradingClient` lifecycle |
|
||||||
| `AccountSpec` | Generic account group: symbols plus optional credentials |
|
| `AccountSpec` | Generic account group: symbols plus optional credentials |
|
||||||
| `resolve_account_spec`, `resolve_account_specs` | Merge overrides and expand `${ENV_VAR}` placeholders; opt-in `allow_whole_dollar_env` for bare `$NAME` |
|
| `resolve_account_spec`, `resolve_account_specs` | Merge overrides and expand `${ENV_VAR}` placeholders; opt-in `allow_whole_dollar_env` for bare `$NAME` |
|
||||||
| `substitute_env_placeholders` | Replace `${NAME}` substrings from the environment; opt-in `allow_whole_dollar_env` for whole-value `$NAME` |
|
| `substitute_env_placeholders` | Replace `${NAME}` substrings from the environment; opt-in `allow_whole_dollar_env` for whole-value `$NAME` |
|
||||||
|
| `substitute_mapping_values` | Recursively traverse a dict/list/scalar structure and substitute `${ENV_VAR}` placeholders for caller-selected mapping keys only; optionally normalise blank strings to `None` for a separate caller-selected key set; does not hard-code any application-specific key names |
|
||||||
|
|
||||||
Credential resolution is generic: any environment variable name may appear inside
|
Credential resolution is generic: any environment variable name may appear inside
|
||||||
`${...}`. mt5cli does not hard-code application-specific keys such as
|
`${...}`. mt5cli does not hard-code application-specific keys such as
|
||||||
`mt5_login` or `mt5_exe`.
|
`mt5_login` or `mt5_exe`.
|
||||||
|
|
||||||
Pass `allow_whole_dollar_env=True` to `substitute_env_placeholders()`,
|
Pass `allow_whole_dollar_env=True` to `substitute_env_placeholders()`,
|
||||||
`resolve_account_spec()`, `resolve_account_specs()`, and `build_config()` to
|
`substitute_mapping_values()`, `resolve_account_spec()`, `resolve_account_specs()`,
|
||||||
additionally expand strings whose entire value is a bare `$ENV_NAME` identifier.
|
and `build_config()` to additionally expand strings whose entire value is a bare
|
||||||
|
`$ENV_NAME` identifier.
|
||||||
Partial strings such as `"plan$pass"`, `"abc$ENV"`, or `"$ENV-suffix"` are
|
Partial strings such as `"plan$pass"`, `"abc$ENV"`, or `"$ENV-suffix"` are
|
||||||
**never** expanded — only an exact `$IDENTIFIER` whole-string match qualifies.
|
**never** expanded — only an exact `$IDENTIFIER` whole-string match qualifies.
|
||||||
Default is `False` to preserve backward compatibility.
|
Default is `False` to preserve backward compatibility.
|
||||||
@@ -90,24 +92,33 @@ diagrams.
|
|||||||
These helpers implement broker-facing calculations only. They do not encode
|
These helpers implement broker-facing calculations only. They do not encode
|
||||||
strategy entries, exits, Kelly sizing, or signal logic.
|
strategy entries, exits, Kelly sizing, or signal logic.
|
||||||
|
|
||||||
| Symbol | Role |
|
| Symbol | Role |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
|
||||||
| `get_account_snapshot`, `get_symbol_snapshot`, `get_tick_snapshot`, `get_positions_frame` | Normalized account/symbol/tick/position views |
|
| `get_account_snapshot`, `get_symbol_snapshot`, `get_tick_snapshot`, `get_positions_frame` | Normalized account/symbol/tick/position views |
|
||||||
| `extract_tick_price` | Positive finite bid/ask extraction from tick mappings |
|
| `extract_tick_price` | Positive finite bid/ask extraction from tick mappings |
|
||||||
| `detect_position_side` | Net long / short / flat from open positions |
|
| `detect_position_side` | Net long / short / flat from open positions |
|
||||||
| `calculate_spread_ratio` | Relative bid-ask spread |
|
| `calculate_spread_ratio` | Relative bid-ask spread |
|
||||||
| `calculate_margin_and_volume`, `calculate_volume_by_margin`, `calculate_new_position_margin_ratio` | Margin budget and volume sizing |
|
| `calculate_margin_and_volume`, `calculate_volume_by_margin`, `calculate_new_position_margin_ratio` | Margin budget and volume sizing |
|
||||||
| `normalize_order_volume`, `estimate_order_margin`, `calculate_positions_margin` | Broker volume normalization and margin totals |
|
| `normalize_order_volume`, `estimate_order_margin`, `calculate_positions_margin` | Broker volume normalization and margin totals |
|
||||||
| `calculate_positions_margin_by_symbol` | Per-symbol margin map (resilient, first-seen order) |
|
| `calculate_positions_margin_by_symbol` | Per-symbol margin map (resilient, first-seen order) |
|
||||||
| `calculate_positions_margin_safe` | Summed total margin across symbols (failed symbols skipped) |
|
| `calculate_positions_margin_safe` | Summed total margin across symbols (failed symbols skipped) |
|
||||||
| `calculate_projected_margin_ratio` | Estimated symbol margin/equity after optional new exposure |
|
| `calculate_projected_margin_ratio` | Estimated symbol-scoped margin/equity after optional new exposure |
|
||||||
| `calculate_symbol_group_margin_ratio` | Estimated symbol-group margin/equity with optional exposure |
|
| `calculate_account_projected_margin_ratio` | Account snapshot margin/equity after optional new exposure |
|
||||||
| `determine_order_limits` | SL/TP price levels from ratios |
|
| `calculate_symbol_group_margin_ratio` | Estimated symbol-group margin/equity with optional exposure |
|
||||||
| `calculate_trailing_stop_updates` | Per-ticket generic trailing stop-loss update plan |
|
| `determine_order_limits` | SL/TP price levels from ratios |
|
||||||
| `ensure_symbol_selected` | Select/verify Market Watch visibility |
|
| `calculate_trailing_stop_updates` | Per-ticket generic trailing stop-loss update plan |
|
||||||
| `place_market_order`, `close_open_positions`, `update_sltp_for_open_positions`, `update_trailing_stop_loss_for_open_positions` | Order execution helpers (`dry_run` supported) |
|
| `ensure_symbol_selected` | Select/verify Market Watch visibility |
|
||||||
| `MarginVolume`, `OrderLimits`, `OrderExecutionResult` | Typed return contracts for order helpers |
|
| `place_market_order`, `close_open_positions`, `update_sltp_for_open_positions`, `update_trailing_stop_loss_for_open_positions` | Order execution helpers (`dry_run` supported) |
|
||||||
| `OrderSide`, `OrderFillingMode`, `OrderTimeMode`, `PositionSide`, `ExecutionStatus` | Typed enums for order helpers |
|
| `MarginVolume`, `OrderLimits`, `OrderExecutionResult` | Typed return contracts for order helpers |
|
||||||
|
| `OrderSide`, `OrderFillingMode`, `OrderTimeMode`, `PositionSide`, `ExecutionStatus` | Typed enums for order helpers |
|
||||||
|
| `ProjectionMode` | Literal type for `calculate_symbol_group_margin_ratio` projection |
|
||||||
|
|
||||||
|
`calculate_symbol_group_margin_ratio` accepts an optional `projection_mode`
|
||||||
|
parameter (`"add"` by default). Pass `projection_mode="replace_symbol"` to
|
||||||
|
subtract current exposure for `new_symbol` before adding the candidate margin —
|
||||||
|
useful for reversal-style projections. mt5cli only calculates broker-facing
|
||||||
|
exposure; downstream applications own thresholds, risk guard actions, and
|
||||||
|
strategy policy.
|
||||||
|
|
||||||
`MT5Client.order_send()` and CLI `order-send --yes` are live execution paths.
|
`MT5Client.order_send()` and CLI `order-send --yes` are live execution paths.
|
||||||
|
|
||||||
@@ -179,7 +190,12 @@ The Typer application in `mt5cli.cli` exposes file-export commands documented in
|
|||||||
- Delegate to the same Python APIs described here; they are not duplicated
|
- Delegate to the same Python APIs described here; they are not duplicated
|
||||||
business logic.
|
business logic.
|
||||||
|
|
||||||
`order-send` requires `--yes` before placing live trades.
|
`order-send` is the expert raw-request path; it requires `--yes` and a fully
|
||||||
|
constructed request payload. `close-positions` is the safer high-level helper
|
||||||
|
that closes open positions by `--symbol` or `--ticket` using
|
||||||
|
`close_open_positions()`. Both `order-send --yes` and `close-positions --yes`
|
||||||
|
are live execution paths. `close-positions --dry-run` previews close orders
|
||||||
|
without placing them and does not require `--yes`.
|
||||||
|
|
||||||
## Internal helpers (not stable)
|
## Internal helpers (not stable)
|
||||||
|
|
||||||
|
|||||||
@@ -92,6 +92,7 @@ from .sdk import (
|
|||||||
resolve_account_spec,
|
resolve_account_spec,
|
||||||
resolve_account_specs,
|
resolve_account_specs,
|
||||||
substitute_env_placeholders,
|
substitute_env_placeholders,
|
||||||
|
substitute_mapping_values,
|
||||||
symbol_info,
|
symbol_info,
|
||||||
symbol_info_tick,
|
symbol_info_tick,
|
||||||
symbols,
|
symbols,
|
||||||
@@ -119,6 +120,8 @@ from .trading import (
|
|||||||
OrderSide,
|
OrderSide,
|
||||||
OrderTimeMode,
|
OrderTimeMode,
|
||||||
PositionSide,
|
PositionSide,
|
||||||
|
ProjectionMode,
|
||||||
|
calculate_account_projected_margin_ratio,
|
||||||
calculate_margin_and_volume,
|
calculate_margin_and_volume,
|
||||||
calculate_new_position_margin_ratio,
|
calculate_new_position_margin_ratio,
|
||||||
calculate_positions_margin,
|
calculate_positions_margin,
|
||||||
@@ -190,12 +193,14 @@ __all__ = [
|
|||||||
"OrderSide",
|
"OrderSide",
|
||||||
"OrderTimeMode",
|
"OrderTimeMode",
|
||||||
"PositionSide",
|
"PositionSide",
|
||||||
|
"ProjectionMode",
|
||||||
"RateTarget",
|
"RateTarget",
|
||||||
"ThrottledHistoryUpdater",
|
"ThrottledHistoryUpdater",
|
||||||
"account_info",
|
"account_info",
|
||||||
"build_config",
|
"build_config",
|
||||||
"build_rate_targets",
|
"build_rate_targets",
|
||||||
"build_rate_view_name",
|
"build_rate_view_name",
|
||||||
|
"calculate_account_projected_margin_ratio",
|
||||||
"calculate_margin_and_volume",
|
"calculate_margin_and_volume",
|
||||||
"calculate_new_position_margin_ratio",
|
"calculate_new_position_margin_ratio",
|
||||||
"calculate_positions_margin",
|
"calculate_positions_margin",
|
||||||
@@ -281,6 +286,7 @@ __all__ = [
|
|||||||
"resolve_rate_view_names",
|
"resolve_rate_view_names",
|
||||||
"schema_columns",
|
"schema_columns",
|
||||||
"substitute_env_placeholders",
|
"substitute_env_placeholders",
|
||||||
|
"substitute_mapping_values",
|
||||||
"symbol_info",
|
"symbol_info",
|
||||||
"symbol_info_tick",
|
"symbol_info_tick",
|
||||||
"symbols",
|
"symbols",
|
||||||
|
|||||||
+93
-2
@@ -2,17 +2,20 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from datetime import datetime # noqa: TC003
|
from datetime import datetime # noqa: TC003
|
||||||
from pathlib import Path # noqa: TC003
|
from pathlib import Path # noqa: TC003
|
||||||
from typing import TYPE_CHECKING, Annotated, Any, cast
|
from typing import TYPE_CHECKING, Annotated, Any, cast
|
||||||
|
|
||||||
|
import pandas as pd
|
||||||
import typer
|
import typer
|
||||||
from pdmt5 import Mt5Config
|
from pdmt5 import Mt5Config
|
||||||
|
|
||||||
from . import sdk
|
from . import sdk
|
||||||
from .client import MT5Client
|
from .client import MT5Client
|
||||||
|
from .trading import OrderExecutionResult, close_open_positions, create_trading_client
|
||||||
from .utils import (
|
from .utils import (
|
||||||
DATETIME_TYPE,
|
DATETIME_TYPE,
|
||||||
REQUEST_TYPE,
|
REQUEST_TYPE,
|
||||||
@@ -29,8 +32,6 @@ from .utils import (
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
|
|
||||||
import pandas as pd
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -600,6 +601,96 @@ def order_send(
|
|||||||
_export_command(ctx, lambda client: client.order_send(request))
|
_export_command(ctx, lambda client: client.order_send(request))
|
||||||
|
|
||||||
|
|
||||||
|
_EXECUTION_RESULT_COLUMNS: list[str] = [
|
||||||
|
"status",
|
||||||
|
"symbol",
|
||||||
|
"order_side",
|
||||||
|
"volume",
|
||||||
|
"retcode",
|
||||||
|
"comment",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"dry_run",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _execution_results_to_df(results: list[OrderExecutionResult]) -> pd.DataFrame:
|
||||||
|
if not results:
|
||||||
|
return pd.DataFrame(columns=_EXECUTION_RESULT_COLUMNS)
|
||||||
|
rows = [
|
||||||
|
{
|
||||||
|
**r,
|
||||||
|
"request": json.dumps(r["request"]),
|
||||||
|
"response": json.dumps(r["response"]),
|
||||||
|
}
|
||||||
|
for r in results
|
||||||
|
]
|
||||||
|
return pd.DataFrame(rows)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command()
|
||||||
|
def close_positions(
|
||||||
|
ctx: typer.Context,
|
||||||
|
symbol: Annotated[
|
||||||
|
list[str] | None,
|
||||||
|
typer.Option(
|
||||||
|
"--symbol",
|
||||||
|
"-s",
|
||||||
|
help="Symbol to close (repeat for multiple symbols).",
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
ticket: Annotated[
|
||||||
|
list[int] | None,
|
||||||
|
typer.Option(
|
||||||
|
"--ticket",
|
||||||
|
"-t",
|
||||||
|
help="Position ticket to close (repeat for multiple tickets).",
|
||||||
|
),
|
||||||
|
] = None,
|
||||||
|
dry_run: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option("--dry-run", help="Preview close orders without executing them."),
|
||||||
|
] = False,
|
||||||
|
yes: Annotated[
|
||||||
|
bool,
|
||||||
|
typer.Option("--yes", help="Confirm live position closing."),
|
||||||
|
] = False,
|
||||||
|
) -> None:
|
||||||
|
"""Close open positions by symbol or ticket.
|
||||||
|
|
||||||
|
Delegates to :func:`mt5cli.trading.close_open_positions`. At least one
|
||||||
|
``--symbol`` or ``--ticket`` must be provided to avoid accidentally closing
|
||||||
|
all positions. Use ``--dry-run`` to preview without executing; ``--yes`` is
|
||||||
|
required for live execution.
|
||||||
|
|
||||||
|
``order-send`` is the expert raw-request path. ``close-positions`` is the
|
||||||
|
safer high-level helper that builds correct close requests automatically.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
typer.BadParameter: If neither ``--symbol`` nor ``--ticket`` is given,
|
||||||
|
or if ``--yes`` is missing for a live (non-dry-run) run.
|
||||||
|
"""
|
||||||
|
if not symbol and not ticket:
|
||||||
|
msg = "Provide at least one --symbol or --ticket to close positions."
|
||||||
|
raise typer.BadParameter(msg)
|
||||||
|
if not dry_run and not yes:
|
||||||
|
msg = "Pass --yes to close live positions."
|
||||||
|
raise typer.BadParameter(msg, param_hint="--yes")
|
||||||
|
export_ctx = _get_export_context(ctx)
|
||||||
|
client = create_trading_client(config=export_ctx.config)
|
||||||
|
try:
|
||||||
|
results = close_open_positions(
|
||||||
|
client,
|
||||||
|
symbols=list(symbol) if symbol else None,
|
||||||
|
tickets=list(ticket) if ticket else None,
|
||||||
|
dry_run=dry_run,
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
client.shutdown()
|
||||||
|
df = _execution_results_to_df(results)
|
||||||
|
_execute_export(ctx, lambda: df)
|
||||||
|
|
||||||
|
|
||||||
@app.command()
|
@app.command()
|
||||||
def collect_history(
|
def collect_history(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ STABLE_SDK_EXPORTS: frozenset[str] = frozenset({
|
|||||||
"OrderSide",
|
"OrderSide",
|
||||||
"OrderTimeMode",
|
"OrderTimeMode",
|
||||||
"PositionSide",
|
"PositionSide",
|
||||||
|
"ProjectionMode",
|
||||||
"ExecutionStatus",
|
"ExecutionStatus",
|
||||||
"MarginVolume",
|
"MarginVolume",
|
||||||
"OrderExecutionResult",
|
"OrderExecutionResult",
|
||||||
@@ -26,6 +27,7 @@ STABLE_SDK_EXPORTS: frozenset[str] = frozenset({
|
|||||||
"build_config",
|
"build_config",
|
||||||
"build_rate_targets",
|
"build_rate_targets",
|
||||||
"build_rate_view_name",
|
"build_rate_view_name",
|
||||||
|
"calculate_account_projected_margin_ratio",
|
||||||
"calculate_margin_and_volume",
|
"calculate_margin_and_volume",
|
||||||
"calculate_new_position_margin_ratio",
|
"calculate_new_position_margin_ratio",
|
||||||
"calculate_projected_margin_ratio",
|
"calculate_projected_margin_ratio",
|
||||||
@@ -76,6 +78,7 @@ STABLE_SDK_EXPORTS: frozenset[str] = frozenset({
|
|||||||
"resolve_rate_view_name",
|
"resolve_rate_view_name",
|
||||||
"resolve_rate_view_names",
|
"resolve_rate_view_names",
|
||||||
"substitute_env_placeholders",
|
"substitute_env_placeholders",
|
||||||
|
"substitute_mapping_values",
|
||||||
"update_history",
|
"update_history",
|
||||||
"update_history_with_config",
|
"update_history_with_config",
|
||||||
"update_sltp_for_open_positions",
|
"update_sltp_for_open_positions",
|
||||||
|
|||||||
+83
-6
@@ -40,7 +40,7 @@ from .utils import (
|
|||||||
from .utils import coerce_login as _coerce_login
|
from .utils import coerce_login as _coerce_login
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable, Iterator, Sequence
|
from collections.abc import Callable, Collection, Iterator, Sequence
|
||||||
|
|
||||||
UpdateHistoryBackend = Callable[..., None]
|
UpdateHistoryBackend = Callable[..., None]
|
||||||
|
|
||||||
@@ -142,6 +142,7 @@ __all__ = [
|
|||||||
"resolve_account_spec",
|
"resolve_account_spec",
|
||||||
"resolve_account_specs",
|
"resolve_account_specs",
|
||||||
"substitute_env_placeholders",
|
"substitute_env_placeholders",
|
||||||
|
"substitute_mapping_values",
|
||||||
"symbol_info",
|
"symbol_info",
|
||||||
"symbol_info_tick",
|
"symbol_info_tick",
|
||||||
"symbols",
|
"symbols",
|
||||||
@@ -305,7 +306,7 @@ def _fetch_minimum_margins(client: Mt5DataClient, symbol: str) -> pd.DataFrame:
|
|||||||
def build_config(
|
def build_config(
|
||||||
*,
|
*,
|
||||||
path: str | None = None,
|
path: str | None = None,
|
||||||
login: int | None = None,
|
login: int | str | None = None,
|
||||||
password: str | None = None,
|
password: str | None = None,
|
||||||
server: str | None = None,
|
server: str | None = None,
|
||||||
timeout: int | None = None,
|
timeout: int | None = None,
|
||||||
@@ -315,14 +316,19 @@ def build_config(
|
|||||||
|
|
||||||
Args:
|
Args:
|
||||||
path: Optional terminal executable path.
|
path: Optional terminal executable path.
|
||||||
login: Optional trading account login.
|
login: Optional trading account login. Integers are preserved. String
|
||||||
|
values are coerced: empty or whitespace-only strings become
|
||||||
|
``None``; numeric strings such as ``"12345"`` are converted to
|
||||||
|
``int``; non-numeric strings raise ``ValueError``. When
|
||||||
|
``allow_whole_dollar_env=True``, ``$ENV_NAME`` and
|
||||||
|
``${ENV_NAME}`` placeholders are expanded before coercion.
|
||||||
password: Optional trading account password.
|
password: Optional trading account password.
|
||||||
server: Optional trading server name.
|
server: Optional trading server name.
|
||||||
timeout: Optional connection timeout in milliseconds.
|
timeout: Optional connection timeout in milliseconds.
|
||||||
allow_whole_dollar_env: When ``True``, string parameters that are
|
allow_whole_dollar_env: When ``True``, string parameters that are
|
||||||
exactly ``$ENV_NAME`` are expanded from the environment. Applies
|
exactly ``$ENV_NAME`` are expanded from the environment. Applies
|
||||||
to ``path``, ``password``, and ``server``. Default ``False``
|
to ``path``, ``login``, ``password``, and ``server``. Default
|
||||||
preserves existing behavior.
|
``False`` preserves existing behavior.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Configured ``Mt5Config`` instance.
|
Configured ``Mt5Config`` instance.
|
||||||
@@ -330,6 +336,8 @@ def build_config(
|
|||||||
if allow_whole_dollar_env:
|
if allow_whole_dollar_env:
|
||||||
if path is not None:
|
if path is not None:
|
||||||
path = substitute_env_placeholders(path, allow_whole_dollar_env=True)
|
path = substitute_env_placeholders(path, allow_whole_dollar_env=True)
|
||||||
|
if isinstance(login, str):
|
||||||
|
login = substitute_env_placeholders(login, allow_whole_dollar_env=True)
|
||||||
if password is not None:
|
if password is not None:
|
||||||
password = substitute_env_placeholders(
|
password = substitute_env_placeholders(
|
||||||
password, allow_whole_dollar_env=True
|
password, allow_whole_dollar_env=True
|
||||||
@@ -338,7 +346,7 @@ def build_config(
|
|||||||
server = substitute_env_placeholders(server, allow_whole_dollar_env=True)
|
server = substitute_env_placeholders(server, allow_whole_dollar_env=True)
|
||||||
return Mt5Config(
|
return Mt5Config(
|
||||||
path=path,
|
path=path,
|
||||||
login=login,
|
login=_coerce_login(login),
|
||||||
password=password,
|
password=password,
|
||||||
server=server,
|
server=server,
|
||||||
timeout=timeout,
|
timeout=timeout,
|
||||||
@@ -1442,6 +1450,75 @@ def substitute_env_placeholders(
|
|||||||
return "".join(parts)
|
return "".join(parts)
|
||||||
|
|
||||||
|
|
||||||
|
def substitute_mapping_values(
|
||||||
|
data: object,
|
||||||
|
*,
|
||||||
|
keys: Collection[str],
|
||||||
|
allow_whole_dollar_env: bool = False,
|
||||||
|
blank_string_keys_as_none: Collection[str] = (),
|
||||||
|
) -> object:
|
||||||
|
"""Recursively substitute environment placeholders for selected mapping keys.
|
||||||
|
|
||||||
|
Traverses nested dicts and lists, expanding ``${ENV_VAR}`` (and
|
||||||
|
``$ENV_NAME`` when ``allow_whole_dollar_env=True``) in string values
|
||||||
|
whose immediate parent dict key is in ``keys``. Fields whose key is
|
||||||
|
not in ``keys`` are preserved exactly, including literal dollar signs.
|
||||||
|
Strings that are direct elements of a list are never substituted;
|
||||||
|
substitution only applies to strings that are immediate dict values.
|
||||||
|
|
||||||
|
This is a generic downstream config utility. Key names such as
|
||||||
|
``mt5_login`` or ``mt5_password`` must be supplied by the caller;
|
||||||
|
mt5cli does not hard-code any application-specific key names.
|
||||||
|
Callers are responsible for ensuring ``data`` has bounded nesting depth;
|
||||||
|
deeply nested or self-referential structures will hit Python's recursion
|
||||||
|
limit.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
data: Arbitrarily nested dict/list/scalar value to process.
|
||||||
|
keys: Mapping keys whose string values receive placeholder
|
||||||
|
substitution.
|
||||||
|
allow_whole_dollar_env: When ``True``, a string that is exactly
|
||||||
|
``$ENV_NAME`` (whole value) is also expanded from the
|
||||||
|
environment in addition to ``${ENV_NAME}`` placeholders.
|
||||||
|
Default ``False`` expands ``${ENV_NAME}`` only.
|
||||||
|
blank_string_keys_as_none: Mapping keys for which blank strings
|
||||||
|
(after any substitution) are normalised to ``None``. A key
|
||||||
|
may appear in ``blank_string_keys_as_none`` without also
|
||||||
|
appearing in ``keys``.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
The processed value. Dicts and lists are rebuilt into new
|
||||||
|
containers with selected string values substituted and
|
||||||
|
blank-normalised. Scalar inputs (non-dict, non-list) are
|
||||||
|
returned as-is.
|
||||||
|
"""
|
||||||
|
keys_set: frozenset[str] = frozenset(keys)
|
||||||
|
blank_keys_set: frozenset[str] = frozenset(blank_string_keys_as_none)
|
||||||
|
|
||||||
|
def _visit(node: object, current_key: str | None) -> object:
|
||||||
|
if isinstance(node, dict):
|
||||||
|
typed = cast("dict[object, object]", node)
|
||||||
|
return {
|
||||||
|
k: _visit(v, k if isinstance(k, str) else None)
|
||||||
|
for k, v in typed.items()
|
||||||
|
}
|
||||||
|
if isinstance(node, list):
|
||||||
|
typed_list = cast("list[object]", node)
|
||||||
|
return [_visit(item, None) for item in typed_list]
|
||||||
|
if not isinstance(node, str):
|
||||||
|
return node
|
||||||
|
text = node
|
||||||
|
if current_key in keys_set:
|
||||||
|
text = substitute_env_placeholders(
|
||||||
|
node, allow_whole_dollar_env=allow_whole_dollar_env
|
||||||
|
)
|
||||||
|
if current_key in blank_keys_set and not text.strip():
|
||||||
|
return None
|
||||||
|
return text
|
||||||
|
|
||||||
|
return _visit(data, None)
|
||||||
|
|
||||||
|
|
||||||
def _resolve_field(
|
def _resolve_field(
|
||||||
override: str | None,
|
override: str | None,
|
||||||
account_value: str | None,
|
account_value: str | None,
|
||||||
|
|||||||
+88
-18
@@ -25,6 +25,7 @@ OrderSide = Literal["BUY", "SELL"]
|
|||||||
OrderFillingMode = Literal["IOC", "FOK", "RETURN"]
|
OrderFillingMode = Literal["IOC", "FOK", "RETURN"]
|
||||||
OrderTimeMode = Literal["GTC", "DAY", "SPECIFIED", "SPECIFIED_DAY"]
|
OrderTimeMode = Literal["GTC", "DAY", "SPECIFIED", "SPECIFIED_DAY"]
|
||||||
ExecutionStatus = Literal["executed", "dry_run", "skipped", "failed"]
|
ExecutionStatus = Literal["executed", "dry_run", "skipped", "failed"]
|
||||||
|
ProjectionMode = Literal["add", "replace_symbol"]
|
||||||
|
|
||||||
|
|
||||||
class MarginVolume(TypedDict):
|
class MarginVolume(TypedDict):
|
||||||
@@ -127,6 +128,8 @@ __all__ = [
|
|||||||
"OrderSide",
|
"OrderSide",
|
||||||
"OrderTimeMode",
|
"OrderTimeMode",
|
||||||
"PositionSide",
|
"PositionSide",
|
||||||
|
"ProjectionMode",
|
||||||
|
"calculate_account_projected_margin_ratio",
|
||||||
"calculate_margin_and_volume",
|
"calculate_margin_and_volume",
|
||||||
"calculate_new_position_margin_ratio",
|
"calculate_new_position_margin_ratio",
|
||||||
"calculate_positions_margin",
|
"calculate_positions_margin",
|
||||||
@@ -834,15 +837,60 @@ def calculate_new_position_margin_ratio(
|
|||||||
|
|
||||||
def _account_equity(client: Mt5TradingClient) -> float:
|
def _account_equity(client: Mt5TradingClient) -> float:
|
||||||
account = get_account_snapshot(client)
|
account = get_account_snapshot(client)
|
||||||
try:
|
return _required_account_number(account, "equity", allow_zero=False)
|
||||||
equity = float(account.get("equity") or 0.0)
|
|
||||||
except (TypeError, ValueError) as exc:
|
|
||||||
msg = "Account equity must be positive to calculate margin ratio."
|
def _required_account_number(
|
||||||
raise Mt5TradingError(msg) from exc
|
account: Mapping[str, object],
|
||||||
if equity <= 0 or not isfinite(equity):
|
field: str,
|
||||||
msg = "Account equity must be positive to calculate margin ratio."
|
*,
|
||||||
|
allow_zero: bool,
|
||||||
|
) -> float:
|
||||||
|
raw_value = account.get(field)
|
||||||
|
if isinstance(raw_value, bool) or not isinstance(raw_value, Real):
|
||||||
|
msg = f"Account {field} must be a finite number to calculate margin ratio."
|
||||||
raise Mt5TradingError(msg)
|
raise Mt5TradingError(msg)
|
||||||
return equity
|
value = float(raw_value)
|
||||||
|
if (
|
||||||
|
not isfinite(value)
|
||||||
|
or (not allow_zero and value <= 0)
|
||||||
|
or (allow_zero and value < 0)
|
||||||
|
):
|
||||||
|
msg = (
|
||||||
|
f"Account {field} must be a non-negative finite number."
|
||||||
|
if allow_zero
|
||||||
|
else f"Account {field} must be a positive finite number."
|
||||||
|
)
|
||||||
|
raise Mt5TradingError(msg)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
def calculate_account_projected_margin_ratio(
|
||||||
|
client: Mt5TradingClient,
|
||||||
|
*,
|
||||||
|
symbol: str | None = None,
|
||||||
|
new_position_side: OrderSide | None = None,
|
||||||
|
new_position_volume: float = 0.0,
|
||||||
|
) -> float:
|
||||||
|
"""Return account-wide current plus optional new-position margin over equity.
|
||||||
|
|
||||||
|
Current exposure comes from the broker account snapshot ``margin`` field so
|
||||||
|
unrelated open positions remain in the baseline. Optional projected
|
||||||
|
exposure is added via :func:`estimate_order_margin` only when a symbol, side,
|
||||||
|
and positive volume are all supplied.
|
||||||
|
|
||||||
|
"""
|
||||||
|
account = get_account_snapshot(client)
|
||||||
|
equity = _required_account_number(account, "equity", allow_zero=False)
|
||||||
|
margin = _required_account_number(account, "margin", allow_zero=True)
|
||||||
|
if symbol is not None and new_position_side is not None and new_position_volume > 0:
|
||||||
|
margin += estimate_order_margin(
|
||||||
|
client,
|
||||||
|
symbol,
|
||||||
|
new_position_side,
|
||||||
|
new_position_volume,
|
||||||
|
)
|
||||||
|
return margin / equity
|
||||||
|
|
||||||
|
|
||||||
def calculate_projected_margin_ratio(
|
def calculate_projected_margin_ratio(
|
||||||
@@ -874,6 +922,16 @@ def calculate_projected_margin_ratio(
|
|||||||
return margin / equity
|
return margin / equity
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_projection_mode(projection_mode: str) -> ProjectionMode:
|
||||||
|
if projection_mode not in {"add", "replace_symbol"}:
|
||||||
|
msg = (
|
||||||
|
f"Unsupported projection mode: {projection_mode!r}. "
|
||||||
|
"Expected 'add' or 'replace_symbol'."
|
||||||
|
)
|
||||||
|
raise ValueError(msg)
|
||||||
|
return cast("ProjectionMode", projection_mode)
|
||||||
|
|
||||||
|
|
||||||
def calculate_symbol_group_margin_ratio(
|
def calculate_symbol_group_margin_ratio(
|
||||||
client: Mt5TradingClient,
|
client: Mt5TradingClient,
|
||||||
*,
|
*,
|
||||||
@@ -882,13 +940,22 @@ def calculate_symbol_group_margin_ratio(
|
|||||||
new_position_side: OrderSide | None = None,
|
new_position_side: OrderSide | None = None,
|
||||||
new_position_volume: float = 0.0,
|
new_position_volume: float = 0.0,
|
||||||
suppress_errors: bool = True,
|
suppress_errors: bool = True,
|
||||||
|
projection_mode: ProjectionMode = "add",
|
||||||
) -> float:
|
) -> float:
|
||||||
"""Return estimated symbol-group margin over account equity.
|
"""Return estimated symbol-group margin over account equity.
|
||||||
|
|
||||||
Per-symbol current exposure is summed with
|
Per-symbol current exposure is summed with
|
||||||
:func:`calculate_positions_margin_by_symbol`. When ``new_symbol`` is inside
|
:func:`calculate_positions_margin_by_symbol`. When ``new_symbol`` is inside
|
||||||
the input symbol group, optional projected order margin is added for that
|
the input symbol group and candidate side/volume are provided, projected order
|
||||||
symbol. Invalid equity always raises to fail closed.
|
margin is applied according to ``projection_mode``:
|
||||||
|
|
||||||
|
- ``"add"`` (default): adds candidate margin to the group total.
|
||||||
|
- ``"replace_symbol"``: subtracts current margin for ``new_symbol``, then
|
||||||
|
adds candidate margin. Useful for reversal-style projections where the new
|
||||||
|
order is intended to replace existing exposure for that symbol.
|
||||||
|
|
||||||
|
If the candidate margin estimation fails, the subtraction is also skipped so
|
||||||
|
the operation is atomic. Invalid equity always raises to fail closed.
|
||||||
|
|
||||||
Raises:
|
Raises:
|
||||||
AttributeError: When symbol margin lookup or projected margin lookup
|
AttributeError: When symbol margin lookup or projected margin lookup
|
||||||
@@ -899,23 +966,22 @@ def calculate_symbol_group_margin_ratio(
|
|||||||
lookup or projected margin lookup fails and ``suppress_errors`` is
|
lookup or projected margin lookup fails and ``suppress_errors`` is
|
||||||
``False``.
|
``False``.
|
||||||
"""
|
"""
|
||||||
|
projection_mode = _validate_projection_mode(projection_mode)
|
||||||
equity = _account_equity(client)
|
equity = _account_equity(client)
|
||||||
unique_symbols = list(dict.fromkeys(symbols))
|
unique_symbols = list(dict.fromkeys(symbols))
|
||||||
margin = sum(
|
per_symbol = calculate_positions_margin_by_symbol(
|
||||||
calculate_positions_margin_by_symbol(
|
client,
|
||||||
client,
|
symbols=unique_symbols,
|
||||||
symbols=unique_symbols,
|
suppress_errors=suppress_errors,
|
||||||
suppress_errors=suppress_errors,
|
|
||||||
).values(),
|
|
||||||
0.0,
|
|
||||||
)
|
)
|
||||||
|
margin = sum(per_symbol.values(), 0.0)
|
||||||
if (
|
if (
|
||||||
new_symbol in unique_symbols
|
new_symbol in unique_symbols
|
||||||
and new_position_side is not None
|
and new_position_side is not None
|
||||||
and new_position_volume > 0
|
and new_position_volume > 0
|
||||||
):
|
):
|
||||||
try:
|
try:
|
||||||
margin += estimate_order_margin(
|
candidate_margin = estimate_order_margin(
|
||||||
client,
|
client,
|
||||||
new_symbol,
|
new_symbol,
|
||||||
new_position_side,
|
new_position_side,
|
||||||
@@ -925,6 +991,10 @@ def calculate_symbol_group_margin_ratio(
|
|||||||
if not suppress_errors:
|
if not suppress_errors:
|
||||||
raise
|
raise
|
||||||
_logger.warning("Skipping projected margin for %r.", new_symbol)
|
_logger.warning("Skipping projected margin for %r.", new_symbol)
|
||||||
|
else:
|
||||||
|
if projection_mode == "replace_symbol":
|
||||||
|
margin = max(0.0, margin - per_symbol.get(new_symbol, 0.0))
|
||||||
|
margin += candidate_margin
|
||||||
return margin / equity
|
return margin / equity
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "mt5cli"
|
name = "mt5cli"
|
||||||
version = "0.9.3"
|
version = "0.9.6"
|
||||||
description = "Generic MT5 data and execution infrastructure for Python applications"
|
description = "Generic MT5 data and execution infrastructure for Python applications"
|
||||||
authors = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
|
authors = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
|
||||||
maintainers = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
|
maintainers = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
|
||||||
|
|||||||
@@ -740,6 +740,306 @@ class TestCommands:
|
|||||||
assert "must be a JSON object" in normalize_cli_output(result.output)
|
assert "must be a JSON object" in normalize_cli_output(result.output)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# close-positions command
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def _build_mock_trading_client() -> MagicMock:
|
||||||
|
"""Return a MagicMock Mt5TradingClient with trading constants set."""
|
||||||
|
client = MagicMock()
|
||||||
|
client.mt5.POSITION_TYPE_BUY = 0
|
||||||
|
client.mt5.POSITION_TYPE_SELL = 1
|
||||||
|
client.mt5.ORDER_TYPE_BUY = 10
|
||||||
|
client.mt5.ORDER_TYPE_SELL = 11
|
||||||
|
client.mt5.TRADE_ACTION_DEAL = 20
|
||||||
|
client.mt5.ORDER_FILLING_IOC = 30
|
||||||
|
client.mt5.ORDER_TIME_GTC = 40
|
||||||
|
client.mt5.TRADE_RETCODE_DONE = 10009
|
||||||
|
client.mt5.TRADE_RETCODE_PLACED = 10008
|
||||||
|
client.mt5.TRADE_RETCODE_DONE_PARTIAL = 10010
|
||||||
|
return client
|
||||||
|
|
||||||
|
|
||||||
|
class TestClosePositions:
|
||||||
|
"""Tests for the close-positions command."""
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def trading_client(self, mocker: MockerFixture) -> MagicMock:
|
||||||
|
"""Patch create_trading_client and return a mock trading client."""
|
||||||
|
client = _build_mock_trading_client()
|
||||||
|
client.positions_get_as_df.return_value = pd.DataFrame([
|
||||||
|
{"ticket": 1, "symbol": "JP225", "type": 0, "volume": 1.0},
|
||||||
|
{"ticket": 2, "symbol": "EURUSD", "type": 1, "volume": 0.5},
|
||||||
|
])
|
||||||
|
client.symbol_info_tick_as_dict.return_value = {"ask": 1.2, "bid": 1.1}
|
||||||
|
mocker.patch("mt5cli.cli.create_trading_client", return_value=client)
|
||||||
|
return client
|
||||||
|
|
||||||
|
def test_dry_run_does_not_require_yes(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test --dry-run mode succeeds without --yes."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--symbol", "JP225", "--dry-run"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
assert output.exists()
|
||||||
|
trading_client.order_send.assert_not_called()
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_live_requires_yes(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test live close-positions fails without --yes."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--symbol", "JP225"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "Pass --yes" in normalize_cli_output(result.output)
|
||||||
|
trading_client.order_send.assert_not_called()
|
||||||
|
|
||||||
|
def test_live_with_yes_calls_order_send(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test --yes triggers live execution for matching positions."""
|
||||||
|
trading_client.order_send.return_value = {"retcode": 10009, "comment": "ok"}
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--symbol", "JP225", "--yes"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
trading_client.order_send.assert_called_once()
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_symbol_filter_passed_through(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test --symbol values are used to filter positions."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--symbol",
|
||||||
|
"JP225",
|
||||||
|
"--dry-run",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
data = json.loads(output.read_text())
|
||||||
|
assert len(data) == 1
|
||||||
|
assert data[0]["symbol"] == "JP225"
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_multiple_symbols_filter(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test multiple --symbol options are combined."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--symbol",
|
||||||
|
"JP225",
|
||||||
|
"--symbol",
|
||||||
|
"EURUSD",
|
||||||
|
"--dry-run",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
data = json.loads(output.read_text())
|
||||||
|
assert len(data) == 2
|
||||||
|
symbols = {row["symbol"] for row in data}
|
||||||
|
assert symbols == {"JP225", "EURUSD"}
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_ticket_filter_passed_through(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test --ticket values are used to filter positions."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--ticket",
|
||||||
|
"2",
|
||||||
|
"--dry-run",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
data = json.loads(output.read_text())
|
||||||
|
assert len(data) == 1
|
||||||
|
assert data[0]["symbol"] == "EURUSD"
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_symbol_and_ticket_combined(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test --symbol and --ticket apply AND semantics when combined."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--symbol",
|
||||||
|
"JP225",
|
||||||
|
"--ticket",
|
||||||
|
"1",
|
||||||
|
"--dry-run",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
data = json.loads(output.read_text())
|
||||||
|
# symbol=JP225 AND ticket=1 → exactly one match
|
||||||
|
assert len(data) == 1
|
||||||
|
assert data[0]["symbol"] == "JP225"
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_missing_symbol_and_ticket_fails(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
mocker: MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""Test that omitting both --symbol and --ticket fails closed."""
|
||||||
|
mocker.patch("mt5cli.cli.create_trading_client")
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--dry-run"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "symbol" in normalize_cli_output(result.output).lower()
|
||||||
|
|
||||||
|
def test_output_export_dry_run(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test dry-run results export with status=dry_run."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--symbol", "JP225", "--dry-run"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
data = json.loads(output.read_text())
|
||||||
|
assert data[0]["status"] == "dry_run"
|
||||||
|
assert data[0]["dry_run"] is True
|
||||||
|
assert data[0]["order_side"] == "SELL"
|
||||||
|
|
||||||
|
def test_order_send_unchanged(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
mock_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test that order-send behavior is unchanged by close-positions addition."""
|
||||||
|
output = tmp_path / "out.csv"
|
||||||
|
request = json.dumps({"action": 1, "symbol": "EURUSD", "volume": 0.1})
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "order-send", "--request", request, "--yes"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
mock_client.order_send_as_df.assert_called_once()
|
||||||
|
|
||||||
|
def test_shutdown_called_on_close_error(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
mocker: MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""Test that shutdown is called even when close_open_positions raises."""
|
||||||
|
client = _build_mock_trading_client()
|
||||||
|
client.positions_get_as_df.side_effect = RuntimeError("connection lost")
|
||||||
|
mocker.patch("mt5cli.cli.create_trading_client", return_value=client)
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
["-o", str(output), "close-positions", "--symbol", "JP225", "--dry-run"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_dry_run_wins_over_yes(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test that --dry-run takes precedence when combined with --yes."""
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--symbol",
|
||||||
|
"JP225",
|
||||||
|
"--dry-run",
|
||||||
|
"--yes",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
trading_client.order_send.assert_not_called()
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
|
||||||
|
def test_no_matching_positions_exports_empty_result(
|
||||||
|
self,
|
||||||
|
tmp_path: Path,
|
||||||
|
trading_client: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test that zero filter matches produces an empty JSON array."""
|
||||||
|
trading_client.positions_get_as_df.return_value = pd.DataFrame([
|
||||||
|
{"ticket": 1, "symbol": "JP225", "type": 0, "volume": 1.0},
|
||||||
|
])
|
||||||
|
output = tmp_path / "close.json"
|
||||||
|
result = runner.invoke(
|
||||||
|
app,
|
||||||
|
[
|
||||||
|
"-o",
|
||||||
|
str(output),
|
||||||
|
"close-positions",
|
||||||
|
"--symbol",
|
||||||
|
"NONEXISTENT",
|
||||||
|
"--dry-run",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0, result.output
|
||||||
|
trading_client.shutdown.assert_called_once()
|
||||||
|
assert output.exists()
|
||||||
|
assert json.loads(output.read_text()) == []
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Callback / shared options
|
# Callback / shared options
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|||||||
+32
-36
@@ -37,6 +37,7 @@ from mt5cli import (
|
|||||||
RateTarget,
|
RateTarget,
|
||||||
build_config,
|
build_config,
|
||||||
build_rate_targets,
|
build_rate_targets,
|
||||||
|
calculate_account_projected_margin_ratio,
|
||||||
calculate_margin_and_volume,
|
calculate_margin_and_volume,
|
||||||
calculate_positions_margin,
|
calculate_positions_margin,
|
||||||
calculate_projected_margin_ratio,
|
calculate_projected_margin_ratio,
|
||||||
@@ -233,16 +234,19 @@ def test_is_recoverable_mt5_error(exc: Exception) -> None:
|
|||||||
assert is_recoverable_mt5_error(exc)
|
assert is_recoverable_mt5_error(exc)
|
||||||
|
|
||||||
|
|
||||||
def test_normalize_mt5_exception_maps_types() -> None:
|
@pytest.mark.parametrize(
|
||||||
|
("exc", "expected_type"),
|
||||||
|
[
|
||||||
|
(Mt5RuntimeError("x"), Mt5ConnectionError),
|
||||||
|
(Mt5TradingError("x"), Mt5OperationError),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_normalize_mt5_exception_maps_types(
|
||||||
|
exc: Exception,
|
||||||
|
expected_type: type[Mt5ConnectionError | Mt5OperationError],
|
||||||
|
) -> None:
|
||||||
"""MT5 exceptions map to stable mt5cli types."""
|
"""MT5 exceptions map to stable mt5cli types."""
|
||||||
assert isinstance(
|
assert isinstance(normalize_mt5_exception(exc), expected_type)
|
||||||
normalize_mt5_exception(Mt5RuntimeError("x")),
|
|
||||||
Mt5ConnectionError,
|
|
||||||
)
|
|
||||||
assert isinstance(
|
|
||||||
normalize_mt5_exception(Mt5TradingError("x")),
|
|
||||||
Mt5OperationError,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_call_with_normalized_errors_reraises_mapped_type() -> None:
|
def test_call_with_normalized_errors_reraises_mapped_type() -> None:
|
||||||
@@ -419,26 +423,24 @@ def test_normalize_time_columns_skips_absent_time_fields() -> None:
|
|||||||
assert list(result.columns) == ["open"]
|
assert list(result.columns) == ["open"]
|
||||||
|
|
||||||
|
|
||||||
def test_normalize_time_columns_converts_unix_seconds() -> None:
|
@pytest.mark.parametrize(
|
||||||
"""Numeric MT5 ``time`` values are interpreted as Unix seconds."""
|
("col", "value", "kind"),
|
||||||
frame = pd.DataFrame({"time": [1704067200]})
|
[
|
||||||
result = normalize_time_columns(frame, DataKind.rates)
|
("time", 1704067200, DataKind.rates),
|
||||||
assert result.loc[0, "time"] == pd.Timestamp("2024-01-01T00:00:00+00:00")
|
("time_msc", 1704067200000, DataKind.ticks),
|
||||||
|
("time", datetime(2024, 1, 1, tzinfo=UTC), DataKind.rates),
|
||||||
|
("time", "2024-01-01T00:00:00+00:00", DataKind.rates),
|
||||||
def test_normalize_time_columns_converts_unix_milliseconds() -> None:
|
],
|
||||||
"""Numeric MT5 ``time_msc`` values are interpreted as Unix milliseconds."""
|
)
|
||||||
frame = pd.DataFrame({"time_msc": [1704067200000]})
|
def test_normalize_time_columns_coerces_value(
|
||||||
result = normalize_time_columns(frame, DataKind.ticks)
|
col: str,
|
||||||
assert result.loc[0, "time_msc"] == pd.Timestamp("2024-01-01T00:00:00+00:00")
|
value: object,
|
||||||
|
kind: DataKind,
|
||||||
|
) -> None:
|
||||||
def test_normalize_time_columns_preserves_utc_datetimes() -> None:
|
"""Time column values are coerced to UTC timestamps regardless of input type."""
|
||||||
"""Already-converted datetime values remain UTC-normalized."""
|
frame = pd.DataFrame({col: [value]})
|
||||||
aware = datetime(2024, 1, 1, tzinfo=UTC)
|
result = normalize_time_columns(frame, kind)
|
||||||
frame = pd.DataFrame({"time": [aware]})
|
assert result.loc[0, col] == pd.Timestamp("2024-01-01T00:00:00+00:00")
|
||||||
result = normalize_time_columns(frame, DataKind.rates)
|
|
||||||
assert result.loc[0, "time"] == pd.Timestamp("2024-01-01T00:00:00+00:00")
|
|
||||||
|
|
||||||
|
|
||||||
def test_normalize_time_columns_handles_optional_order_times() -> None:
|
def test_normalize_time_columns_handles_optional_order_times() -> None:
|
||||||
@@ -488,13 +490,6 @@ def test_ensure_utc_columns_skips_missing_columns() -> None:
|
|||||||
assert "time" in result.columns
|
assert "time" in result.columns
|
||||||
|
|
||||||
|
|
||||||
def test_normalize_time_columns_coerces_string_timestamps() -> None:
|
|
||||||
"""String timestamps are parsed with timezone-aware datetime coercion."""
|
|
||||||
frame = pd.DataFrame({"time": ["2024-01-01T00:00:00+00:00"]})
|
|
||||||
result = normalize_time_columns(frame, DataKind.rates)
|
|
||||||
assert result.loc[0, "time"] == pd.Timestamp("2024-01-01T00:00:00+00:00")
|
|
||||||
|
|
||||||
|
|
||||||
def test_ensure_utc_columns_coerces_non_mt5_columns() -> None:
|
def test_ensure_utc_columns_coerces_non_mt5_columns() -> None:
|
||||||
"""Non-MT5 columns still coerce to UTC datetimes."""
|
"""Non-MT5 columns still coerce to UTC datetimes."""
|
||||||
frame = pd.DataFrame({"created_at": ["2024-01-01T00:00:00+00:00"]})
|
frame = pd.DataFrame({"created_at": ["2024-01-01T00:00:00+00:00"]})
|
||||||
@@ -684,6 +679,7 @@ class TestStableSdkContract:
|
|||||||
assert price is not None
|
assert price is not None
|
||||||
assert abs(price - 1.2) < 1e-9
|
assert abs(price - 1.2) < 1e-9
|
||||||
assert callable(calculate_trailing_stop_updates)
|
assert callable(calculate_trailing_stop_updates)
|
||||||
|
assert callable(calculate_account_projected_margin_ratio)
|
||||||
assert callable(calculate_projected_margin_ratio)
|
assert callable(calculate_projected_margin_ratio)
|
||||||
assert callable(calculate_symbol_group_margin_ratio)
|
assert callable(calculate_symbol_group_margin_ratio)
|
||||||
|
|
||||||
|
|||||||
+19
-54
@@ -705,19 +705,25 @@ class TestIncrementalStart:
|
|||||||
assert starts["EURUSD", 1] == datetime(2024, 1, 2, tzinfo=UTC)
|
assert starts["EURUSD", 1] == datetime(2024, 1, 2, tzinfo=UTC)
|
||||||
assert starts["GBPUSD", 1] == datetime(2024, 1, 3, tzinfo=UTC)
|
assert starts["GBPUSD", 1] == datetime(2024, 1, 3, tzinfo=UTC)
|
||||||
|
|
||||||
def test_load_incremental_start_datetimes_requires_timeframe_column(
|
@pytest.mark.parametrize(
|
||||||
|
("ddl", "missing_col"),
|
||||||
|
[
|
||||||
|
("CREATE TABLE rates(symbol TEXT, time TEXT, open REAL)", "timeframe"),
|
||||||
|
("CREATE TABLE rates(timeframe INTEGER, time TEXT, open REAL)", "symbol"),
|
||||||
|
("CREATE TABLE rates(symbol TEXT, timeframe INTEGER, open REAL)", "time"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_load_incremental_start_datetimes_requires_column(
|
||||||
self,
|
self,
|
||||||
tmp_path: Path,
|
tmp_path: Path,
|
||||||
|
ddl: str,
|
||||||
|
missing_col: str,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Test rates tables without timeframe fail fast during incremental resume."""
|
"""Test rates tables missing a required column fail fast."""
|
||||||
fallback = datetime(2024, 1, 1, tzinfo=UTC)
|
fallback = datetime(2024, 1, 1, tzinfo=UTC)
|
||||||
with sqlite3.connect(tmp_path / "rates-without-timeframe.db") as conn:
|
with sqlite3.connect(tmp_path / f"rates-no-{missing_col}.db") as conn:
|
||||||
conn.execute("CREATE TABLE rates(symbol TEXT, time TEXT, open REAL)")
|
conn.execute(ddl)
|
||||||
conn.execute(
|
with pytest.raises(ValueError, match=f"missing: {missing_col}") as exc_info:
|
||||||
"INSERT INTO rates(symbol, time, open) VALUES (?, ?, ?)",
|
|
||||||
("EURUSD", "2024-01-02T00:00:00+00:00", 1.0),
|
|
||||||
)
|
|
||||||
with pytest.raises(ValueError, match="missing: timeframe") as exc_info:
|
|
||||||
load_incremental_start_datetimes(
|
load_incremental_start_datetimes(
|
||||||
conn,
|
conn,
|
||||||
Dataset.rates,
|
Dataset.rates,
|
||||||
@@ -725,47 +731,7 @@ class TestIncrementalStart:
|
|||||||
timeframes=[1],
|
timeframes=[1],
|
||||||
fallback_start=fallback,
|
fallback_start=fallback,
|
||||||
)
|
)
|
||||||
assert "timeframe" in str(exc_info.value)
|
assert missing_col in str(exc_info.value)
|
||||||
|
|
||||||
def test_load_incremental_start_datetimes_requires_symbol_column(
|
|
||||||
self,
|
|
||||||
tmp_path: Path,
|
|
||||||
) -> None:
|
|
||||||
"""Test rates tables without symbol fail fast during incremental resume."""
|
|
||||||
fallback = datetime(2024, 1, 1, tzinfo=UTC)
|
|
||||||
with sqlite3.connect(tmp_path / "rates-no-symbol.db") as conn:
|
|
||||||
conn.execute(
|
|
||||||
"CREATE TABLE rates(timeframe INTEGER, time TEXT, open REAL)",
|
|
||||||
)
|
|
||||||
with pytest.raises(ValueError, match="missing: symbol") as exc_info:
|
|
||||||
load_incremental_start_datetimes(
|
|
||||||
conn,
|
|
||||||
Dataset.rates,
|
|
||||||
symbols=["EURUSD"],
|
|
||||||
timeframes=[1],
|
|
||||||
fallback_start=fallback,
|
|
||||||
)
|
|
||||||
assert "symbol" in str(exc_info.value)
|
|
||||||
|
|
||||||
def test_load_incremental_start_datetimes_requires_time_column(
|
|
||||||
self,
|
|
||||||
tmp_path: Path,
|
|
||||||
) -> None:
|
|
||||||
"""Test rates tables without time fail fast during incremental resume."""
|
|
||||||
fallback = datetime(2024, 1, 1, tzinfo=UTC)
|
|
||||||
with sqlite3.connect(tmp_path / "rates-no-time.db") as conn:
|
|
||||||
conn.execute(
|
|
||||||
"CREATE TABLE rates(symbol TEXT, timeframe INTEGER, open REAL)",
|
|
||||||
)
|
|
||||||
with pytest.raises(ValueError, match="missing: time") as exc_info:
|
|
||||||
load_incremental_start_datetimes(
|
|
||||||
conn,
|
|
||||||
Dataset.rates,
|
|
||||||
symbols=["EURUSD"],
|
|
||||||
timeframes=[1],
|
|
||||||
fallback_start=fallback,
|
|
||||||
)
|
|
||||||
assert "time" in str(exc_info.value)
|
|
||||||
|
|
||||||
def test_load_incremental_start_datetimes_rejects_unrelated_rates_columns(
|
def test_load_incremental_start_datetimes_rejects_unrelated_rates_columns(
|
||||||
self,
|
self,
|
||||||
@@ -1800,12 +1766,11 @@ class TestIncrementalIntegration:
|
|||||||
)
|
)
|
||||||
assert written_tables == set()
|
assert written_tables == set()
|
||||||
|
|
||||||
def test_resolve_history_tick_flags_invalid(self) -> None:
|
@pytest.mark.parametrize("flags", ["BAD", 7])
|
||||||
|
def test_resolve_history_tick_flags_invalid(self, flags: str | int) -> None:
|
||||||
"""Test invalid tick flags raise ValueError."""
|
"""Test invalid tick flags raise ValueError."""
|
||||||
with pytest.raises(ValueError, match="Invalid tick flags"):
|
with pytest.raises(ValueError, match="Invalid tick flags"):
|
||||||
resolve_history_tick_flags("BAD")
|
resolve_history_tick_flags(flags)
|
||||||
with pytest.raises(ValueError, match="Invalid tick flags"):
|
|
||||||
resolve_history_tick_flags(7)
|
|
||||||
|
|
||||||
def test_resolve_history_timeframes_invalid(self) -> None:
|
def test_resolve_history_timeframes_invalid(self) -> None:
|
||||||
"""Test invalid timeframes raise ValueError."""
|
"""Test invalid timeframes raise ValueError."""
|
||||||
|
|||||||
+292
-43
@@ -54,6 +54,7 @@ from mt5cli.sdk import (
|
|||||||
resolve_account_spec,
|
resolve_account_spec,
|
||||||
resolve_account_specs,
|
resolve_account_specs,
|
||||||
substitute_env_placeholders,
|
substitute_env_placeholders,
|
||||||
|
substitute_mapping_values,
|
||||||
symbol_info,
|
symbol_info,
|
||||||
symbol_info_tick,
|
symbol_info_tick,
|
||||||
symbols,
|
symbols,
|
||||||
@@ -1937,29 +1938,28 @@ class TestResolveAccountSpec:
|
|||||||
assert [a.server for a in resolved] == ["Shared", "Fixed"]
|
assert [a.server for a in resolved] == ["Shared", "Fixed"]
|
||||||
assert all(a.timeout == 1000 for a in resolved)
|
assert all(a.timeout == 1000 for a in resolved)
|
||||||
|
|
||||||
def test_resolve_account_spec_with_whole_dollar_env(
|
@pytest.mark.parametrize(
|
||||||
|
("allow_whole_dollar_env", "expected"),
|
||||||
|
[
|
||||||
|
(True, "secret"),
|
||||||
|
(False, "$MT5_PASSWORD"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_resolve_account_spec_whole_dollar_password(
|
||||||
self,
|
self,
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
allow_whole_dollar_env: bool,
|
||||||
|
expected: str,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Account spec expands $ENV_NAME when allow_whole_dollar_env=True."""
|
"""Test resolve_account_spec expands $ENV_NAME password only with opt-in."""
|
||||||
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
||||||
account = AccountSpec(symbols=["EURUSD"], password="$MT5_PASSWORD")
|
account = AccountSpec(symbols=["EURUSD"], password="$MT5_PASSWORD")
|
||||||
|
|
||||||
resolved = resolve_account_spec(account, allow_whole_dollar_env=True)
|
resolved = resolve_account_spec(
|
||||||
|
account, allow_whole_dollar_env=allow_whole_dollar_env
|
||||||
|
)
|
||||||
|
|
||||||
assert resolved.password == "secret" # noqa: S105
|
assert resolved.password == expected
|
||||||
|
|
||||||
def test_resolve_account_spec_whole_dollar_not_expanded_by_default(
|
|
||||||
self,
|
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
|
||||||
) -> None:
|
|
||||||
"""Test resolve_account_spec leaves $ENV_NAME literal by default."""
|
|
||||||
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
|
||||||
account = AccountSpec(symbols=["EURUSD"], password="$MT5_PASSWORD")
|
|
||||||
|
|
||||||
resolved = resolve_account_spec(account)
|
|
||||||
|
|
||||||
assert resolved.password == "$MT5_PASSWORD" # noqa: S105
|
|
||||||
|
|
||||||
def test_resolve_account_specs_with_whole_dollar_env(
|
def test_resolve_account_specs_with_whole_dollar_env(
|
||||||
self,
|
self,
|
||||||
@@ -1993,38 +1993,27 @@ class TestResolveAccountSpec:
|
|||||||
class TestBuildConfigWholeDollarEnv:
|
class TestBuildConfigWholeDollarEnv:
|
||||||
"""Tests for build_config with allow_whole_dollar_env."""
|
"""Tests for build_config with allow_whole_dollar_env."""
|
||||||
|
|
||||||
def test_build_config_substitutes_server_with_opt_in(
|
@pytest.mark.parametrize(
|
||||||
|
("env_var", "field", "env_value"),
|
||||||
|
[
|
||||||
|
("MT5_SERVER", "server", "Broker-Demo"),
|
||||||
|
("MT5_PASSWORD", "password", "secret"),
|
||||||
|
("MT5_PATH", "path", "/opt/mt5/terminal64.exe"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_build_config_substitutes_field_with_opt_in(
|
||||||
self,
|
self,
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
env_var: str,
|
||||||
|
field: str,
|
||||||
|
env_value: str,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""build_config expands $ENV_NAME server when allow_whole_dollar_env=True."""
|
"""Test build_config expands $ENV_NAME fields when opt-in is enabled."""
|
||||||
monkeypatch.setenv("MT5_SERVER", "Broker-Demo")
|
monkeypatch.setenv(env_var, env_value)
|
||||||
|
|
||||||
config = build_config(server="$MT5_SERVER", allow_whole_dollar_env=True)
|
config = build_config(**{field: f"${env_var}"}, allow_whole_dollar_env=True) # type: ignore[arg-type]
|
||||||
|
|
||||||
assert config.server == "Broker-Demo"
|
assert getattr(config, field) == env_value
|
||||||
|
|
||||||
def test_build_config_substitutes_password_with_opt_in(
|
|
||||||
self,
|
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
|
||||||
) -> None:
|
|
||||||
"""build_config expands $ENV_NAME password when allow_whole_dollar_env=True."""
|
|
||||||
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
|
||||||
|
|
||||||
config = build_config(password="$MT5_PASSWORD", allow_whole_dollar_env=True)
|
|
||||||
|
|
||||||
assert config.password == "secret" # noqa: S105
|
|
||||||
|
|
||||||
def test_build_config_substitutes_path_with_opt_in(
|
|
||||||
self,
|
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
|
||||||
) -> None:
|
|
||||||
"""Test build_config expands $ENV_NAME path when allow_whole_dollar_env=True."""
|
|
||||||
monkeypatch.setenv("MT5_PATH", "/opt/mt5/terminal64.exe")
|
|
||||||
|
|
||||||
config = build_config(path="$MT5_PATH", allow_whole_dollar_env=True)
|
|
||||||
|
|
||||||
assert config.path == "/opt/mt5/terminal64.exe"
|
|
||||||
|
|
||||||
def test_build_config_leaves_dollar_literal_by_default(
|
def test_build_config_leaves_dollar_literal_by_default(
|
||||||
self,
|
self,
|
||||||
@@ -2436,3 +2425,263 @@ class TestThrottledHistoryUpdater:
|
|||||||
updater.update(MagicMock(), ["EURUSD"])
|
updater.update(MagicMock(), ["EURUSD"])
|
||||||
|
|
||||||
assert updater.last_update_monotonic is None
|
assert updater.last_update_monotonic is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestBuildConfigStringLogin:
|
||||||
|
"""Tests for build_config() string login coercion (issue #61)."""
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("login", "expected"),
|
||||||
|
[
|
||||||
|
(None, None),
|
||||||
|
(12345, 12345),
|
||||||
|
("12345", 12345),
|
||||||
|
(" 12345 ", 12345),
|
||||||
|
("", None),
|
||||||
|
(" ", None),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_coerces_login_from_string(
|
||||||
|
self,
|
||||||
|
login: int | str | None,
|
||||||
|
expected: int | None,
|
||||||
|
) -> None:
|
||||||
|
"""Test build_config coerces string login to int or None."""
|
||||||
|
config = build_config(login=login)
|
||||||
|
assert config.login == expected
|
||||||
|
|
||||||
|
def test_rejects_non_numeric_string_login(self) -> None:
|
||||||
|
"""Test build_config raises ValueError for non-numeric string login."""
|
||||||
|
with pytest.raises(ValueError, match="invalid literal"):
|
||||||
|
build_config(login="abc")
|
||||||
|
|
||||||
|
def test_expands_dollar_brace_login_with_opt_in(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test build_config expands ${MT5_LOGIN} and coerces with opt-in."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "12345")
|
||||||
|
config = build_config(login="${MT5_LOGIN}", allow_whole_dollar_env=True)
|
||||||
|
assert config.login == 12345
|
||||||
|
|
||||||
|
def test_expands_whole_dollar_login_with_opt_in(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test build_config expands $MT5_LOGIN and coerces with opt-in."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "99999")
|
||||||
|
config = build_config(login="$MT5_LOGIN", allow_whole_dollar_env=True)
|
||||||
|
assert config.login == 99999
|
||||||
|
|
||||||
|
def test_missing_env_variable_raises(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test build_config raises ValueError when referenced env var is not set."""
|
||||||
|
monkeypatch.delenv("MT5_LOGIN", raising=False)
|
||||||
|
with pytest.raises(ValueError, match="'MT5_LOGIN' is not set"):
|
||||||
|
build_config(login="${MT5_LOGIN}", allow_whole_dollar_env=True)
|
||||||
|
|
||||||
|
def test_env_expands_to_blank_becomes_none(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test build_config coerces blank env-expanded login to None."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "")
|
||||||
|
config = build_config(login="${MT5_LOGIN}", allow_whole_dollar_env=True)
|
||||||
|
assert config.login is None
|
||||||
|
|
||||||
|
def test_dollar_brace_login_not_expanded_without_opt_in(self) -> None:
|
||||||
|
"""Test ${MT5_LOGIN} is not expanded when allow_whole_dollar_env=False."""
|
||||||
|
with pytest.raises(ValueError, match="invalid literal"):
|
||||||
|
build_config(login="${MT5_LOGIN}")
|
||||||
|
|
||||||
|
def test_integer_login_preserved_backward_compat(self) -> None:
|
||||||
|
"""Test existing int login callers remain backward-compatible."""
|
||||||
|
config = build_config(login=54321)
|
||||||
|
assert config.login == 54321
|
||||||
|
|
||||||
|
def test_none_login_preserved_backward_compat(self) -> None:
|
||||||
|
"""Test existing None login callers remain backward-compatible."""
|
||||||
|
config = build_config(login=None)
|
||||||
|
assert config.login is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestSubstituteMappingValues:
|
||||||
|
"""Tests for substitute_mapping_values() (issue #62)."""
|
||||||
|
|
||||||
|
def test_substitutes_selected_keys_in_flat_dict(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test selected keys are substituted in a flat mapping."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "12345")
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"mt5_login": "${MT5_LOGIN}",
|
||||||
|
"strategy_name": "${MT5_LOGIN}",
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_login"})
|
||||||
|
assert result == {"mt5_login": "12345", "strategy_name": "${MT5_LOGIN}"}
|
||||||
|
|
||||||
|
def test_preserves_non_selected_literal_dollar_signs(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test literal dollar signs in non-selected fields are preserved exactly."""
|
||||||
|
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"mt5_password": "${MT5_PASSWORD}",
|
||||||
|
"notes": "$NOT_EXPANDED",
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_password"})
|
||||||
|
assert result == {"mt5_password": "secret", "notes": "$NOT_EXPANDED"}
|
||||||
|
|
||||||
|
def test_nested_dict_traversal_substitutes_selected_keys(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test selected keys inside nested dicts are substituted."""
|
||||||
|
monkeypatch.setenv("MT5_SERVER", "Broker-Demo")
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"outer": {
|
||||||
|
"mt5_server": "${MT5_SERVER}",
|
||||||
|
"other": "${MT5_SERVER}",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_server"})
|
||||||
|
assert result == {
|
||||||
|
"outer": {"mt5_server": "Broker-Demo", "other": "${MT5_SERVER}"}
|
||||||
|
}
|
||||||
|
|
||||||
|
def test_nested_list_traversal_substitutes_selected_keys(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test selected keys inside list elements are substituted."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "42")
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"accounts": [
|
||||||
|
{"mt5_login": "${MT5_LOGIN}", "name": "${MT5_LOGIN}"},
|
||||||
|
{"mt5_login": "${MT5_LOGIN}", "name": "fixed"},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_login"})
|
||||||
|
assert result == {
|
||||||
|
"accounts": [
|
||||||
|
{"mt5_login": "42", "name": "${MT5_LOGIN}"},
|
||||||
|
{"mt5_login": "42", "name": "fixed"},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
def test_whole_dollar_expanded_with_opt_in(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test $ENV_NAME is expanded when allow_whole_dollar_env=True."""
|
||||||
|
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
||||||
|
data: dict[str, object] = {"mt5_password": "$MT5_PASSWORD"}
|
||||||
|
result = substitute_mapping_values(
|
||||||
|
data,
|
||||||
|
keys={"mt5_password"},
|
||||||
|
allow_whole_dollar_env=True,
|
||||||
|
)
|
||||||
|
assert result == {"mt5_password": "secret"}
|
||||||
|
|
||||||
|
def test_whole_dollar_not_expanded_by_default(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test $ENV_NAME in a selected key is preserved when opt-in is False."""
|
||||||
|
monkeypatch.setenv("MT5_PASSWORD", "secret")
|
||||||
|
data: dict[str, object] = {"mt5_password": "$MT5_PASSWORD"}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_password"})
|
||||||
|
assert result == {"mt5_password": "$MT5_PASSWORD"}
|
||||||
|
|
||||||
|
def test_blank_string_becomes_none_for_blank_keys(self) -> None:
|
||||||
|
"""Test blank strings are normalised to None for blank_string_keys_as_none."""
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"mt5_login": "",
|
||||||
|
"mt5_password": " ",
|
||||||
|
"other": "",
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(
|
||||||
|
data,
|
||||||
|
keys=set(),
|
||||||
|
blank_string_keys_as_none={"mt5_login", "mt5_password"},
|
||||||
|
)
|
||||||
|
assert result == {"mt5_login": None, "mt5_password": None, "other": ""}
|
||||||
|
|
||||||
|
def test_env_expanded_blank_becomes_none(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test env-expanded blank string is normalised to None."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "")
|
||||||
|
data: dict[str, object] = {"mt5_login": "${MT5_LOGIN}"}
|
||||||
|
result = substitute_mapping_values(
|
||||||
|
data,
|
||||||
|
keys={"mt5_login"},
|
||||||
|
blank_string_keys_as_none={"mt5_login"},
|
||||||
|
)
|
||||||
|
assert result == {"mt5_login": None}
|
||||||
|
|
||||||
|
def test_missing_env_variable_raises_for_selected_key(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test missing env var for a selected key raises ValueError."""
|
||||||
|
monkeypatch.delenv("MT5_MISSING", raising=False)
|
||||||
|
data: dict[str, object] = {"mt5_login": "${MT5_MISSING}"}
|
||||||
|
with pytest.raises(ValueError, match="'MT5_MISSING' is not set"):
|
||||||
|
substitute_mapping_values(data, keys={"mt5_login"})
|
||||||
|
|
||||||
|
def test_non_string_values_preserved(self) -> None:
|
||||||
|
"""Test non-string values under selected or non-selected keys are preserved."""
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"mt5_login": 12345,
|
||||||
|
"timeout": 5000,
|
||||||
|
"enabled": True,
|
||||||
|
"ratio": 1.5,
|
||||||
|
"nothing": None,
|
||||||
|
}
|
||||||
|
result = substitute_mapping_values(
|
||||||
|
data, keys={"mt5_login", "timeout", "enabled", "ratio", "nothing"}
|
||||||
|
)
|
||||||
|
assert result == data
|
||||||
|
|
||||||
|
def test_caller_supplied_key_set_substitutes_correctly(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test helper works with any caller-supplied key set."""
|
||||||
|
monkeypatch.setenv("APP_LOGIN", "77777")
|
||||||
|
monkeypatch.setenv("APP_PASSWORD", "p4ss")
|
||||||
|
data: dict[str, object] = {
|
||||||
|
"app_login": "${APP_LOGIN}",
|
||||||
|
"app_password": "${APP_PASSWORD}",
|
||||||
|
"unrelated": "${APP_LOGIN}",
|
||||||
|
}
|
||||||
|
credential_keys = {"app_login", "app_password"}
|
||||||
|
result = substitute_mapping_values(data, keys=credential_keys)
|
||||||
|
assert result == {
|
||||||
|
"app_login": "77777",
|
||||||
|
"app_password": "p4ss",
|
||||||
|
"unrelated": "${APP_LOGIN}",
|
||||||
|
}
|
||||||
|
|
||||||
|
def test_scalar_data_returned_unchanged(self) -> None:
|
||||||
|
"""Test a scalar (non-dict, non-list) value is returned as-is."""
|
||||||
|
assert substitute_mapping_values("hello", keys={"x"}) == "hello"
|
||||||
|
assert substitute_mapping_values(42, keys={"x"}) == 42
|
||||||
|
assert substitute_mapping_values(None, keys={"x"}) is None
|
||||||
|
|
||||||
|
def test_tuple_container_not_traversed(
|
||||||
|
self,
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Test tuple containers are returned as-is without traversal."""
|
||||||
|
monkeypatch.setenv("MT5_LOGIN", "42")
|
||||||
|
data: dict[str, object] = {"accounts": ({"mt5_login": "${MT5_LOGIN}"},)}
|
||||||
|
result = substitute_mapping_values(data, keys={"mt5_login"})
|
||||||
|
# tuple is returned as-is; inner dict is NOT visited
|
||||||
|
assert result == {"accounts": ({"mt5_login": "${MT5_LOGIN}"},)}
|
||||||
|
|||||||
+562
-545
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user