From 27845764884f13fed0a2bf58055e99032af3cc3f Mon Sep 17 00:00:00 2001
From: A Dedner <a.s.dedner@warwick.ac.uk>
Date: Tue, 23 Jul 2024 15:54:03 +0100
Subject: [PATCH] add a REQUIRE parameter to dune_python_configure_bindings
---
CHANGELOG.md | 5 +++++
cmake/modules/DunePythonInstallPackage.cmake | 14 ++++++++++++--
2 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 393c2e210..2293e9586 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -89,6 +89,11 @@ In order to build the DUNE core modules you need at least the following software
## Build System
+- Add a `REQUIRED` parameter to `dune_python_configure_bindings`. If set to
+ `TRUE` the functions throws an error instead of a warning if the package
+ setup fails. The default behavior (or setting `REQUIRE` to `FALSE`) is to
+ show the warning during configuration and to continue.
+
- Remove the search of (currently broken) `pkg-config` files for dune packages.
- Dune package dependencies are now transitively resolved at `find_package(<dune-module>)` calls instead of waiting
diff --git a/cmake/modules/DunePythonInstallPackage.cmake b/cmake/modules/DunePythonInstallPackage.cmake
index 0fe73aa11..4b8258fb9 100644
--- a/cmake/modules/DunePythonInstallPackage.cmake
+++ b/cmake/modules/DunePythonInstallPackage.cmake
@@ -137,6 +137,12 @@
# an entry of the form "flagname:=value" is added. These flags are
# then set in the CMakeLists.txt file of a generated dune-py module.
#
+# .. cmake_param:: REQUIRED
+# :option:
+#
+# If set, the function will error out if the package could not be installed.
+# Default behavior is to only show a warning.
+#
# This is a convenience function that performs the tasks of
# :dune_python_configure_dependencies:, :dune_link_dune_py:, and :dune_python_configure_package:.
# Additionally, it makes sure that a 'setup.py' is available with the following procedure:
@@ -574,7 +580,7 @@ endfunction()
function(dune_python_configure_bindings)
# Parse Arguments
- set(SINGLE PATH PACKAGENAME)
+ set(SINGLE PATH PACKAGENAME REQUIRED)
set(MULTI ADDITIONAL_PIP_PARAMS CMAKE_METADATA_FLAGS)
cmake_parse_arguments(PYCONFBIND "${OPTION}" "${SINGLE}" "${MULTI}" ${ARGN})
if(PYCONFBIND_UNPARSED_ARGUMENTS)
@@ -646,7 +652,11 @@ function(dune_python_configure_bindings)
CMAKE_METADATA_FLAGS ${PYCONFBIND_CMAKE_METADATA_FLAGS}
)
else()
- message(WARNING "python binding configuration failed - no linking done")
+ if(PYCONFBIND_REQUIRED)
+ message(FATAL_ERROR "python binding configuration failed.")
+ else()
+ message(WARNING "python binding configuration failed - no python package provided")
+ endif()
endif()
endfunction()
--
GitLab