From 3c8c9079ffb4f614c4362e2ccc7c37ff399da111 Mon Sep 17 00:00:00 2001
From: Steve Peters <scpeters@openrobotics.org>
Date: Wed, 31 Jan 2024 13:34:04 -0800
Subject: [PATCH] Fix find Python3 logic and macOS workflow (#1367)

* Find Python3 with find_package instead of GzPython,
  adapting the approach from gz-sim.
* macos workflow: use brew --prefix, not /usr/local
* macos workflow: set Python3_EXECUTABLE cmake var

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
---
 .github/workflows/macos.yml | 14 +++++------
 CMakeLists.txt              | 49 +++++++++++++++++++------------------
 2 files changed, 32 insertions(+), 31 deletions(-)

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
index 61ed88383..82b7debb3 100644
--- a/.github/workflows/macos.yml
+++ b/.github/workflows/macos.yml
@@ -19,11 +19,11 @@ jobs:
     # Workaround for https://github.com/actions/setup-python/issues/577
     - name: Clean up python binaries
       run: |
-        rm -f /usr/local/bin/2to3*;
-        rm -f /usr/local/bin/idle3*;
-        rm -f /usr/local/bin/pydoc3*;
-        rm -f /usr/local/bin/python3*;
-        rm -f /usr/local/bin/python3*-config;
+        rm -f $(brew --prefix)/bin/2to3*;
+        rm -f $(brew --prefix)/bin/idle3*;
+        rm -f $(brew --prefix)/bin/pydoc3*;
+        rm -f $(brew --prefix)/bin/python3*;
+        rm -f $(brew --prefix)/bin/python3*-config;
     - name: Install base dependencies
       env:
         HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
@@ -50,8 +50,8 @@ jobs:
     - name: cmake
       working-directory: build
       run: |
-        export PYTHONPATH=$PYTHONPATH:/usr/local/lib/python
-        cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/Cellar/${PACKAGE}/HEAD
+        export PYTHONPATH=$PYTHONPATH:$(brew --prefix)/lib/python
+        cmake .. -DCMAKE_INSTALL_PREFIX=$(brew --prefix)/Cellar/${PACKAGE}/HEAD -DPython3_EXECUTABLE=$(brew --prefix)/bin/python3
     - run: make
       working-directory: build
     - run: make test
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 14aa4fb32..be6e4394e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -78,9 +78,33 @@ if (BUILD_SDF)
   # available during build time
   set(GZ_TOOLS_VER 2)
 
+  #################################################
+  # Find python
+  if (SKIP_PYBIND11)
+    message(STATUS "SKIP_PYBIND11 set - disabling python bindings")
+    find_package(Python3 REQUIRED COMPONENTS Interpreter)
+  else()
+    find_package(Python3 REQUIRED
+      COMPONENTS Interpreter
+      OPTIONAL_COMPONENTS Development
+    )
+    if (NOT Python3_Development_FOUND)
+      GZ_BUILD_WARNING("Python development libraries are missing: Python interfaces are disabled.")
+    else()
+      set(PYBIND11_PYTHON_VERSION 3)
+      find_package(pybind11 2.4 CONFIG QUIET)
+
+      if (pybind11_FOUND)
+        message (STATUS "Searching for pybind11 - found version ${pybind11_VERSION}.")
+      else()
+        GZ_BUILD_WARNING("pybind11 is missing: Python interfaces are disabled.")
+        message (STATUS "Searching for pybind11 - not found.")
+      endif()
+    endif()
+  endif()
+
   #################################################
   # Copied from catkin/cmake/empy.cmake
-  include(GzPython)
   function(find_python_module module)
     # cribbed from http://www.cmake.org/pipermail/cmake/2011-January/041666.html
     string(TOUPPER ${module} module_upper)
@@ -121,29 +145,6 @@ if (BUILD_SDF)
   gz_find_package(gz-utils3 REQUIRED COMPONENTS cli)
   set(GZ_UTILS_VER ${gz-utils3_VERSION_MAJOR})
 
-  ########################################
-  # Python interfaces
-  if (NOT PYTHON3_FOUND)
-    GZ_BUILD_ERROR("Python is missing - Needed to build/embed xml schemas")
-  else()
-    message (STATUS "Searching for Python - found version ${Python3_VERSION}.")
-
-    if (SKIP_PYBIND11)
-      message(STATUS "SKIP_PYBIND11 set - disabling python bindings")
-    else()
-      set(PYBIND11_PYTHON_VERSION 3)
-      find_package(pybind11 2.4 QUIET)
-
-      if (${pybind11_FOUND})
-        find_package(Python3 ${GZ_PYTHON_VERSION} REQUIRED COMPONENTS Development)
-        message (STATUS "Searching for pybind11 - found version ${pybind11_VERSION}.")
-      else()
-        GZ_BUILD_WARNING("pybind11 is missing: Python interfaces are disabled.")
-        message (STATUS "Searching for pybind11 - not found.")
-      endif()
-    endif()
-  endif()
-
   gz_configure_build(QUIT_IF_BUILD_ERRORS)
 
   gz_create_packages()