--- # System prepended metadata title: 13. Python Bindings & C++ --- # 13. Python Bindings & C++ Dit verslag legt in het kort uit wat Python bindings zijn, hoe ze werken en welke stappen zijn doornomen om ze toe te passen. [toc] Taakverdeling: - Onderzoek - jesse - Toepassing/werking - Stijn - Writing the bindings - Stijn - Building the C++ function/librarys - Stijn - text opmaken - jesse - Resultaat - jesse - ## Onderzoek ### Inleiding Aan het begin van de opdracht was de kennis over Python bindings zo goed als niet bestaand. De reden hiervoor was dat er nog weinig tot geen ervaring was opgedaan met de taal zelf. Om een goed idee te krijgen van de inhoud van de opdracht, is er begonnen met het volgen van een tutorial. Hierin stond wat Python bindings zijn en waar ze voonamelijk voor gebruikt worden. ### Overview Al snel werd bekend dat python bindings zijn bedoeld om c++ bibliotheken te gebruiken in een Python programma. Dit kan vooral handig zijn als er al een bestaande bibliotheek is die je wilt gebruiken en niet in python wilt overscrhijven. Ook is het vaak een voordeel om c of C++ functies te gebruiken om de compile-time van het programma te versnellen. Dit komt namelijk omdat Python met objecten werkt voor alles wat geinitialiseerd wordt. Deze objecten worden pas tijdens het compileren omgezet naar het juiste soort object, zoals bijvoorbeeld een interger, float, bool een of string. In c of C++ wordt tijdens het schrijven van de code al bepaald welk soort voorwerp het is. ### Meerdere manieren Er zijn meerdere manieren waarop Pyton bindings kunnen toegepast. Elke manier heeft zijn voor en nadelen. **ctypes** Ctypes is een standaard bibliotheek voor Python en was toegevoegd in version 2.5. Het is makkelijk in te voegen door een *import ctypes* command en is alleen bedoeld voor C functies. Dit maakt Ctypes een van de gemakkelijkste manieren om python bindings toe te passen. Het keerpunt is wel dat de mogelijkheden hierdoor beperkt blijven. Het aanroepen van bijvoorbeeld een rekenfunctie die direct een waarde terug geeft is dan ook geen probleem. Mocht het nodig zijn om bepaalde proccessen te automatiseren is dat daarintegen niet mogelijk met het gebruik van alleen Ctypes. **CFFI** CFFI aka "C Foreign Function Interface" gebruikt een meer automatiseerde manier voor Python bindings en is bedoeld voor C functies. Er zijn meerdere mogelijkheden om CFFI toe te passen. Er kan namelijk een standaard bibliotheek gebruikt worden die werkt tussen Python en C, of de C compiler wordt gebruikt om de Python bindings te genereren. Daarnaast kan er gekozen worden om een extra functie toe te voegen die het compilen van de code versnelt. Dit is niet altijd van toepassing bij kleine projecten. Toch is dit wel wat CFFI onderscheid van Ctypes door snellere compile tijden. **PyBind11** PyBind11 heeft een iets andere manier van genereren van Python bindings. Naast dat het voornamelijk is gefoccussed op C++, gebruikt het ook nog eens C++ om de modules te bouwen. Hierdoor maakt het gebruik van de zogeheten "metaprogramming tools". PyBind11 is afgeleid van de C++ bibliotheek "Boost::Python". Toch is PyBind11 een betere keus omdat het alleen versies van C++ 11 en nieuwer ondersteund, waaralsin de Boost bibliotheek alle versies van C++ onderstuend. Het grote voordeel van PyBind11 is dat het classes, subclasses en dinamische atributen onderstuend. Dit is een groot verschil met de vorige manieren om Python bindings te genereren. **Cython** Cython is weer een totaal andere manier van Python bindings generen. Het maakt gebruik van een soort Python-achtige taal die de bindings defineerd en daarmee C of C++ code genereerd dat de modules formuleerd. Dit geeft weer nieuwe mogelijkheden om bepaalde problemen te versnellen. ## Toepassing/werking // stijn **Inleiding** Om gebruik te kunnen maken van de C++ librarys/functies hebben we eerst een aantal tools nodig. Die helpen met het realiseren van het gebruik van C++ functies/librarys in python. ### Installing tools Om gebruik te kunnen maken van je C++ librarys/functies heb je in eerst instantie python en C++ nodig. Deze heb je natuurlijk nodig om überhaupt je programma's te kunnen schrijven. Verder maken we gebruik van Invoke voor het bouwen en testen van de scources files. Om de Invoke commands aan te roepen maken we gebruik van Ubuntu terminal, maar het is ook mogelijk om dit via een andere terminal te doen. In deze tutorial maken we gebruik van een IDE dit is een omgeving waarin je code kan schrijven. In dit geval is dit pycharm, maar dit is optioneel kunt ook een andere gebruiken. **Ubuntu** Ubuntu 22.04.1 is een Linux distribution gebaseerd op Debian. Het is dus een operating system dat met daarbij de Linux kernel. Voor het installeren van Ubuntu ga je naar de volgende link: https://ubuntu.com/#download hier staat de meest recente versie van Ubuntu. In deze tutorial maken we gebruik van Ubuntu 22.04.1 LTS, maar een nieuwere versie moet ook werken. Na het installeren van Ubuntu open je de terminal. Bij de eerste keer open van Ubuntu app zal je een user-name en password aan moeten maken. Bewaar deze gegevens. Vervolgens voer je de volgende command in:![](https://i.imgur.com/BhbDr2Q.png) Hierbij zul je waarschijnlijk je account gegevens moeten invoeren en dit bevestigen. Daarna doe je de volgende command:![](https://i.imgur.com/uBLD6Q0.png) **Invoke** Met de Invoke tool (library) heb je de mogelijkheid om source files om te zetten excutebles. Het heeft ongeveer dezelfde functionaliteit als Make. Het is dus een build automation tool dat source code van programma's/library's omzet naar executable's door the makefiles te lezen. Denk hier bijvoorbeeld aan een Cmake file in C++. Invoke is in zeker zin hetzelfde als Cmake voor C of C++. Voor het installeren van de Invoke library voeren we de volgende command in de Ubuntu terminal: $ python3 -m pip install invoke. **Pybind11** Om bindings te kunnen maken hebben natuurlijk de Pybind11 library nodig. Om deze te installeren voer je de volgende command uit in je ubuntu terminal. $ python3 -m pip install pybind11 ### Writing the bindings Om een binding te maken heb in eerst instantie een c++ source file en header file nodig die je wilt gaan gebruiken. In dit voorbeeld gebruiken we onze source file cpp_function. In deze source file hebben wij diverse functie gemaakt die bepaalde operaties kunnen uitvoeren. Denk hierbij aan het optellen, aftrekken, vermenigvuldigen, delen door, kwadraat en wortel van een getal dat je mee geeft aan deze functie. Als voorbeeld gebruik ik de functie optellen. Zie afbeelding hieronder: ![](https://i.imgur.com/BeESWo2.png) Deze functie telt twee float getallen bij elkaar op en returned de uitkomst hiervan in cpp. De afbeelding hieronder is de header file van de source file waar alle functies in staan. Deze header file hebben we nodig om de functie te kunnen gebruiken in Python. ![](https://i.imgur.com/dJiFWHL.png) De afbeelding hieronder is de wrapper file. In deze file maken we gebruik van de pybind11 library. Met deze library kunnen we van de cpp functie omzetten naar python functies. Dit doe we door PYBIND11_MODULE() functie aan te roepen. De eerste variable die je in deze functie tussen haakjes zet is de naam van je Python header file. Deze file importeer je in je Python code. Vervolgens ga je de cpp functie defineren. Je doet dit als volgt. je schrijft eerst m.def(). Tussen haakjes komen dan 3 elementen te staan. De eerste is de naam van de functie in python. Het is logisch om deze een passend de naam te geven. Het tweede element is een reference naar de cpp functie. Deze referenctie kun je aanroepen doordat je de cpp header file kan aanroepen in de source code. ![](https://i.imgur.com/tS6Cqpq.png) ### Calling the functions Om een functie aan te roepen doe je het volgende. Je import eerst de naam van je Pybind11 module. In dit geval is dit pybind11_example. Dan wanneer je de punt in toest krijg je alle functies te zien die in de file staan. En je dus kunt gebruiken. ![](https://i.imgur.com/cGfvGSO.png) ### Voorbeeld van een Toepassing Een voorbeeld waarneer je gebruik kan maken van de cpp functionaliteit is vaak wanneer je gebruik wil maken van hardware en recursive functie hebt. Als voorbeeld hebben wij de fibonnaci sequence gebruikt. Wij hebben deze gemaakt in cpp en in Python. Omdat c++ veel efficiënter en sneller is dan python kan die de functie ook een stuk sneller uitvoeren. Zoals je kan zien is die in cpp ongeveer 100 keer sneller dan in Python ![](https://i.imgur.com/VnG4xok.png) ### Conclusie Het heeft dus als voordeel dat je op deze manier sommige delen van je code kan verbeteren en sneller kan maken. Ook wordt het mogelijk om code te schrijven voor hardware want cpp is daarvoor een stuk beter geschikt dan Python