Added cmake-arg 'USE_PYTHON_STABLE_ABI' (#250)

* Refs #23483. First approach

Signed-off-by: Ricardo González <ricardo@richiware.dev>

* [#23483] Added cmake-arg 'USE_PYTHON_STABLE_ABI'

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

* [#23483] Added cmake-arg in the tests

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

* [#23483] Added STABLE_ABI configuration to python_examples + modified calculator.i

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

* [#23483] Added 'Development.SABIModule' to all tests

Signed-off-by: danipiza <dpizarrogallego@gmail.com>

* Refs #23483. Improve

Signed-off-by: Ricardo González <ricardo@richiware.dev>

* Refs #23483. Remove from generated code

Signed-off-by: Ricardo González <ricardo@richiware.dev>

* Testing cmake 3.24

Signed-off-by: Ricardo González <ricardo@richiware.dev>

* Refs #23483. Increase cmake_minimum_required

Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>

---------

Signed-off-by: Ricardo González <ricardo@richiware.dev>
Signed-off-by: danipiza <dpizarrogallego@gmail.com>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Co-authored-by: Ricardo González <ricardo@richiware.dev>

Author: Danipiza

.github/workflows/reusable-ubuntu-ci.yml

@@ -88,7 +88,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.22.6'
+          cmakeVersion: '3.24.4'
 
       - name: Install apt dependencies
         uses: eProsima/eProsima-CI/ubuntu/install_apt_packages@v0
@@ -188,7 +188,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.22.6'
+          cmakeVersion: '3.24.4'
 
       - name: Install apt packages
         uses: eProsima/eProsima-CI/ubuntu/install_apt_packages@v0

.github/workflows/reusable-windows-ci.yml

@@ -91,7 +91,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.22.6'
+          cmakeVersion: '3.24.4'
 
       - name: Install OpenSSL
         uses: eProsima/eprosima-CI/windows/install_openssl@v0
@@ -210,7 +210,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.22.6'
+          cmakeVersion: '3.24.4'
 
       - name: Install OpenSSL
         uses: eProsima/eprosima-CI/windows/install_openssl@v0

fastdds_python/CMakeLists.txt

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-cmake_minimum_required(VERSION 3.22)
+cmake_minimum_required(VERSION 3.24)
 
 # SWIG: use standard target name.
 if(POLICY CMP0078)
@@ -53,7 +53,13 @@ endif()
 include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
-find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+option(USE_PYTHON_STABLE_ABI "Generate Fast DDS python against Python Stable ABI" OFF)
+
+if(USE_PYTHON_STABLE_ABI)
+    find_package(Python3 COMPONENTS Interpreter Development.SABIModule REQUIRED)
+else()
+    find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+endif()
 
 find_package(fastcdr REQUIRED)
 find_package(fastdds 3 REQUIRED)

fastdds_python/colcon.pkg

@@ -1,5 +1,5 @@
 {
     "name": "fastdds_python",
     "type": "cmake",
-    "build-dependencies": ["fastdds"]
+    "dependencies": ["fastdds"]
 }

fastdds_python/src/swig/CMakeLists.txt

@@ -59,10 +59,19 @@ endif()
 
 if(MSVC OR MSVC_IDE)
     target_compile_options(${PROJECT_NAME} PRIVATE /bigobj)
+
+    if(USE_PYTHON_STABLE_ABI)
+        target_compile_definitions(${PROJECT_NAME}
+            PRIVATE
+            NOMINMAX
+            Py_LIMITED_API=0x03040000
+        )
+    endif()
+
 endif()
 
 target_link_libraries(${PROJECT_NAME}
-    Python3::Module
+    $<IF:$<BOOL:${USE_PYTHON_STABLE_ABI}>, Python3::SABIModule, Python3::Module>
     fastcdr
     fastdds
     )

fastdds_python/src/swig/fastdds.i

@@ -24,14 +24,18 @@
     std::string err_msg("In method '$symname': ");
 
     PyObject* exc_str = PyObject_GetAttrString(exc, "__name__");
-    err_msg += PyUnicode_AsUTF8(exc_str);
+    PyObject* unicode = PyUnicode_AsUTF8String (exc_str);
+    err_msg += PyBytes_AsString(unicode);
+    Py_XDECREF(unicode);
     Py_XDECREF(exc_str);
 
     if (val != NULL)
     {
       PyObject* val_str = PyObject_Str(val);
+      PyObject* unicode2 = PyUnicode_AsUTF8String (val_str);
       err_msg += ": ";
-      err_msg += PyUnicode_AsUTF8(val_str);
+      err_msg += PyBytes_AsString(unicode);
+      Py_XDECREF(unicode2);
       Py_XDECREF(val_str);
     }
 

fastdds_python/test/types/CMakeLists.txt

@@ -79,6 +79,7 @@ include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
 set(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
 set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
 set(PYTHON_LIBRARIES ${Python3_LIBRARIES})
@@ -191,6 +192,7 @@ include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
 set(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
 set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
 set(PYTHON_LIBRARIES ${Python3_LIBRARIES})
@@ -304,6 +306,7 @@ include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
 set(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
 set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
 set(PYTHON_LIBRARIES ${Python3_LIBRARIES})

fastdds_python_examples/HelloWorldExample/generated_code/CMakeLists.txt

@@ -79,6 +79,7 @@ include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
 set(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
 set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
 set(PYTHON_LIBRARIES ${Python3_LIBRARIES})

fastdds_python_examples/RPCExample/generated_code/CMakeLists.txt

@@ -74,6 +74,7 @@ include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS "")
 
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
 set(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
 set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
 set(PYTHON_LIBRARIES ${Python3_LIBRARIES})