このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
compiler.build.pythonPackage
構文
説明
compiler.build.pythonPackage(
は、FunctionFiles
)FunctionFiles
で指定された MATLAB® 関数を使用して Python® パッケージを作成します。
compiler.build.pythonPackage(
は、名前と値の引数を 1 つ以上使用して追加オプションを指定して Python パッケージを作成します。オプションには、パッケージ名、出力ディレクトリ、含める追加ファイルなどがあります。FunctionFiles
,Name,Value
)
compiler.build.pythonPackage(
は、opts
)compiler.build.PythonPackageOptions
オブジェクト opts
を使用してオプションを指定して Python パッケージを作成します。名前と値の引数を使用して他のオプションを指定することはできません。
例
ファイルを使用した Python パッケージの作成
魔方陣を生成する関数ファイルを使用して Python パッケージを作成します。
MATLAB で、Python パッケージとしてデプロイする MATLAB 関数を見つけます。この例では、
にあるファイル matlabroot
\extern\examples\compilermagicsquare.m
を使用します。
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
compiler.build.pythonPackage
コマンドを使用して、Python パッケージをビルドします。
compiler.build.pythonPackage(appFile);
ビルド関数により、現在の作業ディレクトリの magicsquarepythonPackage
という名前のフォルダー内に以下のファイルが作成されます。
GettingStarted.html
includedSupportPackages.txt
example
mccExcludedFiles.log
readme.txt
requiredMCRProducts.txt
pyproject.toml
setup.py
unresolvedSymbols.txt
Python パッケージのカスタマイズ
Python パッケージを作成し、名前と値の引数を使用してカスタマイズします。
この例では、
にあるファイル matlabroot
\extern\examples\compilerflames.m
と flames.mat
を使用します。
appFile = fullfile(matlabroot,'extern','examples','compiler','flames.m'); MATFile = fullfile(matlabroot,'extern','examples','compiler','flames.mat');
compiler.build.pythonPackage
コマンドを使用して、Python パッケージをビルドします。名前と値の引数を使用してパッケージ名を指定し、MAT ファイルを追加して、詳細な出力を有効にします。
compiler.build.pythonPackage(appFile,'PackageName','FlamesApp',... 'AdditionalFiles',MATFile,... 'Verbose','on');
オプション オブジェクトを使用した複数の Python パッケージの作成
compiler.build.PythonPackageOptions
オブジェクトを使用して、複数の Python パッケージを作成します。
この例では、
にあるファイル matlabroot
\extern\examples\compilermagicsquare.m
を使用します。
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
appFile
を使用して PythonPackageOptions
オブジェクトを作成します。名前と値の引数を使用して共通の出力ディレクトリを指定し、データ ファイルの自動検出を無効にして、詳細な出力を有効にします。
opts = compiler.build.PythonPackageOptions(appFile,... 'OutputDir','D:\Documents\MATLAB\work\PythonPackageBatch',... 'AutoDetectDataFiles','off',... 'Verbose','on')
opts =
PythonPackageOptions with properties:
FunctionFiles: {'C:\Program Files\MATLAB\R2023b\extern\examples\compiler\magicsquare.m'}
SampleGenerationFiles: {}
AdditionalFiles: {}
AutoDetectDataFiles: off
SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\PythonPackageBatch'
PythonPackageOptions
オブジェクトを使用して Python パッケージをビルドします。
compiler.build.pythonPackage(opts);
同じオプションをもつ関数ファイル hello.m
を使用してコンパイルするには、ビルド関数を再度実行する前に、ドット表記を使用して既存の PythonPackageOptions
オブジェクトの FunctionFiles
引数を変更します。
opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compiler','hello.m'); compiler.build.pythonPackage(opts);
FunctionFiles
引数を変更して再コンパイルすることにより、同じオプション オブジェクトを使用して複数のコンポーネントをコンパイルできます。
Python パッケージからのビルド情報の取得
Python パッケージを作成し、ビルド タイプ、生成ファイル、含まれるサポート パッケージ、およびビルド オプションに関する情報を compiler.build.Results
オブジェクトに保存します。
ファイル magicsquare.m
を使用してコンパイルします。
results = compiler.build.pythonPackage('magicsquare.m');
results = Results with properties: BuildType: 'pythonPackage' Files: {3×1 cell} IncludedSupportPackages: {} Options: [1×1 compiler.build.PythonPackageOptions]
Files
プロパティには、以下へのパスが格納されます。
example
フォルダーsetup.py
GettingStarted.html
入力引数
FunctionFiles
— MATLAB 関数を実装するファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列
MATLAB 関数を実装するファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。ファイル パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルには .m
拡張子が必要です。
例: ["myfunc1.m","myfunc2.m"]
データ型: char
| string
| cell
opts
— Python パッケージのビルド オプション
compiler.build.PythonPackageOptions
オブジェクト
Python パッケージのビルド オプション。compiler.build.PythonPackageOptions
オブジェクトとして指定します。
名前と値の引数
オプションのペアの引数を 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
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
ObfuscateArchive
— デプロイ可能なアーカイブを難読化するためのフラグ
'off'
(既定値) | on/off logical 値
デプロイ可能なアーカイブを難読化するためのフラグ。'on'
または 'off'
、もしくは数値または logical の 1
(true
) か 0
(false
) として指定します。'on'
の値は true
と等価であり、'off'
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
このプロパティを
'on'
に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、MATLAB ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての.m
ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-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
出力引数
results
— ビルド結果
compiler.build.Results
オブジェクト
ビルド結果。compiler.build.Results
オブジェクトとして返されます。Results
オブジェクトには以下が含まれています。
'pythonPackage'
であるビルド タイプ以下の項目へのパス:
example
フォルダーsetup.py
GettingStarted.html
含まれているサポート パッケージのリスト
ビルド オプション。
PythonPackageOptions
オブジェクトとして指定
バージョン履歴
R2021a で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)