sweetPy is a seamless binding library, intended to export your C++ code with ease into Python 3.
The library was only tested as of now on Python 3.7.
sweetPy will allow you to export your C++ code in an object oriented style, with out the need to learn python’s data model and C-API.
sweetPy is written in C++14, it is officially based upon the gnu compiler, version - 5.4.0.
Its using CMake as its higher echelon build system, version 3.0 and higher.
The code is fully portable, but officially it was only tested in linux environment, tho a windows build is also a possibility, only limited by a matching support of visual c++.
Gnu - version 5.0 and higher.
CMake - version 3.0 and higher.
Python - version 3.7.
GoogleTest - version 1.8.0 and higher - not mandatory.
GoogleTest will be fetched automatically on need.
sweetPy instalment is based upon two phases:
- Resolving all 3rd party dependencies.
- Compilation of sweetPy, its examples and if requested - its tests.
| Argument | Description |
|---|---|
| sweetPy_3RD_PARTY_INSTALL_STEP - Mandatory | 3rd parties installation step |
| sweetPy_Test_Support - Optional | Will install the google test package |
In sweetPy root directory:
cmake . -DsweetPy_3RD_PARTY_INSTALL_STEP=ON -DsweetPy_Test_Support=ON && make
| Argument | Description |
|---|---|
| sweetPy_COMPILE_STEP - Mandatory | Will compile sweetPy and its example |
| sweetPy_Test_Support - Optional | Will compile sweetPy tests |
In sweetPy root directory:
cmake . -DsweetPy_COMPILE_STEP=ON -DsweetPy_Test_Support=ON && make
The binary product of sweetPy is a shared object file located at - In sweetPy root directory:
./bin/libsweetPy.so
In order to run sweetPy tests, just run the following command, from sweetPy root directory:
./Tests/bin/sweetPyTests
sweetPy binds the following C++ language capabilities, into python:
- Exporting user types.
- Exporting Enums.
- User types supports:
- User defined constructor.
- User defined destructor.
- Invocation of an overridden function from python side.
- Member functions.
- Overloaded Member functions are supported, must have unique name.
- Members - both const and not (for read and write permission).
- static member functions.
- Functions:
- Overloading is supported with explicit cast.
- Reference types:
- Invocation upon reference types.
- Accessing reference types members.
- Invocation of global functions.
- Exporting global variables.
- Seamless transition between python builtin types into your C++ code.
- Seamless transition between C++ POD types and user defined types into python.