Fixed import module for windows and python 3.7

create unit test

CMakeLists.txt

@@ -267,13 +267,6 @@ endif()
 
 add_subdirectory(src)
 
-if(${PROJECT_NAME}_PYTHON_BINDINGS)
-  if(CMAKE_BUILD_TYPE MATCHES "^[Dd]eb" OR ${PROJECT_NAME}_STATIC)
-    message(FATAL_ERROR "** Python Bindings are disabled in debug or static builds.")
-  endif()
-  add_subdirectory(python)
-endif()
-
 if(${PROJECT_NAME}_IS_ROOT_PROJECT)
   if(${PROJECT_NAME}_EXAMPLES)
     if(${PROJECT_NAME}_QTQUICK)
@@ -339,4 +332,11 @@ if(${PROJECT_NAME}_IS_ROOT_PROJECT)
   include(ECMUninstallTarget)
 endif()
 
+if(${PROJECT_NAME}_PYTHON_BINDINGS)
+  if(CMAKE_BUILD_TYPE MATCHES "^[Dd]eb" OR ${PROJECT_NAME}_STATIC)
+    message(FATAL_ERROR "** Python Bindings are disabled in debug or static builds.")
+  endif()
+  add_subdirectory(python)
+endif()
+
 feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)

cmake/KDAB/modules/PySide2ModuleBuild.cmake

@@ -130,6 +130,11 @@ macro(CREATE_PYTHON_BINDINGS
             OUTPUT_NAME ${MODULE_NAME}
             LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR}
         )
+        if(APPLE)
+            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
+        elseif(NOT WIN32) #ie. linux
+            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+        endif()
 
         if(WIN32)
             set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")

cmake/KDAB/modules/PySide6ModuleBuild.cmake

@@ -130,6 +130,11 @@ macro(CREATE_PYTHON_BINDINGS
             OUTPUT_NAME ${MODULE_NAME}
             LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR}
         )
+        if(APPLE)
+            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
+        elseif(NOT WIN32) #ie. linux
+            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+        endif()
 
         if(WIN32)
             set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")

python/CMakeLists.txt

@@ -39,3 +39,4 @@ set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX "${${PROJECT_NAME}_PYTHON_BIN
 
 include(PySide${PYSIDE_MAJOR_VERSION}ModuleBuild)
 add_subdirectory(PyKDDockWidgets)
+add_subdirectory(tests)

python/PyKDDockWidgets/CMakeLists.txt

@@ -81,5 +81,19 @@ create_python_bindings(
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/__init__.py.cmake ${CMAKE_CURRENT_BINARY_DIR}/__init__.py @ONLY)
 
 # install
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/__init__.py
+install(
-    DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX})
+  FILES
+    ${CMAKE_CURRENT_BINARY_DIR}/__init__.py
+    $<TARGET_FILE:KDAB::kddockwidgets>
+  DESTINATION
+    ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
+)
+if(NOT WIN32)
+  install(
+    FILES
+        $<TARGET_LINKER_FILE:KDAB::kddockwidgets>
+        $<TARGET_SONAME_FILE:KDAB::kddockwidgets>
+    DESTINATION
+        ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
+  )
+endif()

python/PyKDDockWidgets/__init__.py.cmake

@@ -10,9 +10,21 @@
 #
 
 import sys
+import os
 
 __all__ = ['KDDockWidgets']
 
+def setupLibraryPath():
+    package_dir = os.path.abspath(os.path.dirname(__file__))
+    if sys.platform != 'win32':
+        return
+
+    if sys.version_info[0] == 3 and sys.version_info[1] >= 8:
+        os.add_dll_directory(package_dir)
+        return
+
+    os.environ['PATH'] = os.fspath(package_dir) + os.pathsep + os.environ['PATH']
+
 # Preload PySide libraries to avoid missing libraries while loading KDDockWidgets
 try:
     from PySide@PYSIDE_MAJOR_VERSION@ import QtCore
@@ -22,3 +34,17 @@ try:
 except Exception:
     print("Failed to load PySide")
     raise
+
+setupLibraryPath()
+
+
+#
+# This file is part of KDDockWidgets.
+#
+# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
+#
+# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
+#
+# Contact KDAB at <info@kdab.com> for commercial licensing options.
+#

python/examples-qt6/main.py

@@ -15,7 +15,7 @@ from MyMainWindow import MyMainWindow
 from PySide6 import QtWidgets, QtCore
 
 import sys
-import rc_assets
+#import rc_assets
 
 if __name__ == "__main__":
     QtWidgets.QApplication.setAttribute(QtCore.Qt.AA_EnableHighDpiScaling)

python/tests/CMakeLists.txt

@@ -0,0 +1,40 @@
+#
+# This file is part of KDDockWidgets.
+#
+# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
+#
+# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
+#
+# Contact KDAB at <info@kdab.com> for commercial licensing options.
+#
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.py.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.py @ONLY)
+
+set(TEST_PYTHONPATH
+    ${CMAKE_BINARY_DIR}/python
+    ${CMAKE_CURRENT_BINARY_DIR}
+)
+set(TEST_LIBRARYPATH ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
+
+if(WIN32)
+   set(TEST_LIBRARY_VAR "PATH")
+   string(REPLACE "\\" "/" TEST_PYTHONPATH "${TEST_PYTHONPATH}")
+   string(REPLACE "\\" "/" TEST_LIBRARYPATH "${TEST_LIBRARYPATH}")
+   list(JOIN TEST_PYTHONPATH "\\;" TEST_PYTHONPATH)
+   list(JOIN TEST_LIBRARYPATH "\\;" TEST_LIBRARYPATH)
+else()
+   set(TEST_LIBRARY_VAR "LD_LIBRARY_PATH")
+   list(JOIN TEST_PYTHONPATH ":" TEST_PYTHONPATH)
+   list(JOIN TEST_LIBRARYPATH ":" TEST_LIBRARYPATH)
+endif()
+
+set(PYTHON_ENV_COMMON "PYTHONPATH=${TEST_PYTHONPATH};${TEST_LIBRARY_VAR}=${TEST_LIBRARYPATH}")
+
+file(GLOB TEST_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tst_*.py)
+foreach(test_file ${TEST_FILES})
+    get_filename_component(test_name ${test_file} NAME_WE)
+    add_test(${test_name} ${Python3_EXECUTABLE} ${test_file})
+    set_tests_properties(${test_name} PROPERTIES ENVIRONMENT "${PYTHON_ENV_COMMON}")
+endforeach()
+

python/tests/config.py.cmake

@@ -0,0 +1,2 @@
+class TstConfig(object):
+    bindingsNamespace = "@PYTHON_BINDING_NAMESPACE@"

python/tests/tst_importModule.py

@@ -0,0 +1,19 @@
+import unittest
+import importlib
+import inspect
+
+from config import TstConfig
+
+class TestImportModules(unittest.TestCase):
+    def test_importModules(self):
+        m = importlib.import_module(TstConfig.bindingsNamespace + '.KDDockWidgets')
+        moduleSymbols = []
+        for t in inspect.getmembers(m):
+            moduleSymbols.append(t[0])
+
+        symbols = ['MainWindow', 'DockWidget']
+        for symbol in symbols:
+            self.assertIn(symbol, moduleSymbols)
+
+if __name__ == '__main__':
+    unittest.main()