macOS: improve bpy build system support #86579

Fix documentation on the wiki that causes issue like in blender/blender-addons#58069 (done in https://wiki.blender.org/w/index.php?title=Building_Blender%2FOther%2FBlenderAsPyModule&type=revision&diff=22721&oldid=20461)
Fix build and import issues with OpenMP (D10657: macOS/bpy: add support for OpenMP)
Install to correct place automatically (D10664: macOS/bpy: install to site-packages + 241f05d53c)
Verify the correctness of installation ( using tests ?) (D10665: Tests/bpy: Add installation verification test)
Disable python tests which need Blender executable, thus will not work with bpy.so. (D10656: Tests: disable python tests for bpy module)
Fix error - with Address Sanitizer. (D10877: macOS/bpy: Fix error in builds with Address Sanitizer)
Install license and ~~some PDFs~~ (Icon PDFs aren't needed for bpy.so I guess) at correct place. See F12865679 (D14111: bpy module: install scripts and text files relative to bpy.so)
Tweak "Blender successfully built.." message

[1]

ERROR: Interceptors are not working. This may be because AddressSanitizer is loaded too late (e.g. via dlopen). Please launch the executable with:
DYLD_INSERT_LIBRARIES=/path/to/libclang_rt.asan_osx_dynamic.dylib

Changed status from 'Needs Triage' to: 'Confirmed'

Added subscriber: @ankitm

Added subscriber: @brecht

Not specific to macOS, but it would be good if we could avoid installing a Resources folder in the top level site-packages. Ideally both the dynamic library and other files should be in a bpy/ folder.

This issue was referenced by ad31b13f91

This issue was referenced by 0ec82477af

This issue was referenced by fbe2c3f422

This issue was referenced by a702ca3faa

Added subscriber: @Yuri-Teixeira

Hello 👋 The issue https://developer.blender.org/T58069 seems to persist in v3.0.1 (see attached log):

build-bpy.log

Environment info:

MacOS 12.2
Python 3.9

Let me know if you need more detail, please.

Thank you in advance!

@Yuri-Teixeira do you have some environment variable interfering with module discovery ? It seems that the one built in build_darwin_bpy/bin/ is taking priority over the one installed in /Library/Frameworks/Python.framework

@Yuri-Teixeira also apply D14110 to your code and see if there's any helpful info.

EDIT also suggest opening a new bug report for further discussion.

Added subscriber: @ideasman42

Re: Remove "Blender successfully built.." message

-- Install configuration: "Release"

Edit build configuration with: "/src/build_linux_bpy_lite/CMakeCache.txt" run make again to rebuild.
Blender successfully built as a Python module, "bpy" can be imported from: /src/build_linux_bpy_lite/bin

It seems the only remaining issue is using ASAN, unless someone on macOS is interested to investigate a solution, we could disable the combination.

Suggest: P3220: (An Untitled Masterwork)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index d8adf6c396f..9d369d2d453 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1296,6 +1296,15 @@ if(WITH_PYTHON_MODULE)
     message(STATUS "GTests not compatible with Python module, disabling WITH_GTESTS")
     set(WITH_GTESTS OFF)
   endif()
+  if(APPLE)
+    if(WITH_COMPILER_ASAN)
+      message(STATUS
+        "ASAN is not compatible with Python module on APPLE, "
+        "disabling WITH_COMPILER_ASAN"
+      )
+      set(WITH_COMPILER_ASAN OFF)
+    endif()
+  endif()
 endif()

Changed status from 'Confirmed' to: 'Resolved'

I committed a fix for the asan issue based on a patch by @ankitm, I think we can consider this task resolved now.

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

macOS: improve bpy build system support #86579