Rename src CoreLibs to corelibs

src/corelibs/script_handling/script_helpers.py

@@ -0,0 +1,97 @@
+"""
+Helper methods for scripts
+"""
+
+import time
+import os
+import sys
+from pathlib import Path
+import psutil
+
+
+def wait_abort(sleep: int = 5) -> None:
+    """
+    wait a certain time for an abort command
+
+    Keyword Arguments:
+        sleep {int} -- _description_ (default: {5})
+    """
+    try:
+        print(f"Waiting {sleep} seconds (Press CTRL +C to abort) [", end="", flush=True)
+        for _ in range(1, sleep):
+            print(".", end="", flush=True)
+            time.sleep(1)
+        print("]", flush=True)
+    except KeyboardInterrupt:
+        print("\nInterrupted by user")
+        sys.exit(0)
+    print("\n\n")
+
+
+def lock_run(lock_file: Path) -> None:
+    """
+    lock a script run
+    needed is the lock file name
+
+    Arguments:
+        lock_file {Path} -- _description_
+
+    Raises:
+        IOError: _description_
+        Exception: _description_
+        IOError: _description_
+    """
+    no_file = False
+    run_pid = os.getpid()
+    # or os.path.isfile()
+    try:
+        with open(lock_file, "r", encoding="UTF-8") as fp:
+            exists = False
+            pid = fp.read()
+            fp.close()
+            if pid:
+                # check if this pid exists
+                for proc in psutil.process_iter(['pid', 'name', 'cmdline']):
+                    try:
+                        if pid == proc.info['pid']:
+                            exists = True
+                            break
+                    except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
+                        # in case we cannot access
+                        continue
+            if not exists:
+                # no pid but lock file, unlink
+                try:
+                    lock_file.unlink()
+                    no_file = True
+                except IOError as e:
+                    raise IOError(f"Cannot remove lock_file: {lock_file}: {e}") from e
+            else:
+                raise IOError(f"Script is already running with PID {pid}")
+    except IOError:
+        no_file = True
+    if no_file:
+        try:
+            with open(lock_file, "w", encoding="UTF-8") as fp:
+                fp.write(str(run_pid))
+                fp.close()
+        except IOError as e:
+            raise IOError(f"Cannot open run lock file '{lock_file}' for writing: {e}") from e
+
+
+def unlock_run(lock_file: Path) -> None:
+    """
+    removes the lock file
+
+    Arguments:
+        lock_file {Path} -- _description_
+
+    Raises:
+        Exception: _description_
+    """
+    try:
+        lock_file.unlink()
+    except IOError as e:
+        raise IOError(f"Cannot remove lock_file: {lock_file}: {e}") from e
+
+# __END__