libPyshell 0.4.0__tar.gz → 0.5.0__tar.gz

{libPyshell-0.4.0/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.0
+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,13 @@ 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
+
 * 0.4.0 (2024-03-20)
   * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
     disappear.

{libPyshell-0.4.0 → libpyshell-0.5.0}/README.md

@@ -26,6 +26,13 @@ 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
+
 * 0.4.0 (2024-03-20)
   * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
     disappear.

{libPyshell-0.4.0 → 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.0
+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,13 @@ 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
+
 * 0.4.0 (2024-03-20)
   * re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to
     disappear.

{libPyshell-0.4.0 → libpyshell-0.5.0}/setup.py

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

{libPyshell-0.4.0 → libpyshell-0.5.0}/src/__init__.py

@@ -197,7 +197,7 @@ def _handleCapture(capture: CaptureType) -> Optional[_FILE]:
         return subprocess.PIPE
     elif callable(capture):
         return subprocess.PIPE
-    elif capture is None:
+    elif capture == False:
         return None
     else:
         return capture
@@ -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
@@ -430,13 +441,15 @@ def removeFile(path: str):
 
 def cp(src: str, target: str):
     """
-    Copy `src` to `target`.
+    Copy `src` to `target`. Behaves like the cp shell command.
 
     * If `src` is a file and `target` is a file: overwrites `target`.
     * If `src` is a file and `target` is a dirname: places the copy in directory `target`,
       with the basename of `src.
-    * If `src` is a directory then `target` must also be a directory: copies
-      the `src` directory (*not* its content) to `target`.
+    * If `src` is a directory and `target` exists, then `target` must also be a directory:
+      copies the `src` directory (*not* its content) to `target`.
+    * If `src` is a directory and `target` does not exist: copies the `src` directory
+      and names the copy `target`.
     """
     if isFile(src):
         if isDir(target):
@@ -511,22 +524,34 @@ class workingDir:
         cd(self.old_dir)
         return False # reraise expection
 
-def rm(path: str, force: bool=False):
+def rm(path: str, force: bool=False, failOnError: bool=True):
     """
     Remove the file at `path`.
     """
     if force and not exists(path):
         return
-    os.remove(path)
+    try:
+        os.remove(path)
+    except Exception as e:
+        if failOnError:
+            raise
+        else:
+            sys.stderr.write(str(e) + '\n')
 
-def rmdir(d: str, recursive: bool=False):
+def rmdir(d: str, recursive: bool=False, failOnError: bool=True):
     """
     Remove directory `d`. Set `recursive=True` if the directory is not empty.
     """
-    if recursive:
-        shutil.rmtree(d)
-    else:
-        os.rmdir(d)
+    try:
+        if recursive:
+            shutil.rmtree(d)
+        else:
+            os.rmdir(d)
+    except Exception as e:
+        if failOnError:
+            raise
+        else:
+            sys.stderr.write(str(e) + '\n')
 
 # See https://stackoverflow.com/questions/9741351/how-to-find-exit-code-or-reason-when-atexit-callback-is-called-in-python
 class _ExitHooks(object):
@@ -581,7 +606,7 @@ def _registerAtExit(action: Any, mode: AtExitMode):
 def mkTempFile(suffix: str='', prefix: str='',
                dir:Optional[str]=None,
                deleteAtExit:AtExitMode=True):
-    """Create a temporary file.
+    """Create a temporary file name.
 
     `deleteAtExit` controls if and how the file is deleted once the shell sript terminates.
    It has one of the following values.
@@ -596,7 +621,7 @@ def mkTempFile(suffix: str='', prefix: str='',
     if deleteAtExit:
         def action():
             if isFile(f):
-                rm(f)
+                rm(f, failOnError=False)
         _registerAtExit(action, deleteAtExit)
     return f
 
@@ -610,7 +635,7 @@ def mkTempDir(suffix: str='', prefix: str='tmp',
     if deleteAtExit:
         def action():
             if isDir(d):
-                rmdir(d, True)
+                rmdir(d, recursive=True, failOnError=False)
         _registerAtExit(action, deleteAtExit)
     return d
 
@@ -646,7 +671,7 @@ class tempDir:
             return False # reraise
         if self.delete:
             if isDir(self.dir_to_delete):
-                rmdir(self.dir_to_delete, recursive=True)
+                rmdir(self.dir_to_delete, recursive=True, failOnError=False)
         return False # reraise expection
 
 def ls(d: str, *globs: str) -> list[str]: