Exponenta Banner

compiler.build.PythonPackageOptions

Опции для создания пакетов Python

Свернуть все на странице

Синтаксис

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

Описание

пример

opts = compiler.build.PythonPackageOptions(FunctionFiles) создает PythonPackageOptions объект с использованием MATLAB® функции, заданные FunctionFiles. Используйте PythonPackageOptions объект как вход в compiler.build.pythonPackage функция.

пример

opts = compiler.build.PythonPackageOptions(FunctionFiles,Name,Value) создает PythonPackageOptions объект с опциями, заданными с помощью одного или нескольких аргументов в виде имя-значение. Опции включают имя пакета, выходную директорию и дополнительные файлы для включения.

Примеры

свернуть все

Создайте PythonPackageOptions объект с использованием ввода файла.

В данном примере используйте файл magicsquare.m расположен в matlabroot\ extern\примеры\компилятор.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.PythonPackageOptions(appFile)
opts = 

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
                  Verbose: off
                OutputDir: '.\magicsquarepythonPackage'

Можно изменять значения свойств существующей PythonPackageOptions объект с использованием записи через точку. Для примера включите подробные выходы.

opts.Verbose = 'on'
opts = 

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
                  Verbose: on
                OutputDir: '.\magicsquarepythonPackage'

Используйте PythonPackageOptions объект как вход в compiler.build.pythonPackage функция для создания Python® пакет.

buildResults = compiler.build.pythonPackage(opts);

Создайте PythonPackageOptions объект и настройте его с помощью аргументов имя-значение.

В данном примере используйте файл magicsquare.m расположен в matlabroot\ extern\примеры\компилятор. Используйте аргументы имя-значение, чтобы задать выход директории и отключить автоматическое обнаружение файлов данных.

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

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: off
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicPythonPackage'

Можно изменять значения свойств существующей PythonPackageOptions объект с использованием записи через точку. Для примера включите подробные выходы.

opts.Verbose = 'on'
opts = 

  PythonPackageOptions with properties:

            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler'}
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: off
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicPythonPackage'

Используйте PythonPackageOptions объект как вход в compiler.build.pythonPackage функция для создания пакета Python.

buildResults = compiler.build.pythonPackage(opts);

Входные параметры

свернуть все

Файлы, реализующие функции MATLAB, заданные как вектор символов, строковый скаляр, строковые массивы или массив ячеек векторов символов. Пути к файлам могут быть относительно текущей рабочей директории или абсолютными. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Аргументы в виде пар имя-значение

Задайте необязательные разделенные разделенными запятой парами Name,Value аргументы. Name - имя аргумента и Value - соответствующее значение. Name должны находиться внутри кавычек. Можно задать несколько аргументов в виде пар имен и значений в любом порядке Name1,Value1,...,NameN,ValueN.

Пример: 'Verbose','on'

Дополнительные файлы для включения в пакет Python, заданные как вектор символов, строковый скаляр, строковые массивы или массив ячеек из векторов символов. Пути к файлам могут быть относительно текущей рабочей директории или абсолютными.

Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

Типы данных: char | string | cell

Флаг для автоматического включения файлов данных, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

  • Если вы задаете это свойство равным 'on', затем файлы данных, которые вы предоставляете в качестве входов для определенных функций (таких как load и fopen) автоматически включаются в пакет.

  • Если вы задаете это свойство равным 'off', затем необходимо добавить файлы данных в пакет с помощью AdditionalFiles опция.

Пример: 'AutoDetectDataFiles','off'

Типы данных: logical

Имя пакета Python, заданное как вектор символов или строковый скаляр. Задайте 'PackageName' как пространство имен, которое является разделенным периодами списком, таким как companyname.groupname.component. Для имени сгенерированного пакета задается последняя запись списка, разделенного периодами. Имя должно начинаться с буквы и содержать только буквенные символы и точки.

Пример: 'PackageName','mathworks.pythonpackage.mymagic'

Типы данных: char | string

MATLAB выборки, используемые для генерации сэмпла файлов Python для функций, включенных в пакет, заданные как вектор символов, строковый скаляр, строковые массивы или массив ячеек из векторов символов. Пути к файлам могут быть относительно текущей рабочей директории или абсолютными. Файлы должны иметь .m расширение.

Пример: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Типы данных: char | string | cell

Путь к выходу директории, где сохраняются файлы сборки, задается в виде вектора символов или строкового скаляра. Путь может быть относительно текущей рабочей директории или абсолютным.

Имя папки сборки по умолчанию является именем пакета, добавленным с помощью pythonPackage.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicpythonPackage'

Типы данных: char | string

Флаг для управления подробностями сборки, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

  • Если вы задаете это свойство равным 'on', затем в командном окне MATLAB отображается информация о прогрессе, указывающая на выход компилятора в процессе сборки.

  • Если вы задаете это свойство равным 'off'затем командное окно не отображает информацию о прогрессе.

Пример: 'Verbose','on'

Типы данных: logical

Выходные аргументы

свернуть все

Опции сборки пакета Python, возвращенные как PythonPackageOptions объект.

См. также

Введенный в R2021a

Документация MATLAB Compiler SDK

Поддержка