libPyshell 0.4.1__tar.gz → 0.5.0__tar.gz

{libpyshell-0.4.1/libPyshell.egg-info → libpyshell-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: libPyshell
-Version: 0.4.1
+Version: 0.5.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
@@ -8,6 +8,13 @@ Author-email: stefan.wehr@gmail.com
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-python
+Dynamic: summary
 
 # Pyshell
 
@@ -37,6 +44,9 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.5.0 (2025-03-11)
+  * support of timeouts for run
+
 * 0.4.1 (2024-09-12)
   * fix capture handling
   * add failOnError option to rm commands

{libpyshell-0.4.1 → libpyshell-0.5.0}/README.md

@@ -26,6 +26,9 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.5.0 (2025-03-11)
+  * support of timeouts for run
+
 * 0.4.1 (2024-09-12)
   * fix capture handling
   * add failOnError option to rm commands

{libpyshell-0.4.1 → libpyshell-0.5.0/libPyshell.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: libPyshell
-Version: 0.4.1
+Version: 0.5.0
 Summary: Support for writing shell scripts in Python
 Home-page: https://github.com/skogsbaer/libPyshell
 Author: Stefan Wehr
@@ -8,6 +8,13 @@ Author-email: stefan.wehr@gmail.com
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-python
+Dynamic: summary
 
 # Pyshell
 
@@ -37,6 +44,9 @@ magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='i
 
 ## Changelog
 
+* 0.5.0 (2025-03-11)
+  * support of timeouts for run
+
 * 0.4.1 (2024-09-12)
   * fix capture handling
   * add failOnError option to rm commands

{libpyshell-0.4.1 → libpyshell-0.5.0}/setup.py

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

{libpyshell-0.4.1 → libpyshell-0.5.0}/src/__init__.py

@@ -227,7 +227,8 @@ def run(cmd: Union[list[str], str],
         decodeErrors: str='replace',
         decodeErrorsStdout: Optional[str]=None,
         decodeErrorsStderr: Optional[str]=None,
-        encodeErrorsStdin: Optional[str]=None
+        encodeErrorsStdin: Optional[str]=None,
+        timeout: Optional[int]=None
         ) -> RunResult:
     """Runs the given command.
 
@@ -258,7 +259,8 @@ def run(cmd: Union[list[str], str],
     * `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
-
+    * `timeout`: an optional timeout value in seconds. If a timeout occurs, the exit code will
+      be 124 (as for the unix timeout command)
     Returns:
       a `RunResult` value, given access to the captured stdout of the child process (if it was
       captured at all) and to the exit code of the child process.
@@ -315,11 +317,20 @@ def run(cmd: Union[list[str], str],
     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
+    try:
+        res = subprocess.run(cmd, shell=shell, input=input, stdout=stdout, stderr=stderr, cwd=cwd,
+                            env=runEnv, timeout=timeout)
+        out = res.stdout
+        err = res.stderr
+        exitcode = res.returncode
+        hadTimeout = False
+    except subprocess.TimeoutExpired as e:
+        out = e.stdout
+        err = e.stderr
+        exitcode = 124
+        hadTimeout = True
+    stdoutData = _massageOutput(out, encoding, decodeErrorsStdout or decodeErrors, captureStdout)
+    stderrData = _massageOutput(err, encoding, decodeErrorsStderr or decodeErrors, captureStderr)
     if onError == 'raise' and exitcode != 0:
         err = RunError(cmd, exitcode, stdoutData, stderrData)
         raise err