Time out in _get_executable_info

jkseppan · jkseppan · commit 38a4c3b27078 · 2025-07-03T19:58:21.000+03:00
Time out after 30 seconds. This is used for version queries which should be very fast, so a 30-second delay would be unusual. GitHub Actions test runs have been hanging trying to get the inkscape version when using Python 3.14: https://github.com/matplotlib/matplotlib/actions/runs/16043158943/job/45268507848#step:13:836
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -400,12 +400,15 @@ def impl(args, regex, min_ver=None, ignore_exit_code=False):
         try:
             output = subprocess.check_output(
                 args, stderr=subprocess.STDOUT,
-                text=True, errors="replace")
+                text=True, errors="replace", timeout=30)
         except subprocess.CalledProcessError as _cpe:
             if ignore_exit_code:
                 output = _cpe.output
             else:
                 raise ExecutableNotFoundError(str(_cpe)) from _cpe
+        except subprocess.TimeoutExpired as _te:
+            msg = f"Timed out running {' '.join(args)}"
+            raise ExecutableNotFoundError(msg) from _te
         except OSError as _ose:
             raise ExecutableNotFoundError(str(_ose)) from _ose
         match = re.search(regex, output)
diff --git a/lib/matplotlib/tests/test_matplotlib.py b/lib/matplotlib/tests/test_matplotlib.py
@@ -1,7 +1,7 @@
 import os
 import subprocess
 import sys
-
+from unittest.mock import patch
 import pytest
 
 import matplotlib
@@ -80,3 +80,18 @@ def test_importable_with__OO():
         [sys.executable, "-OO", "-c", program],
         env={**os.environ, "MPLBACKEND": ""}, check=True
         )
+
+
+@patch('matplotlib.subprocess.check_output')
+def test_get_executable_info_timeout(mock_check_output):
+    """
+    Test that _get_executable_info raises ExecutableNotFoundError if the
+    command times out.
+    """
+
+    mock_check_output.side_effect = subprocess.TimeoutExpired(cmd=['mock'], timeout=30)
+
+    with pytest.raises(matplotlib.ExecutableNotFoundError) as exc_info:
+        print(matplotlib._get_executable_info.__wrapped__('inkscape'))
+
+    assert "Timed out" in str(exc_info.value)
