Merge branch 'python-build-fixes' into 'master'

Python build system fixes

See merge request lscsoft/lalsuite!2370

gnuscripts/lalsuite_build.m4

@@ -1,7 +1,7 @@
 # -*- mode: autoconf; -*-
 # lalsuite_build.m4 - top level build macros
 #
-# serial 182
+# serial 183
 
 # restrict which LALSUITE_... patterns can appearing in output (./configure);
 # useful for debugging problems with unexpanded LALSUITE_... Autoconf macros
@@ -527,8 +527,19 @@ AC_DEFUN([LALSUITE_CHECK_PYTHON],[
       ])
     ])
     # Always install Python files into the same prefix as the rest of LALSuite
+    # - These variables may be set by AM_PATH_PYTHON
     AC_SUBST([PYTHON_PREFIX], ['${prefix}'])
     AC_SUBST([PYTHON_EXEC_PREFIX], ['${exec_prefix}'])
+    # Prefix where Python executable is installed
+    AC_SUBST([LALSUITE_PYTHON_SYS_PREFIX],[`${PYTHON} -c 'import sys; print(sys.prefix)'`])
+    AS_IF([test "x${LALSUITE_PYTHON_SYS_PREFIX}" = x],[
+      AC_MSG_ERROR([could not determine ${PYTHON} sys.prefix])
+    ])
+    # Path to Python executable
+    AC_SUBST([LALSUITE_PYTHON_SYS_EXECUTABLE],[`${PYTHON} -c 'import sys; print(sys.executable)'`])
+    AS_IF([test "x${LALSUITE_PYTHON_SYS_EXECUTABLE}" = x],[
+      AC_MSG_ERROR([could not determine ${PYTHON} sys.executable])
+    ])
   ])
   AS_IF([test "x${python}" = xfalse && test "x${lalsuite_require_pyvers}" = x],[
     AC_SUBST([PYTHON],["${SHELL} -c 'echo ERROR: Python is missing >&2; exit 1' --"])

gnuscripts/lalsuite_python.am

@@ -73,15 +73,15 @@ py-mostlyclean-local:
 
 $(pybin_scripts) $(noinst_pybin_scripts): Makefile
 .py:
-	$(AM_V_GEN)shebang='#!'; dummy_shebang='##(in place of shebang, for consistent line numbers)'; \
+	$(AM_V_GEN)shebang='#!'; \
 	$(MKDIR_P) .libs || exit 1; \
 	rm -f $@ || exit 1; \
 	if test -x $(srcdir)/$@.py; then \
 		printf "\nERROR: $(srcdir)/$@.py must not be executable\n\n" >&2; \
 		exit 1; \
 	fi; \
-	if test "x`$(SED) -n -e /^$${shebang}/p $(srcdir)/$@.py`" != x; then \
-		printf "\nERROR: $(srcdir)/$@.py must not contain a $${shebang} command line\n\n" >&2; \
+	if test "x`$(SED) -n -e \"1{\|^##python$$|p;}\" $(srcdir)/$@.py`" = x; then \
+		printf "\nERROR: $(srcdir)/$@.py must start with the line '##python' (which will be replaced with '$${shebang}$(LALSUITE_PYTHON_SYS_EXECUTABLE)' upon installation)\n\n" >&2; \
 		exit 1; \
 	fi; \
 	echo "$${shebang}/bin/sh" > .libs/$@.bin; \
@@ -90,40 +90,41 @@ $(pybin_scripts) $(noinst_pybin_scripts): Makefile
 	echo "PYTHONPATH=\"$(abs_builddir):$(abs_srcdir):$(LAL_PYTHON_PATH):\$${PYTHONPATH}\"" | $(SED) 's|:::*|:|g' >> .libs/$@.bin; \
 	echo "export PYTHONPATH" >> .libs/$@.bin; \
 	echo "test -d '$(abs_builddir)/.libs' || mkdir '$(abs_builddir)/.libs' >/dev/null 2>&1" >> .libs/$@.bin; \
-	echo "echo '$${dummy_shebang}' > '$(abs_builddir)/.libs/$@.py'" >> .libs/$@.bin; \
-	echo "$(SED) -e 's|@LALSUITE_BINDIR@|$(abs_builddir)|g' '$(abs_srcdir)/$@.py' >> '$(abs_builddir)/.libs/$@.py' || exit 1" >> .libs/$@.bin; \
-	echo "exec $(uninstalled_compiler) $(PYTHON) \$${PYBIN_SCRIPT_PY_FLAGS} '$(abs_builddir)/.libs/$@.py' \"\$$@\"" >> .libs/$@.bin; \
+	echo "$(SED) -e 's|@LALSUITE_BINDIR@|$(abs_builddir)|g' '$(abs_srcdir)/$@.py' > '$(abs_builddir)/.libs/$@.py' || exit 1" >> .libs/$@.bin; \
+	echo "exec $(uninstalled_compiler) $(LALSUITE_PYTHON_SYS_EXECUTABLE) \$${PYBIN_SCRIPT_PY_FLAGS} '$(abs_builddir)/.libs/$@.py' \"\$$@\"" >> .libs/$@.bin; \
 	echo "exit 1" >> .libs/$@.bin; \
 	chmod +x .libs/$@.bin || exit 1; \
 	mv -f .libs/$@.bin $@
 
 pybin-install-exec-local:
-	$(AM_V_GEN)shebang='#!'; dummy_shebang='##(in place of shebang, for consistent line numbers)'; \
+	$(AM_V_GEN)shebang='#!'; \
 	$(MKDIR_P) .libs || exit 1; \
 	if test "x$(pybin_scripts)" != x; then \
+		relpkglibexecdir=`$(PYTHON) -c 'import os; print(os.path.relpath("$(pkglibexecdir)", "$(bindir)"))'`; \
 		pypath="$(pyexecdir)"; \
 		if test "$(pythondir)" != "$(pyexecdir)"; then \
 			pypath="$${pypath}:$(pythondir)"; \
 		fi; \
 		echo " $(MKDIR_P) '$(DESTDIR)$(bindir)'"; \
 		$(MKDIR_P) "$(DESTDIR)$(bindir)" || exit 1; \
-		if test "x$(exec_prefix)" != "x$(PYTHON_EXEC_PREFIX)"; then \
+		if test "x$(prefix)" != "x$(LALSUITE_PYTHON_SYS_PREFIX)"; then \
 			echo " $(MKDIR_P) '$(DESTDIR)$(pkglibexecdir)'"; \
 			$(MKDIR_P) "$(DESTDIR)$(pkglibexecdir)" || exit 1; \
 		fi; \
 		for file in $(pybin_scripts); do \
-			if test "x$(exec_prefix)" = "x$(PYTHON_EXEC_PREFIX)"; then \
-				echo "$${shebang}$(PYTHON)" > .libs/$${file}.bin; \
-				$(SED) -e 's|@LALSUITE_BINDIR@|$(bindir)|g' "$(srcdir)/$${file}.py" >> .libs/$${file}.bin || exit 1; \
+			if test "x$(prefix)" = "x$(LALSUITE_PYTHON_SYS_PREFIX)"; then \
+				$(SED) -e "1{s|^##python$$|$${shebang}$(LALSUITE_PYTHON_SYS_EXECUTABLE)|;};s|@LALSUITE_BINDIR@|$(bindir)|g" "$(srcdir)/$${file}.py" > .libs/$${file}.bin || exit 1; \
 			else \
-				echo "$${shebang}/bin/sh" > .libs/$${file}.bin; \
-				echo "PYTHONPATH=\"$${pypath}:\$${PYTHONPATH}\"" >> .libs/$${file}.bin; \
-				echo "export PYTHONPATH" >> .libs/$${file}.bin; \
-				echo "exec $(PYTHON) '$(pkglibexecdir)/$${file}.py' \"\$$@\"" >> .libs/$${file}.bin; \
-				echo "exit 1" >> .libs/$${file}.bin; \
+				echo "$${shebang}$(LALSUITE_PYTHON_SYS_EXECUTABLE)" > .libs/$${file}.bin; \
+				echo "import os, sys" >> .libs/$${file}.bin; \
+				echo "if 'PYTHONPATH' in os.environ:" >> .libs/$${file}.bin; \
+				echo "    os.environ['PYTHONPATH'] = '$${pypath}:' + os.environ['PYTHONPATH']" >> .libs/$${file}.bin; \
+				echo "else:" >> .libs/$${file}.bin; \
+				echo "    os.environ['PYTHONPATH'] = '$${pypath}'" >> .libs/$${file}.bin; \
+				echo "os.execv(sys.executable, [sys.executable, os.path.join(os.path.dirname(__file__), '$${relpkglibexecdir}/$${file}.py')] + sys.argv[1:])" >> .libs/$${file}.bin; \
+				echo "sys.exit(1)" >> .libs/$${file}.bin; \
 				$(MKDIR_P) "$(builddir)/.libs" || exit 1; \
-				echo "$${dummy_shebang}" > "$(builddir)/.libs/$${file}.py"; \
-				$(SED) -e 's|@LALSUITE_BINDIR@|$(bindir)|g' "$(srcdir)/$${file}.py" >> "$(builddir)/.libs/$${file}.py" || exit 1; \
+				$(SED) -e 's|@LALSUITE_BINDIR@|$(bindir)|g' "$(srcdir)/$${file}.py" > "$(builddir)/.libs/$${file}.py" || exit 1; \
 				echo " $(INSTALL_DATA) $(builddir)/.libs/$${file}.py '$(DESTDIR)$(pkglibexecdir)/$${file}.py'"; \
 				$(INSTALL_DATA) "$(builddir)/.libs/$${file}.py" "$(DESTDIR)$(pkglibexecdir)/$${file}.py" || exit 1; \
 			fi; \
@@ -135,7 +136,7 @@ pybin-install-exec-local:
 pybin-uninstall-local:
 	-for file in $(pybin_scripts); do \
 		rm -f "$(DESTDIR)$(bindir)/$${file}"; \
-		if test "x$(exec_prefix)" != "x$(PYTHON_EXEC_PREFIX)"; then \
+		if test "x$(prefix)" != "x$(LALSUITE_PYTHON_SYS_PREFIX)"; then \
 			rm -f "$(DESTDIR)$(pkglibexecdir)/$${file}.py"; \
 		fi; \
 	done

gnuscripts/lalsuite_swig.m4

@@ -2,7 +2,7 @@
 # lalsuite_swig.m4 - SWIG configuration
 # Author: Karl Wette, 2011--2017
 #
-# serial 121
+# serial 122
 
 AC_DEFUN([_LALSUITE_MIN_SWIG_VERSION],[
   # $0: minimum version of SWIG and other dependencies
@@ -592,17 +592,19 @@ EOD`]
     # determine Python preprocessor flags
     AC_SUBST([SWIG_PYTHON_CPPFLAGS],["-ULAL_STRICT_DEFS_ENABLED"])
     python_out=[`${PYTHON} - 2>/dev/null <<EOD
+# include NumPy flags first, so local installs override system installs
+import numpy
+print(' -I' + numpy.get_include(), end='')
+# system include flags
 try:
     import distutils.sysconfig
 except ImportError:  # python >= 3.11
     import sysconfig
-    print('-I' + sysconfig.get_path('include'), end='')
+    print(' -I' + sysconfig.get_path('include'), end='')
     print(' -I' + sysconfig.get_path('platinclude'), end='')
 else:
-    print( '-I' + distutils.sysconfig.get_python_inc(), end='')
+    print(' -I' + distutils.sysconfig.get_python_inc(), end='')
     print(' -I' + distutils.sysconfig.get_python_inc(plat_specific=1), end='')
-import numpy
-print(' -I' + numpy.get_include(), end='')
 EOD`]
     AS_IF([test $? -ne 0],[
       AC_MSG_ERROR([could not determine Python preprocessor flags])

lal/bin/Makefile.am

@@ -62,6 +62,9 @@ pybin_scripts = \
 # Add shell, Python, etc. test scripts to this variable
 test_scripts += test_path2cache.sh
 
+installcheck-local:
+	$(bindir)/lal_path2cache --help
+
 endif
 
 # -- Manuals ----------------

lal/bin/lal_path2cache.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006  Kipp Cannon
 #

lal/bin/lal_searchsum2cache.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006  Kipp Cannon
 #

lalapps/src/power/lalapps_cafe.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006  Kipp Cannon
 #

lalapps/src/power/lalapps_power_likelihood_pipe.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2007  Kipp C. Cannon
 #

lalapps/src/power/lalapps_power_pipe.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2005--2010,2013,2015,2016,2019  Kipp Cannon
 # Copyright (C) 2004--2006  Saikat Ray-Majumder

lalapps/src/string/lalapps_cosmicstring_pipe.py

@@ -1,3 +1,4 @@
+##python
 #
 # =============================================================================
 #

lalapps/src/string/lalapps_string_apply_vetoes.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2010  Kipp Cannon
 #

lalapps/src/string/lalapps_string_calc_likelihood.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2010  Kipp Cannon
 #

lalapps/src/string/lalapps_string_contour_plotter.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2010  Andrew Mergl
 #

lalapps/src/string/lalapps_string_contour_plotter_largeloops.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2018 Daichi Tsuna
 #

lalapps/src/string/lalapps_string_cs_gamma.py

@@ -1,3 +1,4 @@
+##python
 #
 #  Copyright (C) 2007 Xavier Siemens
 #  Copyright (C) 2010 Andrew Mergl

lalapps/src/string/lalapps_string_cs_gamma_largeloops.py

@@ -1,3 +1,4 @@
+##python
 #
 #  Copyright (C) 2007 Xavier Siemens
 #  Copyright (C) 2018 Daichi Tsuna

lalapps/src/string/lalapps_string_final.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006--2010  Kipp Cannon
 #

lalapps/src/string/lalapps_string_meas_likelihood.py

@@ -1,3 +1,4 @@
+##python
 # Copyright (C) 2010--2018  Kipp Cannon
 #
 # This program is free software; you can redistribute it and/or modify it

lalapps/src/string/lalapps_string_plot_binj.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2009  Kipp Cannon
 #

lalapps/src/string/lalapps_string_plot_likelihood.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2009  Kipp Cannon
 #

lalburst/bin/lalburst_cluster.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006,2012  Kipp Cannon
 #

lalburst/bin/lalburst_coinc.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006--2017  Kipp Cannon
 #

lalburst/bin/lalburst_cut.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006,2013  Kipp Cannon
 #

lalburst/bin/lalburst_gen_timeslides.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006--2014  Kipp Cannon
 #

lalburst/bin/lalburst_inj_pic.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2010,2013  Kipp Cannon
 #

lalburst/bin/lalburst_injfind.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006  Kipp Cannon
 #

lalburst/bin/lalburst_plot_tisi.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006,2013  Kipp Cannon
 #

lalburst/bin/lalburst_power_calc_likelihood.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006--2010  Kipp Cannon
 #

lalburst/bin/lalburst_power_final.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2007  Kipp Cannon
 #

lalburst/bin/lalburst_power_meas_likelihood.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2007-2010  Kipp Cannon
 #

lalburst/bin/lalburst_power_plot_binj.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2006  Kipp Cannon
 #

lalburst/bin/lalburst_power_plot_binjtf.py

@@ -1,3 +1,4 @@
+##python
 #
 # Copyright (C) 2007  Kipp Cannon
 #

lalinference/bin/cbcBayesBurstPPAnalysis.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesPostProc.py

lalinference/bin/cbcBayesBurstPostProc.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesBurstPostProc.py

lalinference/bin/cbcBayesCombinePTMCMCh5s.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesCombinePTMCMCh5s.py

lalinference/bin/cbcBayesCombinePosteriors.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #       cbcBayesCombinePosteriors.py
 #

lalinference/bin/cbcBayesCompPos.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesCompPos.py Copyright 2010--2012 Benjamin Aylott

lalinference/bin/cbcBayesDIEvidence.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesDIEvidence.py: compute the direct-integration evidence

lalinference/bin/cbcBayesGraceDBinfo.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesGraceDBinfo

lalinference/bin/cbcBayesMCMC2pos.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesMCMC2pos.py

lalinference/bin/cbcBayesPPAnalysis.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesPPAnalysis.py

lalinference/bin/cbcBayesPlotSpinDisk.py

@@ -1,3 +1,4 @@
+##python
 # Ben Farr 2016
 
 import os

lalinference/bin/cbcBayesPosToSimBurst.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #       cbcBayesPosToSimBurst.py
 #       C2014 Salvatore Vitale <salvatore.vitale@ligo.org>

lalinference/bin/cbcBayesPosToSimInspiral.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesPosToSimInspiral.py

lalinference/bin/cbcBayesPostProc.py

@@ -1,3 +1,4 @@
+##python
 # -*- coding: utf-8 -*-
 #
 #       cbcBayesPostProc.py

lalinference/bin/cbcBayesThermoInt.py

@@ -1,3 +1,4 @@
+##python
 
 from optparse import OptionParser
 import sys

lalinference/bin/imrtgr_imr_consistency_test.py

@@ -1,3 +1,4 @@
+##python
 """
 Perform the consistency check between the inspiral and ringdown estimates of the mass and spin of the final
 black hole in a binary black hole merger.

lalinference/bin/lalinference_burst_pp_pipe.py

@@ -1,3 +1,4 @@
+##python
 # End-to-end LALInference test pipeline
 # (C) 2014 John Veitch
 

lalinference/bin/lalinference_coherence_test.py

@@ -1,3 +1,4 @@
+##python
 '''
 This program simply computes the bayes factor between the coherent and incoherent models
 given as input the B files for the run.

lalinference/bin/lalinference_compute_roq_weights.py

@@ -1,3 +1,4 @@
+##python
 import numpy as np
 from math import ceil
 from optparse import OptionParser

lalinference/bin/lalinference_cpnest.py

@@ -1,3 +1,4 @@
+##python
 import sys
 import argparse
 from lalinference.wrapper import LALInferenceCBCWrapper

lalinference/bin/lalinference_evolve_spins_and_append_samples.py

@@ -1,3 +1,4 @@
+##python
 '''
 Code to read in LALInference HDF5 posterior samples, evolve the spins up to a specified value (default: Schwarzschild ISCO), and write the resulting evolved spin samples to the HDF5 file.