Python パッケージの生成と Python アプリケーションのビルド

サポートされるプラットフォーム: Windows^®、Linux^®、Mac

この例では、MATLAB^® 関数を使用する Python^® パッケージの作成方法を説明します。生成されたパッケージは、Python アプリケーションに統合できます。また、この例では、Python アプリケーションから Python パッケージを呼び出す方法も示します。MATLAB のライセンスコピーがターゲットシステムにインストールされている必要はありません。

MATLAB での関数の作成

MATLAB で、パッケージ化する MATLAB コードを調べます。この例では、次のように関数 makesqr.m を記述します。

function y = makesqr(x)

y = magic(x);

MATLAB コマンドプロンプトで、makesqr(5) と入力します。

出力は以下のようになります。

    17    24     1     8    15
    23     5     7    14    16
     4     6    13    20    22
    10    12    19    21     3
    11    18    25     2     9

ライブラリコンパイラアプリを使用した Python アプリケーションの作成

[MATLAB アプリ] タブで、[アプリ] セクションの右端にある矢印をクリックします。[アプリケーション配布] で、[ライブラリコンパイラ] をクリックします。
または、MATLAB コマンドプロンプトで以下を入力して、[ライブラリコンパイラ] アプリを開きます。
```
libraryCompiler
```
ツールストリップの [タイプ] セクションで、[Python パッケージ] をクリックします。
ライブラリコンパイラ アプリのプロジェクトウィンドウで、配布する MATLAB アプリケーションのファイルを指定します。
1. ツールストリップの [エクスポートする関数] セクションで、をクリックします。
2. [ファイルの追加] ウィンドウで、サンプルのフォルダーを参照し、パッケージ化する関数を選択します。[開く] をクリックします。
エクスポートする関数ファイルのリストに関数が追加されます。同じアプリケーションに複数のファイルをパッケージ化するには、この手順を繰り返します。
この例では、先ほど記述した makesqr.m ファイルを選択します。
ツールストリップの [パッケージ化オプション] セクションで次のオプションのいずれかを選択して、生成されるアプリケーションに MATLAB Runtime インストーラーを含めるかどうかを決定します。
- ランタイムを Web からダウンロード — MATLAB Runtime をダウンロードして配布された MATLAB アプリケーションと共にインストールするインストーラーを生成します。インストーラーのファイル名を指定できます。
- ランタイムをパッケージに含める — MATLAB Runtime インストーラーを含むアプリケーションを生成します。インストーラーのファイル名を指定できます。
  メモ
  このオプションを初めて選択したときに、MATLAB Runtime インストーラーをダウンロードするように求めるメッセージが表示されます。

パッケージ設定の指定

[ライブラリ名] フィールドに、パッケージの名前として makesqr が自動的に入力されます。この名前を MagicSquarePkg に変更します。Python パッケージの命名要件の詳細については、Import Compiled Python Packagesを参照してください。
サンプル Python ドライバーファイルを生成するための MATLAB ファイルを追加します。Python ドライバーファイルはパッケージの作成に必須ではありませんが、MATLAB により生成された Python アプリケーションのインストールと実行の方法を示すために使用します。
[サンプル] セクションで、[新規サンプルの作成] を選択して makesqr.m をクリックします。MATLAB ファイルが編集用に開きます。
```
% Sample script to demonstrate execution of function y = makesqr(x)
x = 0; % Initialize x here
y = makesqr(x);
```
x = 0 を x = 3 に変更し、ファイルを保存して、[ライブラリコンパイラ] アプリに戻ります。詳細と制限については、サンプルドライバーファイルの作成を参照してください。

アプリケーションとその外観のカスタマイズ

次のように、インストーラーのカスタマイズ、アプリケーションのカスタマイズ、アプリケーションに関する情報の追加を実行できます。

ライブラリ情報 — 配布されるアプリケーションに関する情報。また、アプリケーションアイコンとスプラッシュスクリーンを変更して、アプリケーションの外観をカスタマイズすることもできます。生成されるインストーラーはこの情報を使用して、インストールされるアプリケーションのメタデータを入力します。インストーラーのカスタマイズを参照してください。
追加インストーラーオプション — 生成されるインストーラーの既定のインストールパスと、カスタムロゴの選択。インストールパスの変更を参照してください。
ライブラリの実行に必要なファイル — 生成されるアプリケーションを実行するために必要な追加ファイル。これらのファイルは、生成されるアプリケーションインストーラーに含められます。コンパイラプロジェクトの必須ファイルの管理を参照してください。
エンドユーザー用にインストールされるファイル — アプリケーションと共にインストールされるファイル。
アプリケーションと共にインストールするファイルの指定を参照してください。

アプリケーションのパッケージ化

パッケージ化されたアプリケーションを生成するには、[パッケージ化] をクリックします。
[プロジェクトを保存] ダイアログボックスで、プロジェクトを保存する場所を指定します。
[パッケージ] ダイアログボックスで、[プロセスが完了したら出力フォルダーを開く] が選択されていることを確認します。
パッケージ化プロセスが完了したら、生成された出力を調べます。
- ターゲットフォルダーの場所に for_redistribution、for_redistribution_files_only、for_testing の 3 つのフォルダーが生成されます。
  これらのフォルダーに生成されるファイルの詳細については、MATLAB 関数のパッケージ化後に生成されるファイルを参照してください。
- PackagingLog.txt — MATLAB Compiler™ により生成されたログファイル。

compiler.build.pythonPackage を使用した `Python` パッケージの作成

メモ

ライブラリコンパイラ アプリを使用して Python パッケージが既に作成されている場合は、この節を省略できます。一方、プログラムによる方法で MATLAB コマンドウィンドウから Python パッケージを作成する方法を確認する場合は、以下の手順に従ってください。

以下のコードを makesqrSample1.m という名前のサンプルファイルに保存します。
```
x = 3;
a = makesqr(x);
```
関数 compiler.build.pythonPackage と先ほど作成した makesqr.m ファイルを使用して、Python パッケージをビルドします。名前と値の引数を使用してサンプルファイルを追加し、パッケージ名を指定します。
```
buildResults = compiler.build.pythonPackage('makesqr.m',...
'PackageName','MagicSquarePkg',...
'SampleGenerationFiles','makesqrSample1.m');
```
compiler.build.Results オブジェクト buildResults に、ビルドタイプ、生成されたファイル、ビルドオプションに関する情報が格納されます。
この構文により、現在の作業ディレクトリの MagicSquarePkgpythonPackage という名前のフォルダー内に以下のファイルが生成されます。
- samples\makesqrSample1.py — Python サンプルドライバーファイル。
- GettingStarted.html — パッケージの統合に関する情報が含まれる HTML ファイル。
- mccExcludedFiles.log — アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。
- readme.txt — パッケージ化およびインターフェイスの情報が含まれるテキストファイル。
- requiredMCRProducts.txt — MATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキストファイル。
- setup.py — パッケージをインストールする Python ファイル。
- unresolvedSymbols.txt — 未解決のシンボルに関する情報が含まれるテキストファイル。
メモ
生成されたパッケージに MATLAB Runtime やインストーラーは含まれていません。
compiler.build コマンドでは、以下の名前と値の引数を 1 つ以上使用することによって、追加オプションを指定できます。
- 'AdditionalFiles' — パッケージに含める追加ファイルへのパス。
- 'AutoDetectDataFiles' — データファイルを自動的に含めるためのフラグ。
- 'OutputDir' — 生成されたファイルを含む出力ディレクトリへのパス。
- 'PackageName' — 生成されたパッケージの名前。
- 'SampleGenerationFiles' — サンプル Python パッケージファイルの生成に使用される MATLAB サンプルファイル。詳細については、サンプルドライバーファイルの作成を参照してください。
- 'Verbose' — ビルドプロセス中にコンパイラ出力を示す進行状況の情報を表示するためのフラグ。

MATLAB により生成された Python アプリケーションのインストールと実行

Python パッケージの作成後、Python アプリケーションからこれを呼び出すことができます。作成する Python アプリケーションでは、パッケージ化の際に生成されたサンプル Python ドライバーコードを使用します。この Python ドライバーコードは Python パッケージを呼び出し、以前のセットアップ手順で選択したサンプル MATLAB ファイルを基にしています。

これらの手順は、GettingStarted.html ファイルでも説明されています。開始する前に、MATLAB Runtime のインストールと構成が完了していて、Python がインストールされていることを確認してください。

生成された Python ドライバーコードファイル makesqrSample1.py を samples フォルダーからコピーして、setup.py ファイルを含むフォルダーに貼り付けます。
システムのコマンドラインを使用して、生成されたサンプル Python ドライバーコードファイルと setup.py を含むフォルダーに移動します。
システムのコマンドプロンプトで python を使用して、アプリケーションをインストールします。
```
python setup.py install
```
システムのコマンドプロンプトからアプリケーションを実行します。
```
python makesqrSample1.py
```
メモ
macOS では、mwpython スクリプトを使用しなければなりません。mwpython スクリプトは matlabroot/bin フォルダーにあります。matlabroot は MATLAB がインストールされている場所です。
たとえば、mwpython makesqrSample1.py などです。

参考

mwpython | libraryCompiler | compiler.build.pythonPackage | mcc | deploytool