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) 使用由一个或多个名称-值参量指定的选项创建 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\R2025b\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\R2025b\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 函数的文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

实现 MATLAB 函数的文件，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。文件路径可以是相对于当前工作目录的路径，也可以是绝对路径。文件必须具有以下扩展名之一：.m、.p、.mlx 或 .mexa64。

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

数据类型: char | string | cell

名称-值参数

全部折叠

将可选参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

如果使用的是 R2021a 之前的版本，请使用逗号分隔每个名称和值，并用引号将 Name 引起来。

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

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

要包含在 Python 包中的其他文件和文件夹，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。路径可以是相对于当前工作目录的路径，也可以是绝对路径。

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

数据类型: char | string | cell

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

自动包含数据文件的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果将此属性设置为 'on'，则您提供的作为特定函数（例如 load 和 fopen）的输入的数据文件将自动包含在包中。
如果将此属性设置为 'off'，则必须使用 AdditionalFiles 选项将数据文件添加到包中。

示例: 'AutoDetectDataFiles','off'

数据类型: logical

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

自 R2024b 起

外部 AES 加密密钥和 MEX 密钥加载程序文件的路径，指定为标量结构体，其中恰好有两个分别名为 EncryptionKeyFile 和 RuntimeKeyLoaderFile 的行字符向量或字符串标量字段。两个结构体字段都是必需的。文件路径可以是相对于当前工作目录的路径，也可以是绝对路径。

例如，使用结构体 keyValueStruct 将加密密钥指定为 encrypt.key，将加载程序文件指定为 loader.mexw64。

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

加密密钥文件必须采用以下受支持的格式之一：

二进制 256 位 AES 密钥，文件大小为 32 字节
十六进制编码的 AES 密钥，文件大小为 64 字节

MEX 文件加载程序在运行时检索解密密钥，并且必须是具有以下参量的接口：

prhs[0] - 输入，指定为静态值 'get' 的字符数组
prhs[1] - 输入，指定为 CTF 组件 UUID 的字符数组
plhs[0] - 输出，32 字节 UINT8 数字数组或 64 字节十六进制编码字符数组，具体取决于密钥格式

请勿在多个 CTF 之间共享同一个密钥。

示例: 'ExternalEncryptionKey',keyValueStruct

数据类型: struct

`PackageName` — Python 包的名称
字符向量 | 字符串标量

Python 包的名称，指定为字符向量或字符串标量。将 'PackageName' 指定为命名空间，它是一个以句点分隔的列表，例如 companyname.groupname.component。生成的包的名称将设置为以句点分隔的列表的最后一个条目。名称必须以字母开头，并且只能包含字母字符和句点。

如果未指定，则 PackageName 默认为 FunctionFiles 参量中列出的第一个 MATLAB 文件的名称。

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

数据类型: char | string

`SampleGenerationFiles` — MATLAB 示例文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

用于为包中包含的函数生成 Python 示例文件的 MATLAB 示例文件，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。路径可以是相对于当前工作目录的路径，也可以是绝对路径。文件必须具有 .m 扩展名。

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

数据类型: char | string | cell

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

自 R2024b 起

机密清单 JSON 文件的路径，该文件指定要嵌入在可部署存档中的密钥，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

如果您的 MATLAB 代码调用 getSecret、getSecretMetadata 或 isSecret 函数，您必须在 JSON 机密清单文件中指定要嵌入可部署存档的密钥。如果您的代码调用 getSecret 并且您未指定 SecretsManifest 选项，则 MATLABCompiler™ 会发出警告，并在名为 <component_name>_secrets_manifest.json 的输出文件夹中生成一个模板 JSON 文件。通过在嵌入字段中指定密钥名称来修改此文件。

setSecret 函数不可部署。要将密钥嵌入在可部署存档中，您必须在编译存档之前在 MATLAB 中调用 setSecret。

有关使用密钥进行部署的详细信息，请参阅处理已部署 App 中的敏感信息。

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

数据类型: char | string

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

混淆可部署存档的标志，指定为 'on'/1/true 或 'off'/0/false。该值存储为 matlab.lang.onoffSwitchState 类型的 on/off 逻辑值。

如果将此属性设置为 '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 Data Array 的 C++ 共享库）
进程外 MEX 文件执行（mexhost、feval、matlab.mex.MexHost）
在 R2023b 之前的版本中: v7.3 之外的 .mat 文件

启用此选项等效于在指定了 -j 和 -s 的情况下使用 mcc。

如果将此属性设置为 'off'，则不会混淆可部署存档。这是默认行为。

示例: 'ObfuscateArchive','on'

数据类型: logical

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

保存编译文件的输出目录的路径，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

编译文件夹的默认名称是包名称后跟 pythonPackage。

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

数据类型: char | string

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

要包含的支持包，指定为以下选项之一：

'autodetect'（默认值）- 依赖关系分析过程会自动检测并包含所需的支持包。
'none' - 不包括任何支持包。使用此选项可能会导致运行时错误。
字符串标量、字符向量或字符向量元胞数组 - 仅包含指定的支持包。要列出已安装的支持包或特定文件使用的那些支持包，请参阅 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 逻辑值

控制编译详细程度的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果将此属性设置为 '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 函数的文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

名称-值参数

AdditionalFiles — 其他文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

AutoDetectDataFiles — 自动包含数据文件的标志 'on' (默认) | on/off 逻辑值

ExternalEncryptionKey — 加密密钥和加载程序文件路径 标量结构体

PackageName — Python 包的名称 字符向量 | 字符串标量

SampleGenerationFiles — MATLAB 示例文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

SecretsManifest — JSON 清单文件路径 字符向量 | 字符串标量

ObfuscateArchive — 混淆处理可部署存档的标志 'off' (默认) | on/off 逻辑值

OutputDir — 输出目录路径 字符向量 | 字符串标量

SupportPackages — 支持包 'autodetect' (默认) | 'none' | 字符串标量 | 字符向量元胞数组 | 字符串数组

Verbose — 控制编译详细程度的标志 'off' (默认) | on/off 逻辑值

输出参量

opts — Python 包构建选项 PythonPackageOptions 对象

版本历史记录

R2024b: 指定加密密钥

R2024b: 打包包含机密的代码

R2023a: 混淆文件结构和 MATLAB 代码

R2021b: 指定支持包

另请参阅

`FunctionFiles` — 实现 MATLAB 函数的文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

`PackageName` — Python 包的名称
字符向量 | 字符串标量

`SampleGenerationFiles` — MATLAB 示例文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

`Verbose` — 控制编译详细程度的标志
`'off'` (默认) | on/off 逻辑值

`opts` — Python 包构建选项
`PythonPackageOptions` 对象