python-shellにおけるnode.jsとpythonの連携方法について現役エンジニアが解説【初心者向け】

初心者向けにpython-shellにおけるnode.jsとpythonの連携方法について解説しています。Python-shellはNode.jsでPythonを実行する際に使用されます。Python-shellの導入方法、主な用途とそれぞれの書き方を覚えましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

python-shellにおけるnode.jsとpythonの連携方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

python-shellにおけるnode.jsとpythonの連携方法について詳しく説明していくね!

大石ゆかり

お願いします!

目次

 

Python-shellとは

Python-shellとは、簡単にNode.jsを使ってPythonスクリプトを実行するモジュールです。また、node.jsとPython間のデータ入出力は標準入出力を利用して行われます。データの受け渡しはJSON、またはテキスト形式で行われます。使用したいフォーマットを指定することで使用すできます。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

python-shellの使い方

Install方法

1.  node.jsをインストールする

Node.jsをインストールしていない人はこちらからインストールしてみてください。

Node.jsについてわからない人はこちらをご覧ください。

2. 使用するディレクトリをnpm initを用いて初期化する

インストールがわからない方はこちらをご覧ください
3. python-shellのパッケージをnpm install python-shellを用いてインストールする

これで設定は完了です。

新しいディレクトリを作ってpython-shellを使用する際には、上記の手順を踏む必要があります。

 

主な使用方法

JavaScriptファイル上でPythonのコードを使用する場合

runString(code, options, callback)

Pythonコードを実行し、その結果を含むコールバックを呼び出します。コールバックには、Pythonスクリプトから発せられるメッセージの配列だけでなく、(もしあれば)実行エラーも含まれています。

Pythonファイルをパスを指定して実行する場合

run(script, options, callback)

Pythonスクリプトを実行し、その結果を含むコールバックを呼び出します。コールバックには、(もしあれば)実行エラーとPythonスクリプトから出力されるメッセージの配列が含まれています。

Pythonファイルとデータをやりとりする場合

send(message)

標準入力経由でPythonスクリプトにメッセージを送信します。データは、選択されたモード (テキストまたは JSON) に応じて形式が整えられ、形式が指定されている場合はカスタム関数を介してフォーマットされます。

 

python-shellを利用してpythonコードを実行してみよう

JavaScriptファイル上でPythonのコードを使用する場合

コード

const { PythonShell } = require('python-shell');

PythonShell.runString('print("Hello World!");print("Hello There")', null, function(err, data) {
if (err) throw err;
console.log(data);
});

結果

[ 'Hello World!', 'Hello There' ]

解説

出力されたものが配列(JavaScriptではArray)形式になっています。そのため、テキストを取り出す場合にはdata.toString()としてあげることで取り出すことができます。または、インデックスを指定して取り出すことも可能です。JavaScriptではPythonのprintにあたるものがConsole.logとなります。

Pythonファイルをパスを指定して実行する場合

コード

main.js

const { PythonShell } = require('python-shell');

PythonShell.run('script.py', null, function(err, data) {
if (err) throw err;
console.log(data);
});

script.py

print("Hello World!")
print("Hello There!")

結果

[ 'Hello World!', 'Hello There!' ]

解説

先ほど同様、出力されたものが配列(JavaScriptではArray)形式になっています。出力が複数ある場合には指定してあげることで必要なものを取り出すことが可能です。

Pythonファイルとデータをやりとりする場合

コード

main.js

const { PythonShell } = require('python-shell');

let pythonshell = new PythonShell('arg.py');

pythonshell.send('hello world');
pythonshell.send('hello there');

pythonshell.on("message", function(message) {
console.log(message);
});

 

arg.py

from sys import stdin

txts = stdin.readlines()
print(txts)

結果

['hello world\n', 'hello there\n']

解説

標準入力を読み込むために、Pythonの標準ライブラリに含まれるsys.stdinを用いて受け渡された文章を出力し、先ほどと同様に配列としてJavaScriptのファイルに受け渡されます。ここで注意が必要なのは、ここではreadlinesを用いて読み込んでいますので、改行が含まれます。

 

まとめ

いかがだったでしょうか? Node.jsで動かせるPythonということで、今後Pythonの使用できる範囲が広がっていくといいですね。

 

監修してくれたメンター

メンターkatoさん

学生時代に数値解析のためにプログラミングを始める。現在は企業にて専門職として働くかたわら、プログラムを書き業務効率化を図っている。

現在のメイン言語はPython, JavaScript。また、企業内の希望者にPythonのメンターとして基礎から教えている。テックアカデミーではJavaScriptを教える。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。