Инструменты пользователя

Инструменты сайта


products:pussy:api:pyub:types:ubhelper

UBHelper

Класс, который включает в себя вспомогательные функции.

Методы

__init__()

Инициализация экземпляра, сюда следует передать ссылку на экземпляр UBWidget вашего плагина.

def __init__(self, key_class:UBWidget) -> None

Параметры:

  • key_class(UBWidget) - ссылка на экземпляр UBWidget вашего плагина (нужен для определения контекста вызова)

Возвращает:

  • None

save_settings_parameters()

Сохраняет параметры свойств, которые находятся в классе PropertyContainer, который указан в поле ub_settings у класса плагина UBWidget и сохраняет их в базе данных. Это нужно сделать, когда программа изменяет параметры свойств, так как Менеджер при каждом запуске загружает параметры из базы данных, если этого не сделать, то будут загружены параметры по умолчанию или те, которые были сохранены ранее.

def save_settings_parameters(self) -> None

Возвращает:

  • None

open_localstorage()

Возвращает объект базы данных Shelve, которая позволяет обращаться к данным через ключ, подобно встроенным словарям. По сути является оберткой для функции shelve.open(). Файлы базы данных сохраняются в корневой папке плагина во вложенной папке localdata.

def open_localstorage(self, flag='c', protocol=None, writeback=False)

Параметры:

Описание смотрите в официальной документации shelve.open()

Возвращает:

  • Shelve-объект базы данных

get_plugin_dir()

Возвращает абсолютный путь к папке, в которой находится плагин.

def get_plugin_dir(self) -> str

Возвращает:

  • str - абсолютный путь к папке плагина.
products/pussy/api/pyub/types/ubhelper.txt · Последнее изменение: 127.0.0.1