Warn if python scripts are not run via launcher scripts

ChangeLog.md

@@ -20,6 +20,10 @@ See docs/process.md for more on how version tagging works.
 
 4.0.21 (in development)
 -----------------------
+- The emscripten tools will now warn if they are not run via the launcher
+  scripts.  i.e. it is no longer officially supported to run `python emcc.py`.
+  Instead, `emcc` should be run directly (via the provided `.bat` or shell
+  script). (#20437)
 - The `-sPROXY_TO_WORKER` setting (along with the corresponding
   `--proxy-to-worker` flag) was removed due to lack of usage.  If you were
   depending on this feature but missed the PSA, please let us know about your

bootstrap

@@ -30,4 +30,5 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 exec "$_EM_PY" -E "$0.py" "$@"

bootstrap.bat

@@ -10,6 +10,9 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=

em++

@@ -30,6 +30,7 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 if [ -z "$_EMCC_CCACHE" ]; then
   exec "$_EM_PY" -E "$0.py" "$@"
 else

em++.bat

@@ -10,9 +10,13 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=
+
 @set _EM_PY=%EMSDK_PYTHON%
 @if "%_EM_PY%"=="" (
   set _EM_PY=python

emcc

@@ -30,6 +30,7 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 if [ -z "$_EMCC_CCACHE" ]; then
   exec "$_EM_PY" -E "$0.py" "$@"
 else

emcc.bat

@@ -10,9 +10,13 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=
+
 @set _EM_PY=%EMSDK_PYTHON%
 @if "%_EM_PY%"=="" (
   set _EM_PY=python

test/runner

@@ -30,4 +30,5 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 exec "$_EM_PY" -E "$0.py" "$@"

test/runner.bat

@@ -10,6 +10,9 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=

test/test_other.py

@@ -15210,3 +15210,7 @@ def test_binary_encode(self):
 console.log('OK');'''
     write_file('test.js', read_file(path_from_root('src/binaryDecode.js')) + '\nvar src = ' + binary_encoded + ';\n' + test_js)
     self.assertContained('OK', self.run_js('test.js'))
+
+  def test_direct_usage_warning(self):
+    err = self.run_process([sys.executable, path_from_root('emcc.py'), '--version'], stderr=PIPE).stderr
+    self.assertContained('emcc: warning: python script (`emcc.py`) was run directly rather than run via launcher', err)

tools/maint/run_python.bat

@@ -10,6 +10,9 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=

tools/maint/run_python.sh

@@ -30,4 +30,5 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 exec "$_EM_PY" -E "$0.py" "$@"

tools/maint/run_python_compiler.bat

@@ -10,9 +10,13 @@
 
 :: All env. vars specified in this file are to be local only to this script.
 @setlocal
+
+@set _EM_LAUNCHER=1
+
 :: -E will not ignore _PYTHON_SYSCONFIGDATA_NAME an internal
 :: of cpython used in cross compilation via setup.py.
 @set _PYTHON_SYSCONFIGDATA_NAME=
+
 @set _EM_PY=%EMSDK_PYTHON%
 @if "%_EM_PY%"=="" (
   set _EM_PY=python

tools/maint/run_python_compiler.sh

@@ -30,6 +30,7 @@ if [ -z "$_EM_PY" ]; then
   exit 1
 fi
 
+export _EM_LAUNCHER=1
 if [ -z "$_EMCC_CCACHE" ]; then
   exec "$_EM_PY" -E "$0.py" "$@"
 else

tools/shared.py

@@ -620,6 +620,13 @@ def get_llvm_target():
 def init():
   utils.set_version_globals()
   setup_temp_dirs()
+  if '_EM_LAUNCHER' not in os.environ:
+    actual = bat_suffix(os.path.basename(sys.argv[0]))
+    launcher = os.path.splitext(actual)[0]
+    diagnostics.warning('unsupported', f'python script (`{actual}`) was run directly rather than run via launcher.  Running via `{launcher}` is recommended')
+  else:
+    # We don't want subprocesses to inherit this environment variable.
+    del os.environ['_EM_LAUNCHER']
 
 
 # ============================================================================