libPyshell 0.2.0__tar.gz → 0.3.0__tar.gz

{libPyshell-0.2.0/libPyshell.egg-info → libPyshell-0.3.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: libPyshell
-Version: 0.2.0
+Version: 0.3.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
 Author-email: stefan.wehr@gmail.com
-Requires-Python: >=3.6
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -37,6 +37,10 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 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.0 → libPyshell-0.3.0}/README.md

@@ -26,6 +26,10 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 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.0 → libPyshell-0.3.0/libPyshell.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: libPyshell
-Version: 0.2.0
+Version: 0.3.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
 Author-email: stefan.wehr@gmail.com
-Requires-Python: >=3.6
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -37,6 +37,10 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 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.0 → libPyshell-0.3.0}/setup.py

@@ -2,7 +2,7 @@
 
 from distutils.core import setup
 
-VERSION = '0.2.0'
+VERSION = '0.3.0'
 
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
@@ -17,5 +17,5 @@ setup(name='libPyshell',
       url='https://github.com/skogsbaer/libPyshell',
       package_dir={'shell': 'src'},
       packages=['shell'],
-      python_requires='>=3.6'
+      python_requires='>=3.9'
       )

{libPyshell-0.2.0 → libPyshell-0.3.0}/src/__init__.py

@@ -50,7 +50,7 @@ except:
 
 DEV_NULL = _devNull
 
-_FILE: TypeAlias = None | int | IO[Any]
+_FILE = Union[int, IO[Any], None]
 
 atexit.register(lambda: DEV_NULL.close())
 
@@ -62,7 +62,7 @@ def fatal(s: str):
     """Display an error message to stderr."""
     sys.stderr.write('ERROR: ' + str(s) + '\n')
 
-def resolveProg(*l: str) -> str | None:
+def resolveProg(*l: str) -> Optional[str]:
     """Return the first program in the list that exist and is runnable.
     >>> resolveProg()
     >>> resolveProg('foobarbaz', 'cat', 'grep')
@@ -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__
@@ -125,14 +126,21 @@ class RunError(ShellError):
     * `exitcode`
     * `stderr`: output on stderr (if `run` configured to capture this output)
     """
-    def __init__(self, cmd: str | list[str], exitcode: int, stderr: str|bytes|None=None):
+    def __init__(self, cmd: Union[str, list[str]],
+                 exitcode: int,
+                 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,10 +181,10 @@ def splitLines(s: str) -> list[str]:
 
 def run(cmd: Union[list[str], str],
         onError: Literal['raise', 'die', 'ignore']='raise',
-        input: str | bytes | None=None,
+        input: Union[str, bytes, None]=None,
         encoding: str='utf-8',
-        captureStdout: bool|Callable[[str|bytes], Any]|_FILE=False,
-        captureStderr: bool|Callable[[str|bytes], Any]|_FILE=False,
+        captureStdout: Union[bool,Callable[[str], Any],_FILE]=False,
+        captureStderr: Union[bool,Callable[[str], Any],_FILE]=False,
         stderrToStdout: bool=False,
         cwd: Optional[str]=None,
         env: Optional[Dict[str, str]]=None,
@@ -203,7 +211,8 @@ def run(cmd: Union[list[str], str],
         * False: stdout is not captured and goes to stdout of the parent process (the default)
         * True: stdout is captured and returned
         * A function: stdout is captured and the result of applying the function to the captured
-          output is returned. Use splitLines as this function to split the output into lines
+          output is returned. In this case, encoding must not be `'raw'`.
+          Use splitLines as this function to split the output into lines
         * An existing file descriptor or a file object: stdout goes to the file descriptor or file
     * `stderrToStdout`: should stderr be sent to stdout?
     * `cwd`: working directory
@@ -221,25 +230,29 @@ def run(cmd: Union[list[str], str],
 
     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
+    >>> 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
+    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')
     """
     if type(cmd) != str and type(cmd) != list:
         raise ShellError('cmd parameter must be a string or a list')
@@ -250,9 +263,7 @@ def run(cmd: Union[list[str], str],
         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
+    shouldReturnStdout = (isinstance(captureStdout, Callable) or
                             (type(captureStdout) == bool and captureStdout))
     stdout: _FILE = None
     if shouldReturnStdout:
@@ -268,7 +279,7 @@ def run(cmd: Union[list[str], str],
     elif captureStderr:
         stderr = subprocess.PIPE
     input_str = 'None'
-    inputBytes: bytes | None = None
+    inputBytes: Optional[bytes] = None
     if input and isinstance(input, str):
         input_str = '<' + str(len(input)) + ' characters>'
         if encoding != 'raw':
@@ -298,25 +309,25 @@ def run(cmd: Union[list[str], str],
         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)
+    stdoutData = massageOutput(stdoutData, encoding, decodeErrorsStdout, captureStdout)
+    stderrData = massageOutput(stderrData, encoding, decodeErrorsStderr, captureStderr)
     exitcode = pipe.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):
-        stdoutRes = captureStdout(stdoutData)
-    return RunResult(stdoutRes, exitcode)
+    return RunResult(stdoutData, stderrData, exitcode)
+
+def massageOutput(data: Any, encoding: str, decodeErrors: str,
+                  capture: Union[bool,Callable[[str], Any],_FILE]):
+    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
 
 # the quote function is stolen from https://hg.python.org/cpython/file/3.5/Lib/shlex.py
 _find_unsafe = re.compile(r'[^\w@%+=:,./-]').search
@@ -531,7 +542,7 @@ class _ExitHooks(object):
         sys.exit = self.exit
         sys.excepthook = self.exc_handler
 
-    def exit(self, code: int|None=0):
+    def exit(self, code: Optional[int]=0):
         if code is None:
             myCode = 0
         elif type(code) != int:
@@ -569,7 +580,9 @@ def _registerAtExit(action: Any, mode: AtExitMode):
             _debug('Not running exit action')
     atexit.register(f)
 
-def mkTempFile(suffix: str='', prefix: str='', dir:str|None=None, deleteAtExit:AtExitMode=True):
+def mkTempFile(suffix: str='', prefix: str='',
+               dir:Optional[str]=None,
+               deleteAtExit:AtExitMode=True):
     """Create a temporary file.
 
     `deleteAtExit` controls if and how the file is deleted once the shell sript terminates.
@@ -589,7 +602,9 @@ def mkTempFile(suffix: str='', prefix: str='', dir:str|None=None, deleteAtExit:A
         _registerAtExit(action, deleteAtExit)
     return f
 
-def mkTempDir(suffix: str='', prefix: str='tmp', dir: str|None=None, deleteAtExit: AtExitMode=True):
+def mkTempDir(suffix: str='', prefix: str='tmp',
+              dir: Optional[str]=None,
+              deleteAtExit: AtExitMode=True):
     """Create a temporary directory. The `deleteAtExit` parameter
     has the same meaning as for `mkTempFile`.
     """
@@ -615,7 +630,7 @@ class tempDir:
     With `delete=False`, deletion is deactivated. With `onException=False`, deletion
     is only performed if the `with`-block finishes without an exception.
     """
-    def __init__(self, suffix: str='', prefix: str='tmp', dir: str|None=None,
+    def __init__(self, suffix: str='', prefix: str='tmp', dir: Optional[str]=None,
                  onException: bool=True, delete: bool=True):
         self.suffix = suffix
         self.prefix = prefix
@@ -644,7 +659,7 @@ def ls(d: str, *globs: str) -> list[str]:
 
     The pathnames in the result list contain the directory part `d`.
 
-    >>> '../src/shell.py' in ls('../src/', '*.py', '*.txt')
+    >>> '../src/__init__.py' in ls('../src/', '*.py', '*.txt')
     True
     """
     res: list[str] = []