Fix introduction of no stable API (#267)

richiware · web-flow · commit ab533a875b4f · 2025-10-10T12:37:54.000+02:00
* Refs #23483. Fix stable api

Signed-off-by: Ricardo González Moreno &lt;ricardo@richiware.dev&gt;

* Refs #23483. Add github workflow

Signed-off-by: Ricardo González Moreno &lt;ricardo@richiware.dev&gt;

* Refs #23483. Support swig-version

Signed-off-by: Ricardo González Moreno &lt;ricardo@richiware.dev&gt;

* Refs #23483. Fix type resolution up to swig 4.2.0

Signed-off-by: Ricardo González Moreno &lt;ricardo@richiware.dev&gt;

---------

Signed-off-by: Ricardo González Moreno &lt;ricardo@richiware.dev&gt;
diff --git a/.github/workflows/reusable-windows-ci.yml b/.github/workflows/reusable-windows-ci.yml
@@ -25,6 +25,11 @@ on:
         description: 'Extra arguments for cmake cli'
         required: false
         type: string
+      cmake-version:
+        description: 'CMake version to install'
+        required: false
+        default: '3.24.4'
+        type: string
       ctest-args:
         description: 'Extra arguments for ctest cli'
         required: false
@@ -52,6 +57,11 @@ on:
         required: false
         type: boolean
         default: true
+      swig-version:
+        description: 'SWIG version to install'
+        required: false
+        default: '4.0.2.04082020'
+        type: string
 env:
   colcon-build-default-cmake-args: '-DTHIRDPARTY_Asio=FORCE -DTHIRDPARTY_TinyXML2=FORCE -DTHIRDPARTY_fastcdr=OFF -DTHIRDPARTY_UPDATE=ON -DEPROSIMA_EXTRA_CMAKE_CXX_FLAGS="/MP /WX"'
 defaults:
@@ -91,7 +101,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.24.4'
+          cmakeVersion: ${{ inputs.cmake-version }}
 
       - name: Install OpenSSL
         uses: eProsima/eprosima-CI/windows/install_openssl@v0
@@ -129,7 +139,7 @@ jobs:
 
       - name: Install swig
         shell: pwsh
-        run: choco install swig --allow-downgrade --version=4.0.2.04082020
+        run: choco install swig --allow-downgrade --version=${{ inputs.swig-version }}
 
       - name: Get Fast CDR branch
         id: get_fastcdr_branch
@@ -210,7 +220,7 @@ jobs:
       - name: Get minimum supported version of CMake
         uses: eProsima/eProsima-CI/external/get-cmake@v0
         with:
-          cmakeVersion: '3.24.4'
+          cmakeVersion: ${{ inputs.cmake-version }}
 
       - name: Install OpenSSL
         uses: eProsima/eprosima-CI/windows/install_openssl@v0
@@ -248,7 +258,7 @@ jobs:
 
       - name: Install swig
         shell: pwsh
-        run: choco install swig --allow-downgrade --version=4.0.2.04082020
+        run: choco install swig --allow-downgrade --version=${{ inputs.swig-version }}
 
       - name: Install doxygen
         uses: eProsima/eProsima-CI/external/install_doxygen@v0
diff --git a/.github/workflows/windows-ci.yml b/.github/workflows/windows-ci.yml
@@ -69,3 +69,24 @@ jobs:
       fastdds-branch: ${{ inputs.fastdds-branch || 'master' }}
       run-build: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'skip-ci') }}
       run-tests: ${{ (inputs.run-tests == true) || ((github.event_name == 'pull_request') && (!contains(github.event.pull_request.labels.*.name, 'no-test'))) }}
+
+  windows-ci-stable-abi:
+    if: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'conflicts') }}
+    strategy:
+      fail-fast: false
+    uses: ./.github/workflows/reusable-windows-ci.yml
+    with:
+      # It would be desirable to have a matrix of windows OS for this job, but due to the issue opened in this ticket:
+      # https://github.com/orgs/community/discussions/128118 , it has been set as a single OS job.
+      os-version: ${{ inputs.os-version || 'windows-2022' }}
+      vs-toolset: 'v143'
+      label: '${{ inputs.os-version }}-${{ matrix.vs-toolset }}-stable-api-ci-${{ inputs.fastdds-python-branch }}-${{ inputs.fastdds-branch }}'
+      colcon-args: ${{ inputs.colcon-args }}
+      cmake-args: '${{ inputs.cmake-args }} -DUSE_PYTHON_STABLE_ABI=ON'
+      cmake-version: '3.30.8'
+      ctest-args: ${{ inputs.ctest-args }}
+      fastdds-python-branch: ${{ inputs.fastdds-python-branch || github.ref }}
+      fastdds-branch: ${{ inputs.fastdds-branch || 'master' }}
+      run-build: ${{ !(github.event_name == 'pull_request') || !contains(github.event.pull_request.labels.*.name, 'skip-ci') }}
+      run-tests: ${{ (inputs.run-tests == true) || ((github.event_name == 'pull_request') && (!contains(github.event.pull_request.labels.*.name, 'no-test'))) }}
+      swig-version: '4.3.1'
diff --git a/fastdds_python/src/swig/fastdds.i b/fastdds_python/src/swig/fastdds.i
@@ -106,8 +106,13 @@ bool has_statistics();
 #define FASTDDS_DEPRECATED_UNTIL(major, entity_name, msg)
 #define FASTDDS_TODO_BEFORE(major, minor, msg)
 
-// Defined template for std::vector<std::string>
+// Defined template for some vector containers.
 %template(StringVector) std::vector<std::string>;
+%template(uint8_t_vector) std::vector<uint8_t>;
+%template(uint16_t_vector) std::vector<uint16_t>;
+%template(int32_t_vector) std::vector<int32_t>;
+%template(uint32_t_vector) std::vector<uint32_t>;
+%template(uint64_t_vector) std::vector<uint64_t>;
 
 // Predeclaration of namespaces and/or classes not exported to the target language,
 // but that are part of the Fast DDS public API
diff --git a/fastdds_python/src/swig/fastdds/rtps/common/InstanceHandle.i b/fastdds_python/src/swig/fastdds/rtps/common/InstanceHandle.i
@@ -50,9 +50,9 @@ long hash(const eprosima::fastdds::rtps::InstanceHandle_t& handle)
 
         // Fast-path: bytes
         if (PyBytes_Check(seq)) {
-            if (PyBytes_GET_SIZE(seq) == 16)
+            if (PyBytes_Size(seq) == 16)
             {
-                const char* b = PyBytes_AS_STRING(seq);
+                const char* b = PyBytes_AsString(seq);
                 for (int i = 0; i < 16; ++i) (*self)[i] = (uint8_t)(unsigned char)b[i];
             }
             else
@@ -65,9 +65,9 @@ long hash(const eprosima::fastdds::rtps::InstanceHandle_t& handle)
         // Fast-path: bytearray
         else if (PyByteArray_Check(seq))
         {
-            if (PyByteArray_GET_SIZE(seq) == 16)
+            if (PyByteArray_Size(seq) == 16)
             {
-                const char* b = PyByteArray_AS_STRING(seq);
+                const char* b = PyByteArray_AsString(seq);
                 for (int i = 0; i < 16; ++i) (*self)[i] = (uint8_t)(unsigned char)b[i];
             }
             else

Original file line number	Diff line number	Diff line change
`@@ -50,9 +50,9 @@ long hash(const eprosima::fastdds::rtps::InstanceHandle_t& handle)`
`50`	`50`
`51`	`51`	`// Fast-path: bytes`
`52`	`52`	`if (PyBytes_Check(seq)) {`
`53`		`- if (PyBytes_GET_SIZE(seq) == 16)`
	`53`	`+ if (PyBytes_Size(seq) == 16)`
`54`	`54`	`{`
`55`		`- const char* b = PyBytes_AS_STRING(seq);`
	`55`	`+ const char* b = PyBytes_AsString(seq);`
`56`	`56`	`for (int i = 0; i < 16; ++i) (*self)[i] = (uint8_t)(unsigned char)b[i];`
`57`	`57`	`}`
`58`	`58`	`else`
`@@ -65,9 +65,9 @@ long hash(const eprosima::fastdds::rtps::InstanceHandle_t& handle)`
`65`	`65`	`// Fast-path: bytearray`
`66`	`66`	`else if (PyByteArray_Check(seq))`
`67`	`67`	`{`
`68`		`- if (PyByteArray_GET_SIZE(seq) == 16)`
	`68`	`+ if (PyByteArray_Size(seq) == 16)`
`69`	`69`	`{`
`70`		`- const char* b = PyByteArray_AS_STRING(seq);`
	`70`	`+ const char* b = PyByteArray_AsString(seq);`
`71`	`71`	`for (int i = 0; i < 16; ++i) (*self)[i] = (uint8_t)(unsigned char)b[i];`
`72`	`72`	`}`
`73`	`73`	`else`