python: add generation of Python stubs

Author: jcarpent

CMakeLists.txt

@@ -27,6 +27,7 @@ SET(CMAKE_VERBOSE_MAKEFILE True)
 # ----------------------------------------------------
 OPTION(INSTALL_DOCUMENTATION "Generate and install the documentation" OFF)
 OPTION(SUFFIX_SO_VERSION "Suffix library name with its version" OFF)
+OPTION(GENERATE_PYTHON_STUBS "Generate the Python stubs associated to the Python library" ON)
 
 IF(DEFINED BUILD_UNIT_TESTS)
   MESSAGE(AUTHOR_WARNING "BUILD_UNIT_TESTS is deprecated. Use BUILD_TESTING instead.\
@@ -150,7 +151,7 @@ SET(${PROJECT_NAME}_SOLVERS_SOURCES
 SET(${PROJECT_NAME}_DECOMPOSITIONS_SOURCES
   src/decompositions/decompositions.cpp
   )
-  
+
 SET(${PROJECT_NAME}_SOURCES
   ${${PROJECT_NAME}_SOLVERS_SOURCES}
   ${${PROJECT_NAME}_DECOMPOSITIONS_SOURCES}
@@ -175,11 +176,11 @@ SET(${PROJECT_NAME}_SOURCES
 )
 
 ADD_LIBRARY(${PROJECT_NAME} SHARED ${${PROJECT_NAME}_SOURCES} ${${PROJECT_NAME}_HEADERS})
-TARGET_INCLUDE_DIRECTORIES(${PROJECT_NAME} 
-  SYSTEM PUBLIC 
-  ${Boost_INCLUDE_DIRS} 
+TARGET_INCLUDE_DIRECTORIES(${PROJECT_NAME}
+  SYSTEM PUBLIC
+  ${Boost_INCLUDE_DIRS}
   ${EIGEN3_INCLUDE_DIR}
-  ${PYTHON_INCLUDE_DIRS} 
+  ${PYTHON_INCLUDE_DIRS}
   ${NUMPY_INCLUDE_DIRS}
   $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
   $<INSTALL_INTERFACE:include>)

python/CMakeLists.txt

@@ -3,30 +3,32 @@
 #
 
 # --- LIBRARY --- #
-SET(PYWRAP ${PROJECT_NAME}_pywrap) 
+SET(PYWRAP ${PROJECT_NAME}_pywrap)
 SET(PYWRAP ${PYWRAP} PARENT_SCOPE)
 
 MAKE_DIRECTORY("${${PROJECT_NAME}_BINARY_DIR}/python/${PROJECT_NAME}")
+include(${PROJECT_SOURCE_DIR}/cmake/stubs.cmake)
 
 ADD_CUSTOM_TARGET(python)
 SET_TARGET_PROPERTIES(python PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD True)
 
 ADD_LIBRARY(${PYWRAP} SHARED main.cpp)
 ADD_DEPENDENCIES(python ${PYWRAP})
-TARGET_LINK_LIBRARIES(${PYWRAP} PUBLIC ${PROJECT_NAME}) 
+TARGET_LINK_LIBRARIES(${PYWRAP} PUBLIC ${PROJECT_NAME})
 # BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS spews conversion warnings from int to long unsigned int.
 # Unfortunately, using literals does not work in a macro. As such, this turns them off for the entire wrapper:
 IF(NOT WIN32)
   TARGET_COMPILE_OPTIONS(${PYWRAP} PRIVATE "-Wno-conversion")
 ENDIF()
 IF(IS_ABSOLUTE ${PYTHON_SITELIB})
-  SET(${PYWRAP}_INSTALL_DIR ${PYTHON_SITELIB}/${PROJECT_NAME})
+  SET(ABSOLUTE_PYTHON_SITELIB ${PYTHON_SITELIB})
 ELSE()
-  SET(${PYWRAP}_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/${PYTHON_SITELIB}/${PROJECT_NAME})
+  SET(ABSOLUTE_PYTHON_SITELIB ${CMAKE_INSTALL_PREFIX}/${PYTHON_SITELIB})
 ENDIF()
+SET(${PYWRAP}_INSTALL_DIR ${ABSOLUTE_PYTHON_SITELIB}/${PROJECT_NAME})
 
 SET_TARGET_PROPERTIES(${PYWRAP}
-  PROPERTIES 
+  PROPERTIES
   PREFIX ""
   SUFFIX ${PYTHON_EXT_SUFFIX}
   OUTPUT_NAME "${PROJECT_NAME}"
@@ -39,7 +41,14 @@ ENDIF()
 
 INSTALL(TARGETS ${PYWRAP} DESTINATION ${${PYWRAP}_INSTALL_DIR})
 
-# --- INSTALL SCRIPTS 
+# --- GENERATE STUBS
+IF(GENERATE_PYTHON_STUBS)
+  LOAD_STUBGEN()
+
+  GENERATE_STUBS(${CMAKE_CURRENT_BINARY_DIR} ${PROJECT_NAME} ${ABSOLUTE_PYTHON_SITELIB})
+ENDIF(GENERATE_PYTHON_STUBS)
+
+# --- INSTALL SCRIPTS
 SET(PYTHON_FILES
   __init__.py
   )