[JS/TS] Python-Shell库实战：Node.js中高效执行Python脚本与数据交换详解

在现代多语言开发环境中，集成Node.js与Python能充分发挥各自的语言优势。Python-Shell库作为连接两者的桥梁，允许开发者在Node.js环境中轻松执行Python代码，并实现高效的双向数据交互。

Python-Shell 库概述

Python-Shell 是一个轻量级的 Node.js 库，它通过创建子进程来启动 Python 解释器，并利用标准输入输出流（stdin/stdout）进行数据传输，从而实现在 Node.js 中运行 Python 脚本。

Python-Shell 库的功能特点

• 可靠启动 Python 脚本：基于 Node.js 的 child_process 模块，稳定创建并执行 Python 子进程。
• 多数据模式支持：提供文本（text）、JSON 和二进制（binary）模式，适应不同数据交换场景。
• 自定义解析与格式化：支持扩展自定义解析器和格式化器，提升灵活性。
• 高效数据传递：通过标准流实现快速数据传输。
• 完善错误处理：捕获 Python 脚本错误，提供详细错误信息和堆栈跟踪。

安装 Python-Shell 库

使用 npm 包管理器进行安装：

npm install python-shell

使用 Python-Shell 库执行 Python 代码

1. 运行 Python 字符串

import {PythonShell} from 'python-shell';

PythonShell.runString('x=1+1;print(x)', null).then(messages => {
  console.log('finished');
});

此示例使用 runString 方法直接执行 Python 代码字符串，成功后回调函数输出消息。

2. 运行 Python 脚本

import {PythonShell} from 'python-shell';

PythonShell.run('my_script.py', null).then(messages => {
  console.log('finished');
});

通过 run 方法执行指定路径的 Python 脚本，参数 null 表示使用默认选项。

3. 使用参数和选项运行 Python 脚本

import {PythonShell} from 'python-shell';

let options = {
  mode: 'text',
  pythonPath: 'path/to/python',
  scriptPath: 'path/to/my/scripts',
  args: ['value1', 'value2', 'value3']
};

PythonShell.run('my_script.py', options).then(messages => {
  console.log('results: %j', messages);
});

options 对象允许配置数据模式、Python解释器路径、脚本路径及传递参数。

与 Python 代码交换数据

import {PythonShell} from 'python-shell';

let pyshell = new PythonShell('my_script.py');

// 发送消息到 Python 脚本
pyshell.send('hello');

pyshell.on('message', function(message) {
  // 接收 Python 脚本发送的消息
  console.log(message);
});

// 关闭输入流，允许进程退出
pyshell.end(function(err, code, signal) {
  if (err) throw err;
  console.log('The exit code was: ' + code);
  console.log('The exit signal was: ' + signal);
  console.log('finished');
});

此示例演示了使用 send 方法向 Python 脚本发送消息，并通过 on 监听返回消息，end 方法用于正常关闭进程。

总结

Python-Shell 库为开发者提供了简单而强大的工具，使得在 Node.js 环境中运行 Python 代码变得便捷高效。支持多种数据模式、自定义处理及错误机制，能满足各种跨语言开发需求。

项目地址：https://github.com/extrabacon/python-shell