Сегодня мы взглянем, как вы можете создавать привязки для собственного проекта.
В Qt Company рады сообщить, что Qt для Python будет также включать в себя Shiboken - ваш основной инструмент создания привязки.
Прочтите материал ниже, и вы получите представление о том, как создавать привязки Python для простой библиотеки C ++.
Будем надеяться, это способствует тому, что вы сделаете тоже самое с собственными пользовательскими библиотеками.
Как и в любом проекте Qt мы рады представить статьи по Shiboken, тем самым улучшая его понимание для всех.
Пример библиотеки
Основными целями этого поста будет использование нами немного бессмысленной пользовательской библиотеки под названием Universe. Она предусматривает два класса: Icecream (мороженое) и Truck (грузовик).
Icecreams характеризуется вкусом, а Truck служит, как средство доставки Icecream для детей в окрестности. Довольно просто.
Мы хотели бы использовать эти классы внутри Python. Вариант использования – добавление дополнительных вкусов мороженного или проверка успешности доставки мороженного. Говоря простыми словами, мы хотим обеспечить привязки Python для Icecream и Truck, чтобы мы могли использовать их в собственном скрипте Python.
Мы пропустим некоторую часть для краткости, но вы можете посмотреть в репозитории полный исходный код. Ссылка на репозиторий pyside-setup/examples/samplebinding .
C++ библиотека
Во-первых, давайте взглянем на заголовочный файл Icecream
class Icecream
{
public:
Icecream(const std::string &flavor);
virtual Icecream *clone();
virtual ~Icecream();
virtual const std::string getFlavor();
private:
std::string m_flavor;
};
и заголовочный файл Truck
class Truck {
public:
Truck(bool leaveOnDestruction = false);
Truck(const Truck &other);
Truck& operator=(const Truck &other);
~Truck();
void addIcecreamFlavor(Icecream *icecream);
void printAvailableFlavors() const;
bool deliver() const;
void arrive() const;
void leave() const;
void setLeaveOnDestruction(bool value);
void setArrivalMessage(const std::string &message);
private:
void clearFlavors();
bool m_leaveOnDestruction = false;
std::string m_arrivalMessage = "A new icecream truck has arrived!\n";
std::vector m_flavors;
};
Большинство API должны быть достаточно просты для понимания, но мы подведем итоги важнейших частей:
- Icecream является полиморфным типом и предназначается для переопределения
- getFlavor() вернет вкус в зависимости от фактического производного типа
- Truck сохраняет вектор принадлежащих ему объектов Icecream, которые могут быть добавлены через addIcecreamFlavor()
- Сообщение прибытия «грузовика» можно настроить с помощью setArrivalMessage()
- deliver() скажет нам, была ли доставка «мороженого» успешной или нет
Система типов Shiboken
Чтобы информировать shiboken об API, мы нуждаемся в привязках, для этого мы делаем файл-заголовок, который включает в себя интересующие нас типы:
#ifndef BINDINGS_H #define BINDINGS_H #include "icecream.h" #include "truck.h" #endif // BINDINGS_H
Кроме того, shiboken также требуется XML typesystem файл, который определяет отношение между типами C++ и Python:
<?xml version="1.0"?>
<typesystem package="Universe">
<primitive-type name="bool"/>
<primitive-type name="std::string"/>
<object-type name="Icecream">
<modify-function signature="clone()">
<modify-argument index="0">
<define-ownership owner="c++"/>
</modify-argument>
</modify-function>
</object-type>
<value-type name="Truck">
<modify-function signature="addIcecreamFlavor(Icecream*)">
<modify-argument index="1">
<define-ownership owner="c++"/>
</modify-argument>
</modify-function>
</value-type>
</typesystem>
Первая важная вещь на которую нужно обратить внимание – то, что мы объявляем "bool" и "std::string", как примитивные типы. Некоторые из методов C++ используют их как параметр / возвращаемые типы данных, и поэтому shiboken должен знать о них. Затем он может генерировать соответствующий код преобразования между C ++ и Python.
Большинство примитивных типов C ++ обрабатываются shiboken, не требуя дополнительного кода. Затем мы объявляем два вышеупомянутых класса. Один из них как “object-type”(объект-тип), а другой как “value-type” (значение-объект).
Основное отличие состоит в том, что “object-type” передаются в сгенерированном коде, как указатели, тогда как “value-type” копируются (семантика значений).
Задав имена классов в файле системы типов, shiboken автоматически попытается создать привязки для всех методов, объявленных в классах, поэтому нет необходимости указывать все имена методов вручную...
Если вы не хотите каким-либо образом изменить функцию, то это приводит нас к следующей теме «Правилам владения».
Shiboken не может волшебным образом узнать, кто отвечает за освобождение объектов C++, размещенных в коде Python’а.
Может быть множество случаев: Python должен освободить память C ++, когда количество ссылок на объект Python становится равным нулю или Python никогда не должен удалять объект C++, допуская, что он будет удален в определенный момент внутри библиотеки C ++. Или, возможно, это родительский элемент для другого объекта (например, как в QWidgets). В нашем случае метод clone() вызывается только внутри библиотеки C++, и мы предполагаем, что код C++ позаботится о освобождении памяти клонированного объекта.
Что касается addIcecreamFlavor(), мы знаем, что Truck располагается в объекте Icecream, и будет удален сразу же после уничтожения Truck. Таким образом, вновь, право владения устанавливается на “c++.”
Если бы мы не указали правила владения, то в этом случае объекты C++ будут удалены, когда соответствующие имена Python выйдут за пределы области видимости.
Сборка
Чтобы собрать пользовательскую библиотеку Universe и затем сгенерировать для нее привязки, мы предоставляем хорошо документированный, в основном общий файл CMakeLists.txt, который вы можете повторно использовать для своих собственных библиотек.
В основном это сводится к вызову «cmake.», чтобы настроить проект, а затем построить с помощью цепочки инструментов по вашему выбору (мы рекомендуем генератор «(N) Makefiles»).
В результате создания проекта вы получаете две общие библиотеки: libuniverse. (so/dylib/dll) и Universe. (so/pyd).
Первая – это пользовательская библиотека C++ и последняя – это модуль Python, который может быть импортирован из скрипта (документ, тестовый драйвер) Python.
Конечно, есть также промежуточные файлы, созданные shiboken (файлы .h / .cpp, созданные для создания привязок Python). Не волнуйтесь о них, если вам не нужно устранять неполадки или по какой-либо причине не удается скомпилировать или не ведет себя так, как должно. Тогда вы можете отправить Qt Company отчет об ошибке!
И, наконец, мы добираемся до части Python.
Использование Python модуля
В следующем маленьком скрипте мы будем использовать модуль Universe, наследуемся от Icecream, внедрим виртуальные методы, инстанцируем объекты и многое другое
from Universe import Icecream, Truck
class VanillaChocolateIcecream(Icecream):
def __init__(self, flavor=""):
super(VanillaChocolateIcecream, self).__init__(flavor)
def clone(self):
return VanillaChocolateIcecream(self.getFlavor())
def getFlavor(self):
return "vanilla sprinked with chocolate"
class VanillaChocolateCherryIcecream(VanillaChocolateIcecream):
def __init__(self, flavor=""):
super(VanillaChocolateIcecream, self).__init__(flavor)
def clone(self):
return VanillaChocolateCherryIcecream(self.getFlavor())
def getFlavor(self):
base_flavor = super(VanillaChocolateCherryIcecream, self).getFlavor()
return base_flavor + " and a cherry"
if __name__ == '__main__':
leave_on_destruction = True
truck = Truck(leave_on_destruction)
flavors = ["vanilla", "chocolate", "strawberry"]
for f in flavors:
icecream = Icecream(f)
truck.addIcecreamFlavor(icecream)
truck.addIcecreamFlavor(VanillaChocolateIcecream())
truck.addIcecreamFlavor(VanillaChocolateCherryIcecream())
truck.arrive()
truck.printAvailableFlavors()
result = truck.deliver()
if result:
print("All the kids got some icecream!")
else:
print("Aww, someone didn't get the flavor they wanted...")
if not result:
special_truck = Truck(truck)
del truck
print("")
special_truck.setArrivalMessage("A new SPECIAL icecream truck has arrived!\n")
special_truck.arrive()
special_truck.addIcecreamFlavor(Icecream("SPECIAL *magical* icecream"))
special_truck.printAvailableFlavors()
special_truck.deliver()
print("Now everyone got the flavor they wanted!")
special_truck.leave()
После импортирования классов из нашего модуля, мы создаем два производных (вторичных) типа Icecream, которым настроили “вкусы”.
Затем мы создаем truck (грузовик), добавляем к нему некоторые обычные варианты (разновидности) Icecreams (мороженого) и два специальных.
Мы стараемся отправить (доставить) Icecream (мороженое).
Если же доставка не удалась, мы создаем новый truck (грузовик) со старыми вариантами, скопированными, и новый волшебный вариант, который, несомненно, удовлетворит всех клиентов.
В приведенном выше скрипте кратко показано использование выводов из типов C++, переопределение виртуальных методов, создание и уничтожение объектов и т. д.
