wrap python depdenency check with a CHECK_PYTHON_DEPS option

Signed-off-by: Karl W Schulz <karl.schulz@amd.com> [ROCm/rocprofiler-compute commit: 3fca4bf511]
2024-04-18 11:06:27 -05:00
commit 16f41ba182
@@ -55,70 +55,73 @@ if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
 endif()
 message(STATUS "Installation path: ${CMAKE_INSTALL_PREFIX}")

-# Python 3 is required
-message(STATUS "Detecting Python interpreter...")
-find_package(
-    Python3 3.8
-    COMPONENTS Interpreter
-    REQUIRED)
+option(CHECK_PYTHON_DEPS "Verify necessary python dependencies" ON)
+if(CHECK_PYTHON_DEPS)
+    # Python 3 is required
+    message(STATUS "Detecting Python interpreter...")
+    find_package(
+        Python3 3.8
+        COMPONENTS Interpreter
+        REQUIRED)
+
+    # Allow user-provided python search path
+    if(DEFINED PYTHON_DEPS)
+        set(ENV{PYTHONPATH} "${PYTHON_DEPS}")
+        message(STATUS "Optional PYTHON_DEPS provided:")
+        list(APPEND CMAKE_MESSAGE_INDENT "  ")
+        message(STATUS "including ${PYTHON_DEPS} in search path")
+        list(POP_BACK CMAKE_MESSAGE_INDENT)
+    endif()
+
+    # Check required Python packages
+    file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt" pythonDeps)
+
+    message(STATUS "Checking for required Python package dependencies...")
+    set_property(GLOBAL PROPERTY pythonDepsFlag "groovy")
+
+    function(checkPythonPackage [package])
+        # mapping for non-default package names
+        set(PACKAGE ${ARGV0})
+        if(${ARGV0} STREQUAL "pyyaml")
+            set(PACKAGE "yaml")
+        endif()
+        execute_process(
+            COMMAND ${Python3_EXECUTABLE} -c "import ${PACKAGE}"
+            OUTPUT_QUIET ERROR_QUIET
+            RESULT_VARIABLE EXIT_CODE)
+        if(${EXIT_CODE} EQUAL 0)
+            message(STATUS "${ARGV0} = yes")
+        else()
+            message(STATUS "${ARGV0} = missing")
+            set_property(GLOBAL PROPERTY pythonDepsFlag "missing")
+        endif()
+    endfunction()

-# Allow user-provided python search path
-if(DEFINED PYTHON_DEPS)
-    set(ENV{PYTHONPATH} "${PYTHON_DEPS}")
-    message(STATUS "Optional PYTHON_DEPS provided:")
    list(APPEND CMAKE_MESSAGE_INDENT "  ")
-    message(STATUS "including ${PYTHON_DEPS} in search path")
+    foreach(package IN LISTS pythonDeps)
+        # Filter out any version requirements from requirements.txt
+        string(REGEX REPLACE "[><=].*" "" package "${package}")
+        string(REPLACE "-" "_" package "${package}")
+        checkpythonpackage(${package})
+    endforeach()
    list(POP_BACK CMAKE_MESSAGE_INDENT)
-endif()

-# Check required Python packages
-file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt" pythonDeps)
-
-message(STATUS "Checking for required Python package dependencies...")
-set_property(GLOBAL PROPERTY pythonDepsFlag "groovy")
-
-function(checkPythonPackage [package])
-    # mapping for non-default package names
-    set(PACKAGE ${ARGV0})
-    if(${ARGV0} STREQUAL "pyyaml")
-        set(PACKAGE "yaml")
-    endif()
-    execute_process(
-        COMMAND ${Python3_EXECUTABLE} -c "import ${PACKAGE}"
-        OUTPUT_QUIET ERROR_QUIET
-        RESULT_VARIABLE EXIT_CODE)
-    if(${EXIT_CODE} EQUAL 0)
-        message(STATUS "${ARGV0} = yes")
+    get_property(pythonDepsInstalled GLOBAL PROPERTY pythonDepsFlag)
+    if(${pythonDepsInstalled} STREQUAL "groovy")
+        message(STATUS "OK: Python dependencies available in current environment.")
    else()
-        message(STATUS "${ARGV0} = missing")
-        set_property(GLOBAL PROPERTY pythonDepsFlag "missing")
+        message(
+            FATAL_ERROR
+                "\nNecessary Python package dependencies not found. Please install required dependencies "
+                "above using your favorite package manager. If using pip, consider running:\n"
+                "python3 -m pip install -r requirements.txt\n"
+                "at the top-level of this repository. If preparing a shared installation for "
+                "multiple users, consider adding the -t <target-dir> option to install necessary dependencies "
+                "into a shared directory, e.g.\n"
+                "python3 -m pip install -t <shared-install-path> -r requirements.txt\n"
+                "Note that the -DPYTHON_DEPS=<shared-install-path> can be used to provide an "
+                "additional search path to cmake for python packages.")
    endif()
-endfunction()
-
-list(APPEND CMAKE_MESSAGE_INDENT "  ")
-foreach(package IN LISTS pythonDeps)
-    # Filter out any version requirements from requirements.txt
-    string(REGEX REPLACE "[><=].*" "" package "${package}")
-    string(REPLACE "-" "_" package "${package}")
-    checkpythonpackage(${package})
-endforeach()
-list(POP_BACK CMAKE_MESSAGE_INDENT)
-
-get_property(pythonDepsInstalled GLOBAL PROPERTY pythonDepsFlag)
-if(${pythonDepsInstalled} STREQUAL "groovy")
-    message(STATUS "OK: Python dependencies available in current environment.")
-else()
-    message(
-        FATAL_ERROR
-            "\nNecessary Python package dependencies not found. Please install required dependencies "
-            "above using your favorite package manager. If using pip, consider running:\n"
-            "python3 -m pip install -r requirements.txt\n"
-            "at the top-level of this repository. If preparing a shared installation for "
-            "multiple users, consider adding the -t <target-dir> option to install necessary dependencies "
-            "into a shared directory, e.g.\n"
-            "python3 -m pip install -t <shared-install-path> -r requirements.txt\n"
-            "Note that the -DPYTHON_DEPS=<shared-install-path> can be used to provide an "
-            "additional search path to cmake for python packages.")
 endif()

 # ----------------------
@@ -365,4 +368,3 @@ message(STATUS "  package dependencies: ${PACKAGE_REQUIRES}")
 set(CPACK_RPM_PACKAGE_REQUIRES ${PACKAGE_REQUIRES})

 include(CPack)
-