compiler.build.pythonPackage

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

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

    Синтаксис

    compiler.build.pythonPackage(FunctionFiles)
    compiler.build.pythonPackage(FunctionFiles,Name,Value)
    compiler.build.pythonPackage(opts)
    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\примеры\компилятор.

    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\примеры\компилятор.

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

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

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

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

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

    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 аргумент и перекомпиляция, можно скомпилировать несколько компонентов с помощью одного и того же объекта опции.

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

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

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

  Results with properties:

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

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

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

    свернуть все

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

    • Тип сборки, который 'pythonPackage'

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

      • example папка

      • setup.py

      • GettingStarted.html

    • Опции сборки, заданные как PythonPackageOptions объект

    См. также

    Введенный в R2021a

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

    Поддержка

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