Files
mql5-skills/skills/mql5/scripts/mql5_helper.py
T
ZhijuCen 63a8d67fb0 fix: prioritize MetaEditor64.exe in MT5 discovery, exact case-sensitive match
- _find_mt5_in_program_files: score dirs by executable presence,
  MetaEditor64.exe=2 > metaeditor64.exe=1 > terminal*=0
- _find_editor: drop rglob, check exact filenames only (case-sensitive)
2026-06-24 17:31:09 +08:00

331 lines
10 KiB
Python

#!/usr/bin/env python3
"""
MQL5 development helper: compile, check, deploy, and list EA/Indicator files.
CLI-automatable tasks only. Backtesting and optimization are GUI-only
(Strategy Tester).
Usage:
python skills/mql5/scripts/mql5_helper.py compile FILE.mq5
python skills/mql5/scripts/mql5_helper.py check FILE.mq5
python skills/mql5/scripts/mql5_helper.py deploy FILE.mq5
python skills/mql5/scripts/mql5_helper.py status
python skills/mql5/scripts/mql5_helper.py list
"""
import argparse
import os
import shutil
import subprocess
import sys
from pathlib import Path
# MT5 paths — resolved in order:
# 1. MQL5_DIR env var (explicit override)
# 2. Walk up from cwd — a dir containing Experts/ + Indicators/ is MQL5
# 3. Scan Program Files subdirs for MetaEditor/terminal executables
# 4. Hardcoded Wine fallback
# MT5_BASE override via env var; MQL5_DIR detected from cwd implies MT5_BASE = parent.
# Preferred in order — MetaEditor first (needed for compile), case-sensitive
_MT5_MARKERS = (
("MetaEditor64.exe", 2),
("metaeditor64.exe", 1),
("terminal64.exe", 0),
("terminal.exe", 0),
)
_MQL5_MARKERS = ("Experts", "Indicators", "Scripts")
def _find_mt5_in_program_files() -> Path | None:
"""Scan Program Files directories for a MetaTrader 5 installation.
Prefers directories containing MetaEditor64.exe (needed for compile)."""
found: list[tuple[int, Path]] = []
for pf in ("Program Files", "Program Files (x86)"):
for root in (Path("/"), Path.home()):
pf_dir = root / pf
if not pf_dir.is_dir():
continue
for d in pf_dir.iterdir():
if not d.is_dir():
continue
score = -1
for exe, s in _MT5_MARKERS:
if (d / exe).exists():
score = max(score, s)
if score >= 0:
found.append((score, d))
if not found:
return None
found.sort(key=lambda t: t[0], reverse=True)
return found[0][1]
def _detect_mql5_from_cwd() -> Path | None:
"""Walk up from cwd; return the first dir whose direct children include
at least two of the MQL5 marker subdirectories."""
d = Path.cwd()
while True:
hits = sum(1 for m in _MQL5_MARKERS if (d / m).is_dir())
if hits >= 2:
return d
parent = d.parent
if parent == d: # reached filesystem root
return None
d = parent
# --- Resolve MT5_BASE ---
if "MT5_BASE" in os.environ:
MT5_BASE = Path(os.environ["MT5_BASE"])
else:
_found = _find_mt5_in_program_files()
if _found:
MT5_BASE = _found
else:
MT5_BASE = Path.home() / ".wine/drive_c/Program Files/MetaTrader 5"
# --- Resolve MQL5_DIR ---
if "MQL5_DIR" in os.environ:
MQL5_DIR = Path(os.environ["MQL5_DIR"])
else:
_detected = _detect_mql5_from_cwd()
if _detected:
MQL5_DIR = _detected
if "MT5_BASE" not in os.environ:
MT5_BASE = MQL5_DIR.parent
else:
MQL5_DIR = MT5_BASE / "MQL5"
# Type → directory mapping
TYPE_DIRS = {
"expert": "Experts",
"indicator": "Indicators",
"script": "Scripts",
"service": "Services",
"include": "Include",
}
def detect_type(file_path: Path) -> str:
"""Detect program type from file path segments (path-only, no content read)."""
for p in file_path.parts:
pl = p.lower()
if pl in ("experts", "advisor", "advisors"):
return "expert"
if pl in ("indicators",):
return "indicator"
if pl in ("scripts",):
return "script"
if pl in ("services",):
return "service"
if pl in ("include",):
return "include"
return "expert" # default
def _find_editor() -> Path | None:
"""Locate MetaEditor64.exe in MT5_BASE (case-sensitive exact match)."""
for name in ("MetaEditor64.exe", "MetaEditor.exe"):
p = MT5_BASE / name
if p.exists():
return p
return None
def cmd_compile(args):
"""Compile an MQ5 file using MetaEditor via Wine.
Deploys the file to the MQL5 directory first, then compiles.
Generates a .log file alongside the source.
"""
src = Path(args.file).resolve()
if not src.exists():
print(f"Error: {src} not found")
return 1
editor = _find_editor()
if not editor:
print("Error: MetaEditor.exe not found in MT5 installation")
print(f"Searched: {MT5_BASE}")
return 1
# Deploy to MQL5 tree
program_type = detect_type(src)
dest_dir = MQL5_DIR / TYPE_DIRS.get(program_type, "Experts")
dest = dest_dir / src.name
dest_dir.mkdir(parents=True, exist_ok=True)
shutil.copy2(src, dest)
print(f"Deployed: {src.name}{dest}")
# Compile: /compile:"path" /log (absolute path, cwd doesn't matter)
try:
result = subprocess.run(
["wine", str(editor), f'/compile:"{dest}"', "/log"],
capture_output=True, text=True, timeout=60,
cwd=str(dest.parent),
)
print(f"Compile output:\n{result.stdout}")
if result.stderr:
print(f"Stderr:\n{result.stderr}")
# Check for .log file
log_path = dest.with_suffix(".log")
if log_path.exists():
log_text = log_path.read_text(errors="replace")
# Print last 30 lines of log for quick review
lines = log_text.strip().splitlines()
if lines:
print(f"\nCompilation log ({len(lines)} lines):")
for line in lines[-30:]:
print(f" {line}")
return result.returncode
except FileNotFoundError:
print("Error: wine not found. Install wine first.")
return 1
except subprocess.TimeoutExpired:
print("Compile timed out (60s). Check MetaEditor for errors.")
return 1
def cmd_check(args):
"""Syntax-check an MQ5 file without full compilation (/s flag).
Deploys the file to the MQL5 directory first, then runs syntax check.
Generates a .log file alongside the source.
"""
src = Path(args.file).resolve()
if not src.exists():
print(f"Error: {src} not found")
return 1
editor = _find_editor()
if not editor:
print("Error: MetaEditor.exe not found in MT5 installation")
print(f"Searched: {MT5_BASE}")
return 1
# Deploy to MQL5 tree
program_type = detect_type(src)
dest_dir = MQL5_DIR / TYPE_DIRS.get(program_type, "Experts")
dest = dest_dir / src.name
dest_dir.mkdir(parents=True, exist_ok=True)
shutil.copy2(src, dest)
print(f"Deployed: {src.name}{dest}")
# Syntax check: /compile:"path" /log /s (absolute path)
try:
result = subprocess.run(
["wine", str(editor), f'/compile:"{dest}"', "/log", "/s"],
capture_output=True, text=True, timeout=60,
cwd=str(dest.parent),
)
print(f"Syntax check output:\n{result.stdout}")
if result.stderr:
print(f"Stderr:\n{result.stderr}")
# Check for .log file
log_path = dest.with_suffix(".log")
if log_path.exists():
log_text = log_path.read_text(errors="replace")
lines = log_text.strip().splitlines()
if lines:
print(f"\nSyntax check log ({len(lines)} lines):")
for line in lines[-30:]:
print(f" {line}")
return result.returncode
except FileNotFoundError:
print("Error: wine not found. Install wine first.")
return 1
except subprocess.TimeoutExpired:
print("Syntax check timed out (60s).")
return 1
def cmd_deploy(args):
"""Deploy an MQ5 file to the correct MQL5 directory."""
src = Path(args.file).resolve()
if not src.exists():
print(f"Error: {src} not found")
return 1
program_type = detect_type(src)
dest_dir = MQL5_DIR / TYPE_DIRS.get(program_type, "Experts")
dest = dest_dir / src.name
dest_dir.mkdir(parents=True, exist_ok=True)
shutil.copy2(src, dest)
print(f"Deployed: {src.name}{dest}")
print(f"Type: {program_type}")
print("Compile in MetaEditor or via: mql5_helper.py compile FILE.mq5")
return 0
def cmd_status(args):
"""Show MT5 installation status."""
print(f"MT5 Base: {MT5_BASE}")
print(f"MQL5 Dir: {MQL5_DIR}")
print(f"Exists: {MQL5_DIR.exists()}")
if MQL5_DIR.exists():
for subdir in ["Experts", "Indicators", "Scripts", "Services", "Include"]:
d = MQL5_DIR / subdir
if d.exists():
mq5 = list(d.rglob("*.mq5"))
ex5 = list(d.rglob("*.ex5"))
print(f" {subdir:12s}: {len(mq5)} .mq5, {len(ex5)} .ex5")
print(f"\nTerminal: {MT5_BASE / 'terminal64.exe'}")
print(f" Exists: {(MT5_BASE / 'terminal64.exe').exists()}")
return 0
def cmd_list(args):
"""List all MQ5 source files in MQL5 directory."""
if not MQL5_DIR.exists():
print("MQL5 directory not found")
return 1
for subdir in ["Experts", "Indicators", "Scripts", "Services"]:
d = MQL5_DIR / subdir
if not d.exists():
continue
files = sorted(d.rglob("*.mq5"))
if files:
print(f"\n{subdir}/")
for f in files:
rel = f.relative_to(d)
print(f" {rel}")
return 0
def main():
parser = argparse.ArgumentParser(
description="MQL5 development helper (compile, check, deploy)")
sub = parser.add_subparsers(dest="command", required=True)
sub.add_parser("status", help="Show MT5 installation status")
sub.add_parser("list", help="List all MQ5 source files")
compile_p = sub.add_parser("compile", help="Compile an MQ5 file")
compile_p.add_argument("file", help="Path to .mq5 file")
check_p = sub.add_parser("check", help="Syntax-check an MQ5 file (no .ex5 output)")
check_p.add_argument("file", help="Path to .mq5 file")
deploy_p = sub.add_parser("deploy", help="Deploy MQ5 to MQL5 directory")
deploy_p.add_argument("file", help="Path to .mq5 file")
args = parser.parse_args()
commands = {
"status": cmd_status,
"list": cmd_list,
"compile": cmd_compile,
"check": cmd_check,
"deploy": cmd_deploy,
}
return commands[args.command](args)
if __name__ == "__main__":
sys.exit(main())