proc.pipeline: deprecate shell_executable, use executable instead

matches `subprocess` better

utz/process/pipeline.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from warnings import warn
+
 from io import UnsupportedOperation, StringIO
 from os import environ as env
 from subprocess import Popen, PIPE
@@ -17,16 +19,26 @@ def pipeline(
     out: str | IO[AnyStr] | None = None,
     mode: Literal['b', 't', None] = None,
     shell: bool = True,
+    executable: str | None = _Unset,
     shell_executable: str | None = _Unset,
     wait: bool = True,
     **kwargs,
 ) -> str | list[Popen] | None:
     """Run a pipeline of commands, writing the final stdout to a file or ``IO``, or returning it as a ``str``"""
     processes = []
     prev_process: Popen | None = None
-    if shell_executable is _Unset:
+    if executable is _Unset:
         shell_executable = env.get('SHELL')
 
+    if shell_executable is not _Unset:
+        warn(
+            "`shell_executable` kwarg is deprecated, use `executable` instead",
+            FutureWarning,
+            stacklevel=2
+        )
+        if executable is _Unset:
+            executable = shell_executable
+
     return_output = False
     if out is None:
         out = StringIO()
@@ -57,7 +69,7 @@ def mkproc(stdout=PIPE):
                 stdin=stdin,
                 stdout=stdout,
                 shell=shell,
-                executable=shell_executable,
+                executable=executable,
                 **kwargs
             )
 

utz/tests/test_proc.py

@@ -1,6 +1,7 @@
 from os.path import join
 
 import json
+from os import environ as env
 import pytest
 from subprocess import CalledProcessError
 from tempfile import NamedTemporaryFile, TemporaryDirectory
@@ -75,3 +76,8 @@ def test_pipeline():
         pipeline(['seq 10', 'head -n5'], tmp_path)
         with open(tmp_path) as f:
             assert f.read() == '1\n2\n3\n4\n5\n'
+
+
+def test_pipeline_shell_executable_warning():
+    with pytest.warns(FutureWarning, match="`shell_executable` kwarg is deprecated"):
+        pipeline(['seq 10', 'head -n5'], shell_executable=env['SHELL'])