Exponenta Banner
exponenta event banner

compiler.build.pythonPackage

Создание пакета Python для развертывания вне MATLAB

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

    Синтаксис

    compiler.build.pythonPackage (файлы функций)
    compiler.build.pythonPackage (функциональные файлы, имя, значение)
    compiler.build.pythonPackage (параметры)
    results = compiler.build.pythonPackage (___)

    Описание

    пример

    compiler.build.pythonPackage(FunctionFiles) создает пакет Python ® с использованием функций MATLAB ®, указанных вFunctionFiles.

    пример

    compiler.build.pythonPackage(FunctionFiles,Name,Value) создает пакет Python с дополнительными параметрами, заданными с помощью одного или нескольких аргументов «имя-значение». Параметры включают имя пакета, каталог вывода и дополнительные файлы для включения.

    пример

    compiler.build.pythonPackage(opts) создает пакет Python с параметрами, заданными с помощью compiler.build.PythonPackageOptions объект opts. Другие параметры нельзя задать с помощью аргументов «имя-значение».

    пример

    results = compiler.build.pythonPackage(___) возвращает информацию о построении в виде compiler.build.Results с использованием любой из комбинаций входных аргументов в предыдущих синтаксисах. Сведения о построении состоят из типа построения, путей к скомпилированным файлам и параметров построения.

    Примеры

    свернуть все

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

    В MATLAB найдите функцию MATLAB, которую необходимо развернуть как пакет Python. Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

    Построение пакета Python с помощью compiler.build.pythonPackage команда.

    compiler.build.pythonPackage(appFile);

    Функция построения создает следующие файлы в папке с именем magicsquarepythonPackage в текущей рабочей папке:

    • GettingStarted.html

    • example

    • mccExcludedFiles.log

    • readme.txt

    • requiredMCRProducts.txt

    • setup.py

    • unresolvedSymbols.txt

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

    Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

    Построение пакета Python с помощью compiler.build.pythonPackage команда. Используйте аргументы name-value, чтобы указать имя пакета, добавить MAT-файл и включить подробный вывод.

    compiler.build.pythonPackage(appFile,'PackageName','MyMagicSquare',...
    'AdditionalFiles','myvars.mat',...
    'Verbose','on');

    Создание нескольких пакетов Python с помощью compiler.build.PythonPackageOptions объект.

    Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

    Создать PythonPackageOptions объект с использованием appFile. Используйте аргументы «имя-значение», чтобы указать общий выходной каталог, отключить автоматическое обнаружение файлов данных и включить подробный вывод.

    opts = compiler.build.PythonPackageOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\PythonPackageBatch',...
    'AutoDetectDataFiles','off',...
    'Verbose','on')
    opts =

  PythonPackageOptions with properties:

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

    Создайте пакет Python с помощью PythonPackageOptions объект.

    compiler.build.pythonPackage(opts);

    Компиляция с использованием файла функции myMagic2.m с теми же опциями, используйте точечную нотацию для изменения FunctionFiles аргумент существующего PythonPackageOptions перед повторным запуском функции построения.

    opts.FunctionFiles = 'myMagic2.m';
compiler.build.pythonPackage(opts);

    Путем изменения FunctionFiles аргумент и перекомпиляция, можно скомпилировать несколько компонентов, используя один и тот же объект options.

    Создание пакета Python и сохранение информации о типе сборки, созданных файлах и параметрах сборки в compiler.build.Results объект.

    Компиляция с помощью файла magicsquare.m расположен в matlabroot\extern\examples\compiler.

    results = compiler.build.pythonPackage('magicsquare.m');
    results = 

  Results with properties:

            BuildType: 'pythonPackage'
                Files: {3×1 cell}
              Options: [1×1 compiler.build.PythonPackageOptions]

    Files содержит пути к следующим объектам:

    • example папка

    • setup.py

    • GettingStarted.html

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

    свернуть все

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

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

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

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

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

    Укажите дополнительные пары, разделенные запятыми 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

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

    свернуть все

    Результаты построения, возвращенные как compiler.build.Results объект. Results объект содержит:

    • Тип построения, который является 'pythonPackage'

    • Пути к следующим элементам:

      • example папка

      • setup.py

      • GettingStarted.html

    • Параметры построения, указанные как PythonPackageOptions объект

    См. также

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

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

    Поддержка