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\examples\compiler.

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\examples\compiler. Используйте аргументы значения имени, чтобы задать выходную директорию и отключить автоматическое обнаружение файлов данных.

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 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

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

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

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

Типы данных: логический

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Типы данных: логический

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

свернуть все

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

Смотрите также

Введенный в R2021a

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте