compiler.build.PythonPackageOptions

Python パッケージのビルドオプション

R2021a 以降

構文

opts = compiler.build.PythonPackageOptions(FunctionFiles)

opts = compiler.build.PythonPackageOptions(FunctionFiles,Name,Value)

説明

opts = compiler.build.PythonPackageOptions(FunctionFiles) は、FunctionFiles で指定された MATLAB^® 関数を使用して PythonPackageOptions オブジェクトを作成します。PythonPackageOptions オブジェクトを関数 compiler.build.pythonPackage への入力として使用します。

例

opts = compiler.build.PythonPackageOptions(FunctionFiles,Name,Value) は、名前と値の引数を 1 つ以上使用してオプションが指定された PythonPackageOptions オブジェクトを作成します。オプションには、パッケージ名、出力ディレクトリ、含める追加ファイルなどがあります。

例

すべて折りたたむ

ファイルを使用した Python パッケージオプションオブジェクトの作成

ファイル入力を使用して PythonPackageOptions オブジェクトを作成します。

この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

appFile = which('magicsquare.m');
opts = compiler.build.PythonPackageOptions(appFile)

opts = 

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquarepythonPackage'

ドット表記を使用して、既存の PythonPackageOptions オブジェクトのプロパティ値を変更することができます。たとえば、詳細な出力を有効にします。

opts.Verbose = 'on';

PythonPackageOptions オブジェクトを関数 compiler.build.pythonPackage への入力として使用して、Python^® パッケージをビルドします。

buildResults = compiler.build.pythonPackage(opts);

Python パッケージオプションオブジェクトのカスタマイズ

PythonPackageOptions オブジェクトを作成し、名前と値の引数を使用してカスタマイズします。

この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。名前と値の引数を使用して出力ディレクトリを指定し、データファイルの自動検出を無効にします。

opts = compiler.build.PythonPackageOptions(which('magicsquare.m'), ...
'OutputDir','D:\Documents\MATLAB\work\MagicPythonPackage', ...
'AutoDetectDataFiles','off')

opts = 

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicPythonPackage'

ドット表記を使用して、既存の PythonPackageOptions オブジェクトのプロパティ値を変更することができます。たとえば、詳細な出力を有効にします。

opts.Verbose = 'on';

PythonPackageOptions オブジェクトを関数 compiler.build.pythonPackage への入力として使用して、Python パッケージをビルドします。

buildResults = compiler.build.pythonPackage(opts);

入力引数

すべて折りたたむ

`FunctionFiles` — MATLAB 関数を実装するファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

MATLAB 関数を実装するファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。ファイルパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルの拡張子は .m、.p、.mlx、.mexa64 のいずれかである必要があります。

例: ["myfunc1.m","myfunc2.m"]

データ型: char | string | cell

名前と値の引数

すべて折りたたむ

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: OutputDir='D:\work\myproject'

`AdditionalFiles` — 追加ファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

Python パッケージに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'AdditionalFiles',["myvars.mat","data.txt"]

データ型: char | string | cell

`AutoDetectDataFiles` — データファイルを自動的に含めるためのフラグ
`'on'` (既定値) | on/off の logical 値

データファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、特定の関数 (load や fopen など) の入力として指定されるデータファイルは自動的にパッケージに含められます。
このプロパティを 'off' に設定した場合、データファイルは AdditionalFiles オプションを使用してパッケージに追加する必要があります。

例: 'AutoDetectDataFiles','off'

データ型: logical

`ExternalEncryptionKey` — 暗号化キーファイルおよびローダーファイルへのパス
スカラー struct

R2024b 以降

外部の AES 暗号化キーファイルおよび MEX キーローダーファイルへのパス。char 行ベクトルまたは string スカラーの正確に 2 つのフィールドをもつスカラー struct として指定します。フィールド名はそれぞれ EncryptionKeyFile と RuntimeKeyLoaderFile です。struct のフィールドはどちらも必須です。ファイルパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

たとえば、struct keyValueStruct を使用して暗号化キーを encrypt.key、ローダーファイルを loader.mexw64 と指定します。

keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'

暗号化キーファイルは、サポートされている次のいずれかの形式でなければなりません。

バイナリ 256 ビットの AES キー、32 バイトのファイルサイズ
16 進数でエンコードされた AES キー、64 バイトのファイルサイズ

MEX ファイルローダーは実行時に復号化キーを取得します。これは次の引数をもつインターフェイスでなければなりません。

prhs[0] — 入力、固定値 'get' として指定される char 配列
prhs[1] — 入力、CTF コンポーネント UUID として指定される char 配列
plhs[0] — 出力、キーの形式に応じて 32 バイトの UINT8 数値配列または 64 バイトの 16 進数でエンコードされた char 配列

複数の CTF で同じキーを共有することは避けてください。

例: 'ExternalEncryptionKey',keyValueStruct

データ型: struct

`PackageName` — Python パッケージの名前
文字ベクトル | string スカラー

Python パッケージの名前。文字ベクトルまたは string スカラーとして指定します。'PackageName' を名前空間として指定します。これは、companyname.groupname.component のようにピリオドで区切られたリストです。生成されたパッケージの名前は、ピリオドで区切られたリストの最後のエントリに設定されます。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

指定しない場合、PackageName の既定値は、FunctionFiles 引数内にリストされている最初の MATLAB ファイルの名前です。

例: 'PackageName','mathworks.pythonpackage.mymagic'

データ型: char | string

`SampleGenerationFiles` — MATLAB サンプルファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

パッケージに含まれる関数のサンプル Python ファイルを生成するために使用する MATLAB サンプルファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルには .m 拡張子が必要です。

例: 'SampleGenerationFiles',["sample1.m","sample2.m"]

データ型: char | string | cell

`SecretsManifest` — JSON マニフェストファイルへのパス
文字ベクトル | string スカラー

R2024b 以降

デプロイ可能なアーカイブに組み込む秘密鍵を指定する secret マニフェスト JSON ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

MATLAB コードで関数 getSecret、getSecretMetadata、または isSecret を呼び出す場合、デプロイ可能なアーカイブに組み込む秘密鍵を JSON secret マニフェストファイルで指定しなければなりません。コードで getSecret を呼び出す場合に SecretsManifest オプションが指定されていないと、MATLAB Compiler™ は警告を発行し、<component_name>_secrets_manifest.json という名前の出力フォルダーにテンプレート JSON ファイルを生成します。"Embedded" フィールドで秘密鍵の名前を指定して、このファイルを修正します。

関数 setSecret はデプロイ可能ではありません。デプロイ可能なアーカイブに秘密鍵を組み込むには、アーカイブをビルドする前に MATLAB で setSecret を呼び出す必要があります。

シークレットを使用したデプロイの詳細については、Handle Sensitive Information in Deployed Applicationsを参照してください。

例: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'

データ型: char | string

`ObfuscateArchive` — デプロイ可能なアーカイブを難読化するためのフラグ
`'off'` (既定値) | on/off の logical 値

デプロイ可能なアーカイブを難読化するためのフラグ。'on'/1/true または 'off'/0/false として指定します。この値は、matlab.lang.onoffSwitchState 型の on/off の logical 値として保存されます。

このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンドユーザーに対して難読化され、.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイルに含まれているユーザーコードおよびデータはアーカイブ内のユーザーパッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。

実行時に、MATLAB コードとデータはファイルシステムに抽出されるのではなく、ユーザーパッケージから直接復号化されて読み込まれます。MEX ファイルは、一時的にユーザーパッケージから抽出されてから、読み込まれます。

追加のファイルタイプをユーザーパッケージに手動で含めるには、それぞれのファイルタイプを個別の拡張子タグでファイル matlabroot/toolbox/compiler/advanced_package_supported_files.xml に追加します。

以下はサポートされて "いません"。

ver 関数
DLL などの外部ライブラリの呼び出し
アウトプロセスの MATLAB Runtime (MATLAB データ配列の C++ 共有ライブラリ)
アウトプロセスでの MEX ファイルの実行 (mexhost、feval、matlab.mex.MexHost)
R2023b より前: v7.3 以外の .mat ファイル

このオプションを有効にすることは、-j および -s を指定して mcc を使用するのと等価です。

このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。

例: 'ObfuscateArchive','on'

データ型: logical

`OutputDir` — 出力ディレクトリへのパス
文字ベクトル | string スカラー

ビルドファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルドフォルダーの既定の名前は、パッケージ名に pythonPackage を追加したものです。

例: 'OutputDir','D:\Documents\MATLAB\work\mymagicpythonPackage'

データ型: char | string

`SupportPackages` — サポートパッケージ
`'autodetect'` (既定値) | `'none'` | string スカラー | 文字ベクトルの cell 配列 | string 配列

含めるサポートパッケージ。次のオプションのいずれかとして指定します。

'autodetect' (既定) — 依存関係の分析プロセスにより、必要なサポートパッケージが自動的に検出され、含められます。
'none' — サポートパッケージは含められません。このオプションを使用すると、ランタイムエラーの原因となる可能性があります。
string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポートパッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポートパッケージのリストを表示するには、compiler.codetools.deployableSupportPackages を参照してください。

例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

データ型: char | string | cell

`Verbose` — ビルドの詳細を制御するためのフラグ
`'off'` (既定値) | on/off の logical 値

ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

このプロパティを 'on' に設定した場合、MATLAB コマンドウィンドウには、ビルドプロセス中のコンパイラ出力を示す進行状況情報が表示されます。
このプロパティを 'off' に設定した場合、コマンドウィンドウには進行状況の情報は表示されません。

例: 'Verbose','on'

データ型: logical

出力引数

すべて折りたたむ

`opts` — Python パッケージのビルドオプション
`PythonPackageOptions` オブジェクト

Python パッケージのビルドオプション。PythonPackageOptions オブジェクトとして返されます。

バージョン履歴

R2021a で導入

すべて展開する

R2024b: 暗号化キーを指定

ExternalEncryptionKey オプションを使用して、256 ビットの AES 暗号化キーと、実行時に復号化キーを取得するための MEX ファイルのローダーインターフェイスを指定します。このオプションは、mcc -k オプションと等価です。

R2024b: シークレットを使用したコードのパッケージ化

SecretsManifest オプションを使用して、デプロイ可能なコードアーカイブ内部に組み込むシークレットを指定する JSON ファイルを含めます。このオプションは、mcc -J オプションと等価です。

R2023a: ファイル構造と MATLAB コードの難読化

ObfuscateArchive オプションを使用して、フォルダー構造およびファイル名を難読化し、MATLAB ファイルデータおよびユーザーコードをアーカイブ内のユーザーパッケージに配置します。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-j および -s を指定して mcc を使用するのと等価です。

R2021b: サポートパッケージを指定

SupportPackages オプションを使用して、デプロイ可能なコードアーカイブに含めるサポートパッケージを指定します。

参考

compiler.build.pythonPackage

compiler.build.PythonPackageOptions

構文

説明

例

ファイルを使用した Python パッケージ オプション オブジェクトの作成

Python パッケージ オプション オブジェクトのカスタマイズ

入力引数

FunctionFiles — MATLAB 関数を実装するファイル 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

名前と値の引数

AdditionalFiles — 追加ファイル 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

AutoDetectDataFiles — データ ファイルを自動的に含めるためのフラグ 'on' (既定値) | on/off の logical 値

ExternalEncryptionKey — 暗号化キー ファイルおよびローダー ファイルへのパス スカラー struct

PackageName — Python パッケージの名前 文字ベクトル | string スカラー

SampleGenerationFiles — MATLAB サンプル ファイル 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

SecretsManifest — JSON マニフェスト ファイルへのパス 文字ベクトル | string スカラー

ObfuscateArchive — デプロイ可能なアーカイブを難読化するためのフラグ 'off' (既定値) | on/off の logical 値

OutputDir — 出力ディレクトリへのパス 文字ベクトル | string スカラー

SupportPackages — サポート パッケージ 'autodetect' (既定値) | 'none' | string スカラー | 文字ベクトルの cell 配列 | string 配列

Verbose — ビルドの詳細を制御するためのフラグ 'off' (既定値) | on/off の logical 値

出力引数

opts — Python パッケージのビルド オプション PythonPackageOptions オブジェクト

バージョン履歴

R2024b: 暗号化キーを指定

R2024b: シークレットを使用したコードのパッケージ化

R2023a: ファイル構造と MATLAB コードの難読化

R2021b: サポート パッケージを指定

参考

ファイルを使用した Python パッケージオプションオブジェクトの作成

Python パッケージオプションオブジェクトのカスタマイズ

`FunctionFiles` — MATLAB 関数を実装するファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

`AdditionalFiles` — 追加ファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

`AutoDetectDataFiles` — データファイルを自動的に含めるためのフラグ
`'on'` (既定値) | on/off の logical 値

`ExternalEncryptionKey` — 暗号化キーファイルおよびローダーファイルへのパス
スカラー struct

`PackageName` — Python パッケージの名前
文字ベクトル | string スカラー

`SampleGenerationFiles` — MATLAB サンプルファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

`SecretsManifest` — JSON マニフェストファイルへのパス
文字ベクトル | string スカラー

`ObfuscateArchive` — デプロイ可能なアーカイブを難読化するためのフラグ
`'off'` (既定値) | on/off の logical 値

`OutputDir` — 出力ディレクトリへのパス
文字ベクトル | string スカラー

`SupportPackages` — サポートパッケージ
`'autodetect'` (既定値) | `'none'` | string スカラー | 文字ベクトルの cell 配列 | string 配列

`Verbose` — ビルドの詳細を制御するためのフラグ
`'off'` (既定値) | on/off の logical 値

`opts` — Python パッケージのビルドオプション
`PythonPackageOptions` オブジェクト

R2021b: サポートパッケージを指定