Exponenta Banner
exponenta event banner

compiler.build. PythonPackageOptions

Параметры построения пакетов Python

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

Синтаксис

opts = compiler.build.PythonPackageOptions (FuncterFiles)
opts = compiler.build.PythonPackageOptions (функциональные файлы, имя, значение)

Описание

пример

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

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

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

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

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

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

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

свернуть все

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

См. также

Представлен в R2021a

Документация по SDK компилятора MATLAB

Поддержка