Merge pull request #1334 from ekxide/iox2-1333-fix-type-translation-in-python

[#1333] fix type translation in python

Author: elfenpiff

.github/workflows/build-test.yml

@@ -183,11 +183,19 @@ jobs:
   python-bindings:
     needs: [preflight-check, static-code-analysis, cargo-nextest]
     if: ${{ needs.changes.outputs.source-code == 'true' }}
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest,windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # version v6.0.1
 
+      - name: Prepare Windows
+        if: ${{ runner.os == 'Windows' }}
+        run: internal\scripts\ci_prepare_windows.ps1
+
       - name: Prepare Linux
+        if: ${{ runner.os == 'Linux' }}
         run: |
           internal/scripts/ci_prepare_ubuntu.sh
           uname -a
@@ -199,6 +207,10 @@ jobs:
       - run: pip install poetry==2.2.1
       - run: pip install poetry-plugin-shell==1.0.1
 
+      - name: Install Global Plugins # (needed for windows due to separate C:\ and D:\ drives)
+        if: runner.os == 'Windows'
+        run: poetry self add "poethepoet[poetry-plugin]>=0.35.0,<0.36.0"
+
       - name: Install Python Dependencies
         run: poetry --project iceoryx2-ffi/python install
 

doc/release-notes/iceoryx2-unreleased.md

@@ -35,6 +35,8 @@
   [#1312](https://github.com/eclipse-iceoryx/iceoryx2/issues/1312)
 * Bump wheel from 0.45.1 to 0.46.3 in /iceoryx2-ffi/python
   [#1316](https://github.com/eclipse-iceoryx/iceoryx2/issues/1316)
+* Fix Python type translation for integer types (32-bit)
+  [#1333](https://github.com/eclipse-iceoryx/iceoryx2/issues/1333)
 
 ### Refactoring
 

iceoryx2-ffi/python/python-src/iceoryx2/type_name.py

@@ -18,32 +18,84 @@
 T = TypeVar("T")
 
 
-def get_type_name(t: Type[T]) -> Any:
-    """Generates a human readable type name from a given type."""
-    if hasattr(t, "type_name"):
-        return t.type_name()
-
-    if t.__name__ == "c_ubyte" and ctypes.sizeof(t) == 1:
+def _get_unsigned_int_type_name(t: Type[T]) -> Any:
+    """Generates a human readable type name from a given unsigned integer type."""
+    if ctypes.sizeof(t) == 1:
         return "u8"
-    if t.__name__ == "c_ushort" and ctypes.sizeof(t) == 2:
+    if ctypes.sizeof(t) == 2:
         return "u16"
-    if t.__name__ == "c_uint" and ctypes.sizeof(t) == 4:
+    if ctypes.sizeof(t) == 4:
         return "u32"
-    if t.__name__ == "c_ulong" and ctypes.sizeof(t) == 8:
+    if ctypes.sizeof(t) == 8:
         return "u64"
-    if t.__name__ == "c_byte" and ctypes.sizeof(t) == 1:
+    if ctypes.sizeof(t) == 16:
+        return "u128"
+
+    return t.__name__
+
+
+def _get_signed_int_type_name(t: Type[T]) -> Any:
+    """Generates a human readable type name from a given signed integer type."""
+    if ctypes.sizeof(t) == 1:
         return "i8"
-    if t.__name__ == "c_short" and ctypes.sizeof(t) == 2:
+    if ctypes.sizeof(t) == 2:
         return "i16"
-    if t.__name__ == "c_int" and ctypes.sizeof(t) == 4:
+    if ctypes.sizeof(t) == 4:
         return "i32"
-    if t.__name__ == "c_long" and ctypes.sizeof(t) == 8:
+    if ctypes.sizeof(t) == 8:
         return "i64"
-    if t.__name__ == "c_bool":
-        return "bool"
-    if t.__name__ == "c_float" and ctypes.sizeof(t) == 4:
+    if ctypes.sizeof(t) == 16:
+        return "i128"
+
+    return t.__name__
+
+
+def _get_float_type_name(t: Type[T]) -> Any:
+    """Generates a human readable type name from a given float type."""
+    if ctypes.sizeof(t) == 4:
         return "f32"
-    if t.__name__ == "c_double" and ctypes.sizeof(t) == 8:
+    if ctypes.sizeof(t) == 8:
         return "f64"
+    if ctypes.sizeof(t) == 16:
+        return "f128"
+
+    return t.__name__
+
+
+def get_type_name(t: Type[T]) -> Any:
+    """Generates a human readable type name from a given type."""
+    if hasattr(t, "type_name"):
+        return t.type_name()
+
+    if t.__name__ in (
+        "c_ubyte",
+        "c_ushort",
+        "c_uint",
+        "c_ulong",
+        "c_ulonglong",
+        "c_uint8",
+        "c_uint16",
+        "c_uint32",
+        "c_uint64",
+        "size_t",
+    ):
+        return _get_unsigned_int_type_name(t)
+    if t.__name__ in (
+        "c_byte",
+        "c_short",
+        "c_int",
+        "c_long",
+        "c_longlong",
+        "c_int8",
+        "c_int16",
+        "c_int32",
+        "c_int64",
+        "ssize_t",
+    ):
+        return _get_signed_int_type_name(t)
+    if t.__name__ in ("c_float", "c_double", "c_longdouble"):
+        return _get_float_type_name(t)
+    if t.__name__ == "c_bool":
+        return "bool"
 
     return t.__name__

iceoryx2-ffi/python/tests/get_typename_tests.py

@@ -17,30 +17,61 @@
 
 
 def test_type_names_are_translated_correctly() -> None:
-    assert iox2.get_type_name(ctypes.c_ubyte) == "u8"
-    assert iox2.get_type_name(ctypes.c_uint8) == "u8"
+    assert iox2.get_type_name(ctypes.c_bool) == "bool"
+    assert iox2.get_type_name(ctypes.c_float) == "f32"
+    assert iox2.get_type_name(ctypes.c_double) == "f64"
 
-    assert iox2.get_type_name(ctypes.c_ushort) == "u16"
-    assert iox2.get_type_name(ctypes.c_uint16) == "u16"
+    if ctypes.sizeof(ctypes.c_longdouble) == 16:
+        assert iox2.get_type_name(ctypes.c_longdouble) == "f128"
 
-    assert iox2.get_type_name(ctypes.c_uint) == "u32"
-    assert iox2.get_type_name(ctypes.c_uint32) == "u32"
 
-    assert iox2.get_type_name(ctypes.c_ulong) == "u64"
+def test_integer_type_names_are_translated_correctly() -> None:
+    if ctypes.sizeof(ctypes.c_ubyte) == 1:
+        assert iox2.get_type_name(ctypes.c_ubyte) == "u8"
+
+    if ctypes.sizeof(ctypes.c_ushort) == 2:
+        assert iox2.get_type_name(ctypes.c_ushort) == "u16"
+
+    if ctypes.sizeof(ctypes.c_uint) == 4:
+        assert iox2.get_type_name(ctypes.c_uint) == "u32"
+
+    if ctypes.sizeof(ctypes.c_ulong) == 4:
+        assert iox2.get_type_name(ctypes.c_ulong) == "u32"
+    elif ctypes.sizeof(ctypes.c_ulong) == 8:
+        assert iox2.get_type_name(ctypes.c_ulong) == "u64"
+
+    if ctypes.sizeof(ctypes.c_ulonglong) == 8:
+        assert iox2.get_type_name(ctypes.c_ulonglong) == "u64"
+    elif ctypes.sizeof(ctypes.c_ulonglong) == 16:
+        assert iox2.get_type_name(ctypes.c_ulonglong) == "u128"
+
+    if ctypes.sizeof(ctypes.c_byte) == 1:
+        assert iox2.get_type_name(ctypes.c_byte) == "i8"
+
+    if ctypes.sizeof(ctypes.c_short) == 2:
+        assert iox2.get_type_name(ctypes.c_short) == "i16"
+
+    if ctypes.sizeof(ctypes.c_int) == 4:
+        assert iox2.get_type_name(ctypes.c_int) == "i32"
+
+    if ctypes.sizeof(ctypes.c_long) == 4:
+        assert iox2.get_type_name(ctypes.c_long) == "i32"
+    elif ctypes.sizeof(ctypes.c_long) == 8:
+        assert iox2.get_type_name(ctypes.c_long) == "i64"
+
+    if ctypes.sizeof(ctypes.c_longlong) == 8:
+        assert iox2.get_type_name(ctypes.c_longlong) == "i64"
+    elif ctypes.sizeof(ctypes.c_longlong) == 16:
+        assert iox2.get_type_name(ctypes.c_longlong) == "i128"
+
+
+def test_fixed_size_integer_type_names_are_translated_correctly() -> None:
+    assert iox2.get_type_name(ctypes.c_uint8) == "u8"
+    assert iox2.get_type_name(ctypes.c_uint16) == "u16"
+    assert iox2.get_type_name(ctypes.c_uint32) == "u32"
     assert iox2.get_type_name(ctypes.c_uint64) == "u64"
 
-    assert iox2.get_type_name(ctypes.c_byte) == "i8"
     assert iox2.get_type_name(ctypes.c_int8) == "i8"
-
-    assert iox2.get_type_name(ctypes.c_short) == "i16"
     assert iox2.get_type_name(ctypes.c_int16) == "i16"
-
-    assert iox2.get_type_name(ctypes.c_int) == "i32"
     assert iox2.get_type_name(ctypes.c_int32) == "i32"
-
-    assert iox2.get_type_name(ctypes.c_long) == "i64"
     assert iox2.get_type_name(ctypes.c_int64) == "i64"
-
-    assert iox2.get_type_name(ctypes.c_bool) == "bool"
-    assert iox2.get_type_name(ctypes.c_float) == "f32"
-    assert iox2.get_type_name(ctypes.c_double) == "f64"