libPyshell 0.2.1__tar.gz → 0.4.0__tar.gz

{libPyshell-0.2.1/libPyshell.egg-info → libPyshell-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libPyshell
-Version: 0.2.1
+Version: 0.4.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
@@ -37,6 +37,14 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.4.0 (2024-03-20)
+  * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
+    disappear.
+
+* 0.3.0 (2024-02-01)
+  * uniform treatment when capturing stdout and stderr. This lead to changes to RunResult
+    and RunError which are slightly backwards incompatible.
+
 * 0.2.0 (2024-01-29)
   * Better static type information
 

{libPyshell-0.2.1 → libPyshell-0.4.0}/README.md

@@ -26,6 +26,14 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.4.0 (2024-03-20)
+  * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
+    disappear.
+
+* 0.3.0 (2024-02-01)
+  * uniform treatment when capturing stdout and stderr. This lead to changes to RunResult
+    and RunError which are slightly backwards incompatible.
+
 * 0.2.0 (2024-01-29)
   * Better static type information
 

{libPyshell-0.2.1 → libPyshell-0.4.0/libPyshell.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libPyshell
-Version: 0.2.1
+Version: 0.4.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
@@ -37,6 +37,14 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.4.0 (2024-03-20)
+  * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
+    disappear.
+
+* 0.3.0 (2024-02-01)
+  * uniform treatment when capturing stdout and stderr. This lead to changes to RunResult
+    and RunError which are slightly backwards incompatible.
+
 * 0.2.0 (2024-01-29)
   * Better static type information
 

{libPyshell-0.2.1 → libPyshell-0.4.0}/setup.py

@@ -2,7 +2,7 @@
 
 from distutils.core import setup
 
-VERSION = '0.2.1'
+VERSION = '0.4.0'
 
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()

{libPyshell-0.2.1 → libPyshell-0.4.0}/src/__init__.py

@@ -50,7 +50,7 @@ except:
 
 DEV_NULL = _devNull
 
-_FILE = Union[int, IO[Any], None]
+_FILE = Union[int, IO[Any]]
 
 atexit.register(lambda: DEV_NULL.close())
 
@@ -94,11 +94,12 @@ class RunResult:
     attribute `stdout` contains the output printed in stdout (only if `run`
     was invoked with `captureStdout=True`).
     """
-    def __init__(self, stdout: Any, exitcode: int):
+    def __init__(self, stdout: Any, stderr: Any, exitcode: int):
         self.stdout = stdout
+        self.stderr = stderr
         self.exitcode = exitcode
     def __repr__(self):
-        return 'RunResult(exitcode=%d, stdout=%r) '% (self.exitcode, self.stdout)
+        return 'RunResult(exitcode=%d, stdout=%r, stderr=%r)' % (self.exitcode, self.stdout, self.stderr)
     def __eq__(self, other: Any):
         if type(other) is type(self):
             return self.__dict__ == other.__dict__
@@ -127,14 +128,19 @@ class RunError(ShellError):
     """
     def __init__(self, cmd: Union[str, list[str]],
                  exitcode: int,
-                 stderr: Union[str,bytes,None]=None):
+                 stdout: Union[str,bytes],
+                 stderr: Union[str,bytes]):
         self.cmd = cmd
         self.exitcode = exitcode
         self.stderr = stderr
+        self.stdout = stdout
         msg = 'Command ' + repr(self.cmd) + " failed with exit code " + str(self.exitcode)
         if stderr:
             msg = msg + '\nstderr:\n' + str(stderr)
         super(RunError, self).__init__(msg)
+    def __repr__(self):
+        return 'RunError(cmd=%r, exitcode=%d, stdout=%r, stderr=%r)' % \
+            (self.cmd, self.exitcode, self.stdout, self.stderr)
 
 def splitOn(splitter: str) -> Callable[[str], list[str]]:
     """Return a function that splits a string on the given splitter string.
@@ -173,19 +179,55 @@ def splitLines(s: str) -> list[str]:
     else:
         return s.split('\n')
 
+def _decode(input: Union[str, bytes, None], encoding: str, errors: str) -> Optional[bytes]:
+    inputBytes: Optional[bytes] = None
+    if input and isinstance(input, str):
+        if encoding != 'raw':
+            inputBytes = input.encode(encoding, errors)
+        else:
+            raise ValueError('Given str object as input, but encoding is raw')
+    elif input:
+        inputBytes = input
+    return inputBytes
+
+CaptureType = Union[bool, Callable[[str], Any], _FILE, None]
+
+def _handleCapture(capture: CaptureType) -> Optional[_FILE]:
+    if capture == True:
+        return subprocess.PIPE
+    elif callable(capture):
+        return subprocess.PIPE
+    elif capture is None:
+        return None
+    else:
+        return capture
+
+def _massageOutput(data: Any, encoding: str, decodeErrors: Optional[str],
+                  capture: CaptureType):
+    if not decodeErrors:
+        decodeErrors = 'strict'
+    if data and encoding != 'raw':
+        data = data.decode(encoding, errors=decodeErrors)
+    if not data:
+        data = ''
+    if isinstance(capture, Callable) and isinstance(data, str):
+        data = capture(data)
+    return data
+
 def run(cmd: Union[list[str], str],
         onError: Literal['raise', 'die', 'ignore']='raise',
         input: Union[str, bytes, None]=None,
         encoding: str='utf-8',
-        captureStdout: Union[bool,Callable[[str], Any],_FILE]=False,
-        captureStderr: Union[bool,Callable[[str], Any],_FILE]=False,
+        captureStdout: Union[bool, Callable[[str], Any], _FILE, None]=False,
+        captureStderr: Union[bool, Callable[[str], Any], _FILE, None]=False,
         stderrToStdout: bool=False,
         cwd: Optional[str]=None,
         env: Optional[Dict[str, str]]=None,
         freshEnv: Optional[Dict[str, str]]=None,
         decodeErrors: str='replace',
         decodeErrorsStdout: Optional[str]=None,
-        decodeErrorsStderr: Optional[str]=None
+        decodeErrorsStderr: Optional[str]=None,
+        encodeErrorsStdin: Optional[str]=None
         ) -> RunResult:
     """Runs the given command.
 
@@ -211,10 +253,11 @@ def run(cmd: Union[list[str], str],
     * `stderrToStdout`: should stderr be sent to stdout?
     * `cwd`: working directory
     * `env`: dictionary with additional environment variables.
-    * `freshEnv`: dictionary with a completely fresh environment.
-    * `decodeErrors`: how to handle decoding errors on stdout and stderr.
-    * `decodeErrorsStdout` and `decodeErrorsStderr`: overwrite the value of decodeErrors for stdout
-        or stderr
+    * `freshEnv`: dictionary with a completely fresh environment. If `env` is also given, then
+         `freshEnv` is ignored.
+    * `decodeErrors`: how to handle decoding/encoding errors on stdout and stderr and stdin.
+    * `decodeErrorsStdout` and `decodeErrorsStderr` and `encodeErrorsStdin`: overwrite the value
+          of decodeErrors for stdout or stderr or stdin
 
     Returns:
       a `RunResult` value, given access to the captured stdout of the child process (if it was
@@ -222,105 +265,67 @@ def run(cmd: Union[list[str], str],
 
     Raises: a `RunError` if `onError='raise'` and the command terminates with a non-zero exit code.
 
-    Starting with Python 3.5, the `subprocess` module defines a similar function.
-
-    >>> run('/bin/echo foo') == RunResult(exitcode=0, stdout='')
-    True
-    >>> run('/bin/echo -n foo', captureStdout=True) == RunResult(exitcode=0, stdout='foo')
-    True
-    >>> run('/bin/echo -n foo', captureStdout=lambda s: s + 'X') == \
-        RunResult(exitcode=0, stdout='fooX')
-    True
-    >>> run('/bin/echo foo', captureStdout=False) == RunResult(exitcode=0, stdout='')
-    True
-    >>> run('cat', captureStdout=True, input='blub') == RunResult(exitcode=0, stdout='blub')
-    True
+    Starting with Python 3.5, the `subprocess` module defines a similar function. This function
+    is just a wrapper for it.
+
+    >>> run('/bin/echo foo')
+    RunResult(exitcode=0, stdout='', stderr='')
+    >>> run('/bin/echo -n foo', captureStdout=True)
+    RunResult(exitcode=0, stdout='foo', stderr='')
+    >>> run('/bin/echo -n foo', captureStdout=lambda s: s + 'X')
+    RunResult(exitcode=0, stdout='fooX', stderr='')
+    >>> run('/bin/echo foo', captureStdout=False)
+    RunResult(exitcode=0, stdout='', stderr='')
+    >>> run('cat', captureStdout=True, input='blub')
+    RunResult(exitcode=0, stdout='blub', stderr='')
     >>> try:
-    ...     run('false')
+    ...     run('/bin/echo -n foo 1>&2; /bin/echo -n bar; false', captureStdout=True, captureStderr=True)
     ...     raise 'exception expected'
-    ... except RunError:
-    ...     pass
+    ... except RunError as e:
+    ...     print(repr(e))
     ...
-    >>> run('false', onError='ignore') == RunResult(exitcode=1, stdout='')
-    True
-    """
-    if type(cmd) != str and type(cmd) != list:
-        raise ShellError('cmd parameter must be a string or a list')
-    if type(cmd) == str:
-        cmd = cmd.replace('\x00', ' ')
-        cmd = cmd.replace('\n', ' ')
-    if decodeErrorsStdout is None:
-        decodeErrorsStdout = decodeErrors
-    if decodeErrorsStderr is None:
-        decodeErrorsStderr = decodeErrors
-    stdoutIsFileLike = isinstance(captureStdout, int) or isinstance(captureStdout, IO)
-    stdoutIsProcFun = not stdoutIsFileLike and isinstance(captureStdout, Callable)
-    shouldReturnStdout = (stdoutIsProcFun or
-                            (type(captureStdout) == bool and captureStdout))
-    stdout: _FILE = None
-    if shouldReturnStdout:
-        stdout = subprocess.PIPE
-    elif isinstance(captureStdout, int) or isinstance(captureStdout, IO):
-        stdout = captureStdout
-    stdin = None
-    if input:
-        stdin = subprocess.PIPE
-    stderr = None
+    RunError(cmd='/bin/echo -n foo 1>&2; /bin/echo -n bar; false', exitcode=1, stdout='bar', stderr='foo')
+    >>> run('false', onError='ignore')
+    RunResult(exitcode=1, stdout='', stderr='')
+    >>> run('/bin/echo -n foo; /bin/echo -n bar 1>&2', captureStdout=True, captureStderr=True)
+    RunResult(exitcode=0, stdout='foo', stderr='bar')
+    >>> run('/bin/echo -n foo 1>&2; /bin/echo -n bar', captureStderr=lambda s: s + 'X')
+    RunResult(exitcode=0, stdout='', stderr='fooX')
+    """
+    shell = isinstance(cmd, str)
+    input = _decode(input, encoding, encodeErrorsStdin or decodeErrors)
+    stdout = _handleCapture(captureStdout)
     if stderrToStdout:
         stderr = subprocess.STDOUT
-    elif captureStderr:
-        stderr = subprocess.PIPE
-    input_str = 'None'
-    inputBytes: Optional[bytes] = None
-    if input and isinstance(input, str):
-        input_str = '<' + str(len(input)) + ' characters>'
-        if encoding != 'raw':
-            inputBytes = input.encode(encoding)
-        else:
-            raise ValueError('Given str object as input, but encoding is raw')
-    elif input:
-        inputBytes = input
-    _debug('Running command ' + repr(cmd) + ' with captureStdout=' + str(captureStdout) +
-          ', onError=' + onError + ', input=' + input_str)
-    popenEnv = None
+    else:
+        stderr = _handleCapture(captureStderr)
+    runEnv = None
     if env:
-        popenEnv = os.environ.copy()
-        popenEnv.update(env)
+        runEnv = os.environ.copy()
+        runEnv.update(env)
     elif freshEnv:
-        popenEnv = freshEnv.copy()
+        runEnv = freshEnv.copy()
         if env:
-            popenEnv.update(env)
+            runEnv.update(env)
     # Ensure correct ordering of outputs
     if stdout is None:
         sys.stdout.flush()
     if stderr is None:
         sys.stderr.flush()
-    pipe = subprocess.Popen(
-        cmd, shell=(type(cmd) == str),
-        stdout=stdout, stdin=stdin, stderr=stderr,
-        cwd=cwd, env=popenEnv
-    )
-    (stdoutData, stderrData) = pipe.communicate(input=inputBytes)
-    if stdoutData and encoding != 'raw':
-        stdoutData = stdoutData.decode(encoding, errors=decodeErrorsStdout)
-    if stderrData and encoding != 'raw':
-        stderrData = stderrData.decode(encoding, errors=decodeErrorsStderr)
-    exitcode = pipe.returncode
+    if _PYSHELL_DEBUG:
+        _debug(f'subprocess.run({cmd}, shell={shell}, input={input}, stdout={stdout}, ' \
+              f'stderr={stderr}, cwd={cwd}, env={runEnv})')
+    res = subprocess.run(cmd, shell=shell, input=input, stdout=stdout, stderr=stderr, cwd=cwd,
+                         env=runEnv)
+    stdoutData = _massageOutput(res.stdout, encoding, decodeErrorsStdout or decodeErrors, captureStdout)
+    stderrData = _massageOutput(res.stderr, encoding, decodeErrorsStderr or decodeErrors, captureStderr)
+    exitcode = res.returncode
     if onError == 'raise' and exitcode != 0:
-        d = stderrData
-        if stderrToStdout:
-            d = stdoutData
-        err = RunError(cmd, exitcode, d)
+        err = RunError(cmd, exitcode, stdoutData, stderrData)
         raise err
     if onError == 'die' and exitcode != 0:
         sys.exit(exitcode)
-    stdoutRes = stdoutData
-    if not stdoutRes:
-        stdoutRes = ''
-    if not stdoutIsFileLike and isinstance(captureStdout, Callable) and \
-        isinstance(stdoutData, str):
-        stdoutRes = captureStdout(stdoutData)
-    return RunResult(stdoutRes, exitcode)
+    return RunResult(stdoutData, stderrData, exitcode)
 
 # the quote function is stolen from https://hg.python.org/cpython/file/3.5/Lib/shlex.py
 _find_unsafe = re.compile(r'[^\w@%+=:,./-]').search