[lldb/Python] Add lldbconfig Python module to make the lldb module configurable.

[JDevlieghere]

Summary

Using the approach described in [1] and suggested by Pavel D77588 , this patch introduces a new lldbconfig module that lives next to the lldb module. It makes it possible to make the lldb module configurable. More specifically it makes it possible to delay initializing the debugger, which is needed for testing the reproducer.

I chose to name the module lldbconfig rather than lldb.config because I thought it would be weird to import a "submodule" before the main module, but if anyone feels the other approach is more desirable I'd be happy to change it.

[1] https://stackoverflow.com/questions/3720740/pass-variable-on-import/39360070#39360070

[JDevlieghere]

lldb/packages/Python/lldbsuite/test/dotest.py

957

This is a NO-OP for now, but just shows that we can load the lldbconfig module.

[labath]

Thanks. This looks fine, just a question about the placement of the lldbconfig module.

lldb/CMakeLists.txt

130

If we're not going to ship this file, should we place it under packages/Python/... (I'm sure there is some place we could put it where it would already be in sys.path ? That way it would not be accessible from regular lldb runs, only for those from dotest, which would decrease the likelyhood of lldb suddenly stopping to work after being installed.

lldb/bindings/python.swig

131

Maybe _initialize (the convention for "private" variables in python)?

[JDevlieghere]

Address code review feedback

[labath]

Let's see how this goes.

lldb/CMakeLists.txt

if(LLDB_INCLUDE_TESTS)
   add_subdirectory(unittests)
   add_subdirectory(utils)
 endif()
 
 if (LLDB_ENABLE_PYTHON)
   get_target_property(lldb_bindings_dir swig_wrapper BINARY_DIR)
 
   if(LLDB_BUILD_FRAMEWORK)
-    set(lldb_python_build_path "${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}/LLDB.framework/Resources/Python/lldb")
+    set(python_build_path "${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}/LLDB.framework/Resources/Python")
   else()
-    set(lldb_python_build_path "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${LLDB_PYTHON_RELATIVE_PATH}/lldb")
+    set(python_build_path "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${LLDB_PYTHON_RELATIVE_PATH}")
   endif()
 
+  set(lldb_python_build_path "${python_build_path}/lldb")
+
   # Add a Post-Build Event to copy over Python files and create the symlink
   # to liblldb.so for the Python API(hardlink on Windows).
   add_custom_target(finish_swig ALL VERBATIM
     COMMAND ${CMAKE_COMMAND} -E make_directory ${lldb_python_build_path}
     DEPENDS ${lldb_bindings_dir}/lldb.py
     COMMENT "Python script sym-linking LLDB Python API")
 
   if(NOT LLDB_USE_SYSTEM_SIX)
     add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
       COMMAND ${CMAKE_COMMAND} -E copy
         "${LLDB_SOURCE_DIR}/third_party/Python/module/six/six.py"
-        "${lldb_python_build_path}/../six.py")
+        "${python_build_path}/six.py")
   endif()
 
   add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
+    COMMAND ${CMAKE_COMMAND} -E make_directory
+      "${python_build_path}/lldbconfig")
+
+  add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
+    COMMAND ${CMAKE_COMMAND} -E copy
+      "${LLDB_SOURCE_DIR}/bindings/python/lldbconfig.py"
+      "${python_build_path}/lldbconfig/__init__.py")
+
+  add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
     COMMAND ${CMAKE_COMMAND} -E copy
       "${lldb_bindings_dir}/lldb.py"
       "${lldb_python_build_path}/__init__.py")
 
+
   function(create_python_package pkg_dir)
     cmake_parse_arguments(ARG "NOINIT" "" "FILES" ${ARGN})
     if(ARG_FILES)
       set(copy_cmd COMMAND ${CMAKE_COMMAND} -E copy ${ARG_FILES} ${pkg_dir})
     endif()
     if(NOT ARG_NOINIT)
       set(init_cmd COMMAND ${PYTHON_EXECUTABLE}
           "${LLDB_SOURCE_DIR}/bindings/python/createPythonInit.py"

lldb/bindings/python.swig

 using namespace lldb;
 %}
 
 %include "./interfaces.swig"
 %include "./python/python-extensions.swig"
 %include "./python/python-wrapper.swig"
 
 %pythoncode%{
+INITIALIZE = True
+try:
+   import lldbconfig
+   INITIALIZE = lldbconfig.INITIALIZE
+except ImportError:
+   pass
 debugger_unique_id = 0
+if INITIALIZE:
    SBDebugger.Initialize()
 debugger = None
 target = None
 process = None
 thread = None
 frame = None
 %}

lldb/bindings/python/lldbconfig.py

+INITIALIZE = True

lldb/packages/Python/lldbsuite/test/dotest.py

def run_suite():
     #
     parseOptionsAndInitTestdirs()
 
     # Setup test results (test results formatter and output handling).
     setupTestResults()
 
     setupSysPath()
 
+    import lldbconfig
     import lldb
+
     # Use host platform by default.
     lldb.selected_platform = lldb.SBPlatform.GetHostPlatform()
 
     # Now we can also import lldbutil
     from lldbsuite.test import lldbutil
 
     if configuration.lldb_platform_name:
         print("Setting up remote platform '%s'" %