@kenmaroです。
普段は主に秘密計算、準同型暗号などの記事について投稿しています。
秘密計算に関連するまとめの記事に関しては以下をご覧ください。

秘密計算エンジニアを始めて１年が経った。

はじめに

このチュートリアルは２本立てです。

前回の記事はこちらから

概要

python で書かれたスクリプト、ライブラリなどをバイナリ化し、ソースコードが見えないようにした状態で配布することはよくあると思います。
そんなときにpyinstallerを使うと便利であり、いろいろな解説記事なども転がっているため比較的取り組みやすいと思います。

しかしながら、解説記事などではあくまでも簡単なhello_world的なプログラムをバイナリ化するような記事が多く、

と言うような実運用上必ず通るようなケースでどのようにpyinstallerを用いればよいか、
まとまっているものがあまり無いように感じたため、今回は運用の仕方についてまとめてみます。

pyinstaller を用いてpython プログラムをバイナリ化して配布する際、

がわかります。

前回の記事で使ったmyprojectというライブラリをpyinstallerでバイナリ配布するシナリオを引き続き考えていきます。
階層構造は以下のようでした。

main.py
myproject/
  core.py
  server/
    controller/
      controller.py
    service/
      service.py

ここで、例えば、service.py の中において、

service.py

import numpy as np

と言うような記述があったとします。
pipモジュールを何も使わずにサービスを作ることは考えにくいので、このような記述はいろいろなところにあると想定されます。

このとき、pyinstallerの実行のときに、このバイナリがnumpyに依存している、ということを明示することで、
pyinstaller はその依存関係をきちんとリンクした状態でバイナリを生成してくれます。

以下ではその依存関係の記述の仕方をまとめます。

以前の記事でもhookについて言及しましたが、pipモジュールについても、hookにどのモジュールを使っているか記述することになります。
以前のhookは以下のようでした。

pyinstaller/hooks/hook-myproject.py

hiddenimports = [
"myproject.core",
"myproject.server.controller.controller",
"myproject.server.service.service",
]

これに対して、numpyが依存関係として存在しているのであれば、

pyinstaller/hooks/hook-myproject.py

hiddenimports = [
"numpy",
"myproject.core",
"myproject.server.controller.controller",
"myproject.server.service.service",
]

とするだけです。

このとき、numpyのようにそのまま書きましたが、
実際はpython がpip install したあとの　site-packages の中で、ライブラリがどの名前で参照されているかを
きちんと確認する必要があります。

この参照の仕方ですが、以前記事にしていたのでぜひご覧ください。

結論だけ言うと、使っているpython環境のsite-packagesの場所は、

python -c "import site; print (site.getsitepackages())"

でパスを参照することができます。
このパスにcdしたあと、ls -l
を行い、どのモジュールをpyinstallerが参照するべきか書く必要があります。

もしpyinstaller がこのモジュールの名前を参照できない場合、

pyinstaller を走らせたときに、

WARNING: Hidden import "numpy" not found!

と言うようなワーニングが吐き出されますので、きちんとログを確認する必要があります。
ワーニングですので、そのままバイナリ自体は吐き出され、
バイナリを実行しようとすると、ランタイムにおいて、

no module found numpy

のようなエラーとなるのでご注意ください。

今回は、前回の記事に引き続き、
Pyinstallerを実際に運用するときにあったら便利だと思われる項目を

というテーマで書いてみました。

前回の

のやり方と合わせると、かなり汎用的にPyinstallerを使いバイナリ化が行えるようになります。

もし、Python のプログラムをそのまま配布するわけにはいかず、バイナリ化などの工夫が必要だ、
でもPyinstaller どうやって使えばいいんだろう、

となった際は是非参考にしてみてください。

今回はこの辺で。