compiler.build.PythonPackageOptions
Syntax
Description
creates a opts
= compiler.build.PythonPackageOptions(FunctionFiles
)PythonPackageOptions
object using MATLAB® functions specified by FunctionFiles
. Use the
PythonPackageOptions
object as an input to the compiler.build.pythonPackage
function.
creates a opts
= compiler.build.PythonPackageOptions(FunctionFiles
,Name,Value
)PythonPackageOptions
object with options specified using one or
more name-value arguments. Options include the package name, output directory, and
additional files to include.
Examples
Create a PythonPackageOptions
object using file
input.
For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
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'
You can modify the property values of an existing
PythonPackageOptions
object using dot notation. For example, enable
verbose output.
opts.Verbose = 'on';
Use the PythonPackageOptions
object as an input to the compiler.build.pythonPackage
function to build a Python® package.
buildResults = compiler.build.pythonPackage(opts);
Create a PythonPackageOptions
object and customize
it using name-value arguments.
For this example, use the file magicsquare.m
located in
.
Use name-value arguments to specify the output directory and disable automatic detection
of data files.matlabroot
\extern\examples\compiler
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'
You can modify the property values of an existing
PythonPackageOptions
object using dot notation. For example, enable
verbose output.
opts.Verbose = 'on';
Use the PythonPackageOptions
object as an input to the compiler.build.pythonPackage
function to build a Python package.
buildResults = compiler.build.pythonPackage(opts);
Input Arguments
Files implementing MATLAB functions, specified as a character vector, a string scalar, a string
array, or a cell array of character vectors. File paths can be relative to the current
working directory or absolute. Files must have one of the following extensions: .m
, .p
, .mlx
, or .mexa64
.
Example: ["myfunc1.m","myfunc2.m"]
Data Types: char
| string
| cell
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: OutputDir='D:\work\myproject'
Additional files and folders to include in the Python package, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.
Example: 'AdditionalFiles',["myvars.mat","data.txt"]
Data Types: char
| string
| cell
Flag to automatically include data files, specified as 'on'
or 'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to true
, and 'off'
is equivalent to false
. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then data files that you provide as inputs to certain functions (such asload
andfopen
) are automatically included in the package.If you set this property to
'off'
, then you must add data files to the package using theAdditionalFiles
option.
Example: 'AutoDetectDataFiles','off'
Data Types: logical
Since R2024b
Paths to the external AES encryption key and MEX key loader files, specified
as a scalar struct with exactly two row char vector or string scalar fields
named EncryptionKeyFile
and
RuntimeKeyLoaderFile
, respectively. Both struct fields
are required. File paths can be relative to the current working directory or
absolute.
For example, specify the encryption key as encrypt.key
and
loader file as loader.mexw64
using struct
keyValueStruct
.
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
The encryption key file must be in one of the following supported formats:
Binary 256-bit AES key, with a 32 byte file size
Hex encoded AES key, with a 64 byte file size
The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:
prhs[0]
— Input, char array specified as the static value'get'
prhs[1]
— Input, char array specified as the CTF component UUIDplhs[0]
— Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format
Avoid sharing the same key across multiple CTFs.
Example: 'ExternalEncryptionKey',keyValueStruct
Data Types: struct
Name of the Python package, specified as a character vector or a string scalar.
Specify 'PackageName'
as a namespace, which is a
period-separated list, such as
companyname.groupname.component
. The name of the
generated package is set to the last entry of the period-separated list. The
name must begin with a letter and contain only alphabetic characters and
periods.
If not specified, PackageName
defaults to the name of the
first MATLAB file listed in the FunctionFiles
argument.
Example: 'PackageName','mathworks.pythonpackage.mymagic'
Data Types: char
| string
MATLAB sample files used to generate sample Python files for functions included with the package, specified as a
character vector, a string scalar, a string array, or a cell array of character
vectors. Paths can be relative to the current working directory or
absolute. Files must have a .m
extension.
Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]
Data Types: char
| string
| cell
Since R2024b
Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
If your MATLAB code calls the getSecret
, getSecretMetadata
, or isSecret
function, you must specify the secret keys to embed in
the deployable archive in a JSON secret manifest file. If your code calls
getSecret
and you do not specify the
SecretsManifest
option, MATLAB
Compiler™ issues a warning and generates a template JSON file in the output
folder named
.
Modify this file by specifying the secret key names in the Embedded field.<component_name>
_secrets_manifest.json
The setSecret
function is not deployable. To embed secret keys in a
deployable archive, you must call setSecret
in MATLAB before you build the archive.
For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.
Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
Data Types: char
| string
Flag to obfuscate the deployable archive, specified as
'on'/1/true
or 'off'/0/false
. The
value is stored as an on/off logical value of type matlab.lang.onoffSwitchState
.
If you set this property to 'on'
, then folder structures
and file names in the deployable archive are obfuscated from the end user, and
user code and data contained in .m
,
.mlapp
, .p
, .mat
, MLX,
SFX, and MEX files are placed into a user package within the archive.
Additionally, all .m
files are converted to P-files before
packaging.
During runtime, MATLAB code and data is decrypted and loaded directly from the user package rather than extracted to the file system. MEX files are temporarily extracted from the user package before being loaded.
To manually include additional file types in the user package, add each file
type in a separate extension tag to the file
.matlabroot
/toolbox/compiler/advanced_package_supported_files.xml
The following are not supported:
ver
functionCalling external libraries such as DLLs
Out-of-process MATLAB Runtime (C++ shared library for MATLAB Data Array)
Out-of-process MEX file execution (
mexhost
,feval
,matlab.mex.MexHost
)Before R2023b:
.mat
files other than v7.3
Enabling this option is equivalent to using mcc
with
-j
and -s
specified.
If you set this property to 'off'
, then the deployable
archive is not obfuscated. This is the default behavior.
Example: 'ObfuscateArchive','on'
Data Types: logical
Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
The default name of the build folder is the package name appended with pythonPackage
.
Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicpythonPackage'
Data Types: char
| string
Support packages to include, specified as one of the following options:
'autodetect'
(default) — The dependency analysis process detects and includes the required support packages automatically.'none'
— No support packages are included. Using this option can cause runtime errors.A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see
compiler.codetools.deployableSupportPackages
.
Example: 'SupportPackages',{'Deep Learning Toolbox Converter for
TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet
Network'}
Data Types: char
| string
| cell
Flag to control build verbosity, specified as 'on'
or 'off'
, or as numeric or logical 1
(true
) or 0
(false
). A value of 'on'
is equivalent to true
, and 'off'
is equivalent to false
. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
If you set this property to
'on'
, then the MATLAB command window displays progress information indicating compiler output during the build process.If you set this property to
'off'
, then the command window does not display progress information.
Example: 'Verbose','on'
Data Types: logical
Output Arguments
Python package build options, returned as a PythonPackageOptions
object.
Version History
Introduced in R2021aUse the ExternalEncryptionKey
option to specify a 256-bit AES
encryption key and a MEX-file loader interface to retrieve the decryption key at runtime.
This option is equivalent to the mcc -k
option.
Use the SecretsManifest
option to include a JSON file that specifies
secrets to embed within your deployable code archive. This option is equivalent to the
mcc -J
option.
Use the SupportPackages
option to specify support packages to include
in the deployable code archive.
See Also
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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: United States.
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)