mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 17:30:50 +00:00
Miguel Ángel
3388635f1d
The audio engine shells out to `python3` for ElevenLabs TTS
(tts.mjs) and the local Lyria/MusicGen BGM paths (bgm.mjs). `python3`
is correct on macOS/Linux, but a standard python.org install on
Windows only creates `python.exe` plus the `py` launcher -- there is
no `python3.exe` (only the Microsoft Store build adds one). So every
`spawn("python3", ...)`/`spawnSync("python3", ...)` ENOENTs on a normal
Windows Python setup, silently disabling all Python-backed audio
features until the user hand-creates a `python3.exe` shim (reported: a
user copied python.exe to python3.exe to work around it, and separately
another had to target a python3 stub specifically).
Fix: a shared lib/python.mjs resolver probes the platform's candidates
in order and returns the argv prefix that actually launches Python 3 --
`["python3"]` / `["python"]` / `["py", "-3"]` on win32, `["python3"]`
then `["python"]` elsewhere -- resolved once per process. All direct
`python3` spawn sites in tts.mjs (elevenlabs probe + synth) and bgm.mjs
(pyOk probe, Lyria recipe, MusicGen script) now route through it. On
macOS/Linux `python3` still wins first, so behavior there is unchanged;
if nothing probes OK the resolver falls back to `python3` so the spawn
fails loudly exactly as before, never worse.
Scope: only the direct python3 invocations. bgm.mjs's pipInstall()
still shells `pip` -- switching that to `<python> -m pip` is the
separate concern of the open PR #1894 (draft); noting the overlap so
the two don't collide. Windows-specific whisper.cpp-vs-openai-whisper
detection and the npm_execpath/npx spawn issue from the same report are
distinct root causes, not addressed here.
Test: python.test.mjs (node:test) covers every platform/probe branch
with an injected probe -- no real interpreter spawned: non-win32 picks
python3; win32 prefers python3, falls back to python, then to `py -3`;
the py launcher is probed as `py -3 --version`; nothing-runs falls back
to the canonical python3; and pythonInvocation keeps the launcher's -3
ahead of caller args. Existing tts.spawn.test.mjs still passes (6/6).
64 lines
2.5 KiB
JavaScript
64 lines
2.5 KiB
JavaScript
// python.mjs — resolve which Python 3 executable to spawn, per platform.
|
|
//
|
|
// The audio engine (tts.mjs, bgm.mjs) shells out to `python3` for ElevenLabs
|
|
// TTS and the local Lyria/MusicGen BGM paths. `python3` is the right name on
|
|
// macOS/Linux, but on Windows the python.org installer only creates
|
|
// `python.exe` plus the `py` launcher — there is no `python3.exe` (only the
|
|
// Microsoft Store build adds one). So a bare `spawn("python3", …)` ENOENTs on a
|
|
// standard Windows Python install, silently disabling every Python-backed audio
|
|
// feature until the user hand-creates a `python3.exe` shim (reported twice).
|
|
//
|
|
// Resolve once, per process: probe the platform's candidates in order and take
|
|
// the first that actually runs. `py` is the launcher, so it needs a `-3` arg to
|
|
// select Python 3 — hence candidates are argv PREFIXES, not bare names.
|
|
|
|
import { spawnSync } from "node:child_process";
|
|
|
|
function defaultProbe(cmd, args) {
|
|
try {
|
|
return spawnSync(cmd, args, { stdio: "ignore" }).status === 0;
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Pick the argv prefix that launches Python 3 on this platform.
|
|
* Returns e.g. `["python3"]`, `["python"]`, or `["py", "-3"]`.
|
|
*
|
|
* Pure except for `probe` (which runs `<cmd> … --version`); both `platform`
|
|
* and `probe` are injectable so every branch is unit-testable without spawning.
|
|
* If nothing probes OK, falls back to the canonical name for the platform so
|
|
* the eventual spawn fails loudly exactly as it did before — never worse.
|
|
*/
|
|
export function resolvePythonCommand(platform = process.platform, probe = defaultProbe) {
|
|
const candidates =
|
|
platform === "win32" ? [["python3"], ["python"], ["py", "-3"]] : [["python3"], ["python"]];
|
|
for (const prefix of candidates) {
|
|
if (probe(prefix[0], [...prefix.slice(1), "--version"])) return prefix;
|
|
}
|
|
return candidates[0];
|
|
}
|
|
|
|
let cached = null;
|
|
|
|
/** Cached `resolvePythonCommand()` — probing spawns, so resolve at most once. */
|
|
export function pythonCommand() {
|
|
if (!cached) cached = resolvePythonCommand();
|
|
return cached;
|
|
}
|
|
|
|
/**
|
|
* Build a `{ cmd, args }` for running Python 3 with `extraArgs`, using the
|
|
* resolved (or supplied) prefix. Keeps the launcher's `-3` (and any future
|
|
* prefix args) ahead of the caller's own arguments.
|
|
*/
|
|
export function pythonInvocation(extraArgs, prefix = pythonCommand()) {
|
|
return { cmd: prefix[0], args: [...prefix.slice(1), ...extraArgs] };
|
|
}
|
|
|
|
/** Test-only: clear the cached resolution so a test can re-probe. */
|
|
export function _resetPythonCommandCacheForTests() {
|
|
cached = null;
|
|
}
|