如何创建通用JavaScript函数以运行Python脚本并返回JSON格式数据

实现思路说明 #

• 你想要让pythonFileRunner完全隐藏异步逻辑、直接同步返回结果的需求，使用异步spawn是无法实现的：Node.js的异步IO操作不会阻塞主线程，同步函数无法等待异步子进程执行完成再返回结果。
• 有两种可行实现方向：
  1. 使用同步子进程APIspawnSync，直接同步返回结果，完全符合你要求的调用方式，适合Python脚本执行时间短的场景
  2. 继续使用异步spawn，函数返回Promise，调用方仅需加await即可使用，适合Python脚本执行时间长、不想阻塞Node主线程的场景
• 注意：arguments是JavaScript内置保留字，不要用作参数命名，改为args即可。

方案1：同步实现（直接返回结果，完全符合你的调用要求） #

const { spawnSync } = require("child_process");
const path = require("path");

/**
 * 同步运行指定Python文件，直接返回输出结果
 * @param {string} pathToFile Python文件的相对路径
 * @param {any|any[]} args 要传给Python文件的参数，单个值或数组均可
 * @param {boolean} parseJson 是否自动解析JSON格式的输出，默认false
 * @returns {string|object} Python脚本的stdout输出
 */
exports.pythonFileRunner = (pathToFile, args = [], parseJson = false) => {
  // 处理参数格式，单个参数也转成数组
  const runArgs = Array.isArray(args) ? args : [args.toString()];
  // 拼接完整的Python文件路径，避免相对路径错误
  const fullPath = path.resolve(__dirname, pathToFile);

  // 同步运行Python脚本
  const result = spawnSync("python", [fullPath, ...runArgs], {
    encoding: "utf-8"
  });

  // 错误处理
  if (result.status !== 0) {
    console.error(`Python脚本运行错误，错误码：${result.status}`);
    console.error(`stderr输出：${result.stderr}`);
    throw new Error(`Python脚本执行失败: ${result.stderr || result.error}`);
  }

  // 处理返回结果
  const output = result.stdout.trim();
  return parseJson ? JSON.parse(output.replace(/'/g, '"')) : output;
}

调用示例 #

const { pythonFileRunner } = require('../python/weather')

exports.fetchWeatherdata = (location) => {
  // 第三个参数传true自动解析JSON输出，不需要写任何async/await逻辑
  return pythonFileRunner("path/to/file/main.py", location, true)
}

方案2：异步实现（非阻塞，适合长耗时脚本） #

如果你不想阻塞Node主线程，可选择异步实现，所有异步逻辑仍封装在函数内部，调用方仅需加await即可：

const { spawn } = require("child_process");
const path = require("path");

/**
 * 异步运行指定Python文件，返回Promise，调用方用await获取结果
 * @param {string} pathToFile Python文件的相对路径
 * @param {any|any[]} args 要传给Python文件的参数，单个值或数组均可
 * @param {boolean} parseJson 是否自动解析JSON格式的输出，默认false
 * @returns {Promise<string|object>} Python脚本的stdout输出
 */
exports.pythonFileRunner = (pathToFile, args = [], parseJson = false) => {
  const runArgs = Array.isArray(args) ? args : [args.toString()];
  const fullPath = path.resolve(__dirname, pathToFile);

  return new Promise((resolve, reject) => {
    let buf = "";
    const python = spawn("python", [fullPath, ...runArgs]);

    python.stdout.on("data", (data) => {
      buf += data;
    });

    python.stderr.on("data", (data) => {
      console.error(`Python stderr: ${data}`);
    });

    python.on("close", (code) => {
      if (code !== 0) {
        return reject(`Python脚本执行失败，错误码：${code}`);
      }
      const output = buf.toString().trim();
      try {
        const result = parseJson ? JSON.parse(output.replace(/'/g, '"')) : output;
        resolve(result);
      } catch (err) {
        reject(`结果解析失败: ${err.message}`);
      }
    });

    python.on("error", (err) => {
      reject(`子进程启动失败: ${err.message}`);
    })
  });
}

调用示例 #

const { pythonFileRunner } = require('../python/weather')

exports.fetchWeatherdata = async (location) => {
  // 仅需加await即可获取结果，不需要处理其他异步逻辑
  return await pythonFileRunner("path/to/file/main.py", location, true)
}

内容的提问来源于stack exchange，提问作者Curious Learner