Zebroid → Документация → API → Создание плагинов (Python)

Создание плагинов (Python)

В программе: Плагины → Менеджер расширений
Начиная с версии Zebroid 6.4.0 в программу добавлена поддержка Python плагинов. Это мощный инструмент расширения функционала программы самописними пользовательскими скриптами. Широкий выбор говотых Python модулей позволяет существенно увеличить возможности Zebroid.



Скрипты


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

Для управления проектом необходимо импортировать специальный модуль zebroid. В этом модуле есть следующие объекты:

  • plugin — Объект взаимодействия с этим плагином Зеброида
  • records — Объект класса TZebroidRecords (для работы со списком записей проекта)
  • inputs — словарь входящих параметров скрипта
  • progressbar — объект класса TPluginProgressBar (для управление полосой прогресса)
  • project — объект класса TZebroidProject (для управлением проектом)

zebroid.plugin



zebroid.records



Объект класса TZebroidRecord



zebroid.inputs



zebroid.progressbar



zebroid.project



Интерпретатор Python

Zebroid поставляется вместе со своим интерпретатором Python версии 3.11. Файлы можно найти в папке «Zebroid\Core\Python Server\default». Для того, чтобы иметь возможность загружать пакеты через пакетный менеджер pip его нужно установить запустив следующую команду в консоли:
PS> .\python.exe get-pip.py

После этого можно получить список пакетов либо доустановить необходимые пакеты. Например:
PS> .\Scripts\pip.exe list
Package    Version
---------- -------
pip        22.3.1
setuptools 66.0.0
wheel      0.38.4

PS> .\Scripts\pip.exe install numpy
Collecting numpy
  Downloading numpy-1.24.1-cp311-cp311-win_amd64.whl (14.8 MB)
     ---------------------------------------- 14.8/14.8 MB 11.9 MB/s eta 0:00:00
Installing collected packages: numpy
  WARNING: The script f2py.exe is installed in 'C:\Users\xxxx\Downloads\python-3.11.1-embed-amd64\Scripts' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed numpy-1.24.1

PS> .\python.exe -c 'import numpy; print(numpy.__version__)'
1.24.1

Часть пакетов, необходимых для работы плагинов, что идёт в комплекте с программой, уже установлена и поставляется вместе с Zebroid.

Установка пользовательских версий Python

Для того, чтобы установить другие версии Python, необходимо их скачать на официальном сайте (Windows embeddable package (32-bit)) и разархивировать в папку «Zebroid\Core\Python Server\». Называть папки со своими серверами можно как угодно, Зеброид сам распознает установленную в них версию Python. Дополнительные пакеты можно установить таким же способом, как описано выше.

Выбрать версию интерпретатора можно в выпадающему списку в Менеджере плагинов.