Implement setting the AutoHotkey executable path

Author: Perlence

ahkpy/launcher.py

@@ -17,12 +17,7 @@ def main():
     os.environ["PYTHONFULLPATH"] = ";".join(sys.path)
     os.environ["PYTHONDLL"] = python_dll_path()
 
-    ahk_exe_path = AHK
-    ahk_assoc = get_ahk_by_assoc()
-    if ahk_assoc and Path(ahk_assoc).name.lower().startswith("autohotkey"):
-        ahk_exe_path = ahk_assoc
-    ahk_exe_path = fix_ahk_platform(ahk_exe_path)
-
+    ahk_exe_path = fix_ahk_platform(get_ahk_exe_path())
     python_ahk_path = Path(__file__).parent / "Python.ahk"
     args = [str(ahk_exe_path), str(python_ahk_path)] + sys.argv[1:]
 
@@ -57,6 +52,18 @@ def python_dll_path():
     return dllpath[:dllpath_len]
 
 
+def get_ahk_exe_path():
+    env_path = os.getenv("AUTOHOTKEY")
+    if env_path:
+        return env_path
+
+    ahk_assoc = get_ahk_by_assoc()
+    if ahk_assoc and Path(ahk_assoc).name.lower().startswith("autohotkey"):
+        return ahk_assoc
+
+    return AHK
+
+
 def get_ahk_by_assoc():
     S_OK = 0
     S_FALSE = 1

docs/quickstart.rst

@@ -46,6 +46,16 @@ The following CLI options are specific to AutoHotkey.py:
 
    Don't show the AutoHotkey icon in the system tray.
 
+When started, AutoHotkey.py searches for the AutoHotkey executable in the
+following sequence:
+
+1. Check the ``AUTOHOTKEY`` environment variable. If the variable is set,
+   treat it as the AutoHotkey executable path.
+2. Find the program associated with the ``*.ahk`` files. If the program name
+   starts with ``autohotkey`` (case-insensitive), treat it as the AutoHotkey
+   executable path.
+3. Use the default ``C:\Program Files\AutoHotkey\AutoHotkey.exe`` path.
+
 .. note::
 
    In contrast with AutoHotkey, the whole script is executed once it's loaded.

tests/test_cli.py

@@ -196,6 +196,27 @@ def test_pyw(tmpdir):
     assert res.returncode == 0
 
 
+def test_ahk_path_envvar(tmpdir):
+    spy = tmpdir / "spy.bat"
+    code = "@echo %0 %*"
+    spy.write(code)
+
+    script = tmpdir / "script.py"
+    code = "print('hello')"
+    script.write(code)
+
+    import os
+    res = subprocess.run(
+        ["py.exe", "-m", "ahkpy", str(script)],
+        env={**os.environ, "AUTOHOTKEY": str(spy)},
+        encoding="utf-8",
+        capture_output=True,
+    )
+    assert res.stderr == ""
+    assert res.stdout.lower() == f"{spy} {ahk.__path__[0]}\\Python.ahk {script}\n".lower()
+    assert res.returncode == 0
+
+
 def test_import_ahk(tmpdir):
     script = tmpdir / "script.py"
     code = "import ahkpy; print('ok')"