TST,FIX: Provide default env and switch to more recent name for argument.

DWesl · DWesl · commit a08f7d6e1be8 · 2023-01-09T22:38:20.000-05:00
universal_newlines is apparently the back-compatibility name;
also text describes the biggest difference in the return types.
diff --git a/lib/matplotlib/testing/__init__.py b/lib/matplotlib/testing/__init__.py
@@ -52,12 +52,12 @@ def setup():
 
 def subprocess_run_for_testing(
         command: "list[str]",
-        env: "dict[str, str]",
+        env: "dict[str, str]" = None,
         timeout: float = None,
         stdout=None,
         stderr=None,
         check=False,
-        universal_newlines=True,
+        text=True,
         capture_output=False
 ) -> "subprocess.Popen":
     """
@@ -72,7 +72,11 @@ def subprocess_run_for_testing(
     timeout : float
     stdout, stderr
     check : bool
-    universal_newlines : bool
+    text : bool
+        Also called `universal_newlines` in subprocess.  I chose this
+        name since the main effect is returning bytes (False) vs. str
+        (True), though it also tries to normalize newlines across
+        platforms.
     capture_output : bool
         Set stdout and stderr to subprocess.PIPE
 
@@ -96,7 +100,7 @@ def subprocess_run_for_testing(
             command, env=env,
             timeout=timeout, check=check,
             stdout=stdout, stderr=stderr,
-            universal_newlines=universal_newlines
+            text=text
         )
     except BlockingIOError:
         if sys.platform == "cygwin":
@@ -124,15 +128,18 @@ def subprocess_run_helper(func, *args, timeout, extra_env=None):
     target = func.__name__
     module = func.__module__
     proc = subprocess_run_for_testing(
-        [sys.executable,
-         "-c",
-         f"from {module} import {target}; {target}()",
-         *args],
+        [
+            sys.executable,
+            "-c",
+            f"from {module} import {target}; {target}()",
+            *args
+        ],
         env={**os.environ, "SOURCE_DATE_EPOCH": "0", **(extra_env or {})},
         timeout=timeout, check=True,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
-        universal_newlines=True)
+        text=True
+    )
     return proc
 
 
diff --git a/lib/matplotlib/tests/test_sphinxext.py b/lib/matplotlib/tests/test_sphinxext.py
@@ -20,7 +20,7 @@ def build_sphinx_html(source_dir, doctree_dir, html_dir, extra_args=None):
     cmd = [sys.executable, '-msphinx', '-W', '-b', 'html',
            '-d', str(doctree_dir), str(source_dir), str(html_dir), *extra_args]
     proc = subprocess_run_for_testing(
-        cmd, capture_output=True, universal_newlines=True,
+        cmd, capture_output=True, text=True,
         env={**os.environ, "MPLBACKEND": ""})
     out = proc.stdout
     err = proc.stderr
@@ -47,7 +47,7 @@ def test_tinypages(tmp_path):
     # same name in multiple extension modules -- but we don't care about their
     # coverage anyways); hide them using GCOV_ERROR_FILE.
     proc = subprocess_run_for_testing(
-        cmd, capture_output=True, universal_newlines=True,
+        cmd, capture_output=True, text=True,
         env={**os.environ, "MPLBACKEND": "", "GCOV_ERROR_FILE": os.devnull}
     )
     out = proc.stdout
