abstract-utilities 0.2.2.486__py3-none-any.whl → 0.2.2.593__py3-none-any.whl

abstract_utilities/safe_utils/safe_utils.py

@@ -0,0 +1,166 @@
+"""
+abstract_safeops.py
+-------------------
+Utility functions for safely splitting, slicing, and retrieving elements from iterable or string objects
+without raising exceptions on invalid input or out-of-range indices.
+
+Designed for compatibility with the abstract_ ecosystem (e.g. abstract_utilities, abstract_math, etc.).
+"""
+
+from .imports import *
+_BASE_DIR = get_caller_dir()
+
+class PathOutsideBase(Exception):
+    pass
+
+def safe_join_base(base: Union[str, Path], *parts: Union[str, Path], must_exist: bool = False) -> Path:
+    """
+    Join base with parts, normalize, and ensure the result lives under base.
+    Prevents '../' traversal and ignores leading slashes in parts.
+    """
+    base = Path(base).resolve(strict=True)
+    # Disallow absolute/drive-anchored parts by stripping their anchors before joining.
+    cleaned = []
+    for p in parts:
+        p = Path(p)
+        # Convert absolute to relative (security: we won't allow escaping base anyway)
+        if p.is_absolute():
+            p = Path(*p.parts[1:])  # drop leading '/'
+        cleaned.append(p)
+
+    # Build and resolve (non-strict so missing files are allowed unless must_exist=True)
+    target = (base.joinpath(*cleaned)).resolve(strict=False)
+
+    # Containment check (works even if target doesn't exist)
+    try:
+        target.relative_to(base)
+    except ValueError:
+        raise PathOutsideBase(f"{target} escapes base {base}")
+
+    if must_exist and not target.exists():
+        raise FileNotFoundError(target)
+
+    return target
+def safe_split(
+    string: Any,
+    char: Any,
+    i: Optional[int] = None,
+    default: Union[bool, Any] = False
+) -> Union[str, List[str], Any, None]:
+    """
+    Safely split a string by a character and optionally return index i.
+
+    Args:
+        string: Input string (or any object convertible to string).
+        char: Delimiter to split on.
+        i: Optional index to retrieve from the split result.
+        default: If True, return the original string on error. 
+                 If any other value, return that instead of raising.
+
+    Returns:
+        The split list, or the element at index i, or default behavior on error.
+    """
+    if string is None or char is None:
+        return string
+
+    s, c = str(string), str(char)
+    if c not in s:
+        return string
+
+    parts = s.split(c)
+
+    if i is None:
+        return parts
+
+    if is_number(i):
+        idx = int(i)
+        if 0 <= idx < len(parts):
+            return parts[idx]
+
+    if default:
+        return string if default is True else default
+
+    return None
+
+
+def safe_slice(
+    obj: Any,
+    i: Optional[int] = None,
+    k: Optional[int] = None,
+    default: Union[bool, Any] = False
+) -> Any:
+    """
+    Safely slice an iterable object or string, with fallback behavior on invalid indices.
+
+    Args:
+        obj: Iterable or string-like object.
+        i: Start index (can be negative).
+        k: End index (can be negative).
+        default: If True, returns the original object on error.
+                 If any other value, return that value on error.
+
+    Returns:
+        The sliced object, or default behavior on error.
+    """
+    # Null or invalid base case
+    if obj is None or isinstance(obj, bool):
+        return obj if default is True else default if default else None
+
+    # Non-iterable guard
+    if not hasattr(obj, "__getitem__"):
+        return obj if default is True else default if default else None
+
+    obj_len = len(obj)
+
+    # Normalize negative indices
+    if isinstance(i, int) and i < 0:
+        i = obj_len + i
+    if isinstance(k, int) and k < 0:
+        k = obj_len + k
+
+    # Bound indices
+    if i is not None:
+        i = max(0, min(i, obj_len))
+    if k is not None:
+        k = max(0, min(k, obj_len))
+
+    try:
+        return obj[i:k]
+    except Exception:
+        return obj if default is True else default if default else None
+
+def safe_join(*paths):
+    paths = list(paths)
+    paths = [path for path in paths if path]
+    return os.path.join(*paths)
+def safe_get(
+    obj: Any,
+    key: Union[int, str, None] = None,
+    default: Union[bool, Any] = False
+) -> Any:
+    """
+    Generalized safe getter for both indexable and mapping types.
+
+    Args:
+        obj: The object to access (list, dict, string, etc.).
+        key: Index or key to retrieve.
+        default: Fallback value or True for "return obj".
+
+    Returns:
+        Retrieved element, or default value on failure.
+    """
+    if obj is None or key is None:
+        return obj if default is True else default if default else None
+
+    try:
+        if isinstance(obj, dict):
+            return obj.get(key, obj if default is True else default if default else None)
+        return obj[key]
+    except Exception:
+        return obj if default is True else default if default else None
+def get_slash(path):
+    if '/' in path:
+        return '/'
+    else:
+        return '//'
+join_path=safe_join

abstract_utilities/ssh_utils/__init__.py

@@ -1,3 +1,5 @@
+from .imports import *
 from .classes import *
-from .utils import *
+from .cmd_utils import *
 from .pexpect_utils import *
+from .type_checks import *

abstract_utilities/ssh_utils/classes.py

@@ -1,5 +1,4 @@
 from .imports import *
-from .utils import run_local_cmd, run_ssh_cmd,run_any_cmd,run_cmd
 
 class PathBackend(Protocol):
     def join(self, *parts: str) -> str: ...

abstract_utilities/ssh_utils/cmd_utils.py

@@ -0,0 +1,207 @@
+from .imports import *
+def get_output(p):
+    """
+    Get the output of a subprocess command.
+
+    This function takes a subprocess Popen object as an argument and returns
+    the output generated by the command's execution.
+
+    Args:
+        p (subprocess.Popen): A Popen object representing a subprocess command.
+
+    Returns:
+        tuple: A tuple containing the standard output and standard error streams
+               of the executed command.
+    """
+    return p.communicate()
+
+def get_cmd_out(st):
+    """
+    Get the output of a shell command.
+
+    This function executes a shell command using the 'cmd_input' function and
+    retrieves the output generated by the command's execution.
+
+    Args:
+        st (str): The shell command to execute.
+
+    Returns:
+        tuple: A tuple containing the standard output and standard error streams
+               of the executed shell command.
+    """
+    return get_output(cmd_input(st))
+def cmd_input(st):
+    """
+    Execute a shell command using subprocess.
+
+    Args:
+    - st (str): Command to be executed.
+
+    Returns:
+    - subprocess.Popen: A Popen object for communication.
+    """
+    return subprocess.Popen(st, stdout=subprocess.PIPE, shell=True)
+def get_output_text(parent_dir: str = os.getcwd()) -> str:
+    """
+    Get the path to the 'output.txt' file in the given directory.
+
+    Args:
+        parent_dir (str, optional): Directory path. Defaults to the current working directory.
+
+    Returns:
+        str: Path to the 'output.txt' file.
+    """
+    return os.path.join(parent_dir,'output.txt')
+def get_env_value(key: str = None, env_path: str = None) -> str:
+    """
+    Retrieve environment value based on a key from a specified .env file.
+
+    Args:
+        key (str, optional): Environment key to search for. Defaults to None.
+        env_path (str, optional): Path to start searching for the .env file. Defaults to None.
+
+    Returns:
+        str: Value corresponding to the given environment key.
+    """
+    args={}
+    if key != None:
+        args["key"]=key
+    if env_path != None:
+        args["start_path"]=env_path
+    return find_and_read_env_file(**args)
+def print_cmd(input: str, output: str) -> None:
+    """
+    Print the input command and its corresponding output.
+
+    Args:
+        input (str): The command that was run.
+        output (str): Output produced by the command.
+    """
+    print(f"Command Line Arguments: {input}")
+    print(f"Output:\n{output}")
+def get_sudo_password(key: str = "SUDO_PASSWORD") -> str:
+    """
+    Retrieve the sudo password from an environment file.
+
+    Args:
+        key (str, optional): Environment key for the sudo password. Defaults to "SUDO_PASSWORD".
+
+    Returns:
+        str: The sudo password.
+    """
+    return find_and_read_env_file(key=key)
+def cmd_run_sudo(cmd: str, password: str = None, key: str = None, output_text: str = None) -> None:
+    """
+    Execute a command with sudo privileges using either provided password or retrieving it from an environment file.
+
+    Args:
+        cmd (str): Command to be executed.
+        password (str, optional): Password for sudo. Defaults to None.
+        key (str, optional): Environment key to retrieve sudo password. Defaults to None.
+        output_text (str, optional): Path to store the command output. Defaults to None.
+    """
+    if password !=None:
+        cmd_run(f'echo "{password}" | sudo -S -k {cmd}',output_text)
+    elif key != None:
+        cmd_run(f'echo "{get_env_value(key)}" | sudo -S -k {cmd}',output_text)
+    else:
+        cmd_run(f'echo "{get_sudo_password()}" | sudo -S -k {cmd}',output_text)
+def cmd_run(cmd: str, output_text: str = None, print_output: bool = False) -> None:
+    if output_text is None:
+        output_text = get_output_text()
+
+    # Clear output file
+    with open(output_text, 'w') as f:
+        pass
+
+    # Append output redirection
+    full_cmd = f'{cmd} >> {output_text}; echo END_OF_CMD >> {output_text}'
+
+    if print_output:
+        print(full_cmd)
+
+    subprocess.call(full_cmd, shell=True)
+
+    # Wait until END_OF_CMD appears
+    while True:
+        get_sleep(sleep_timer=0.5)
+        with open(output_text, 'r') as f:
+            lines = f.readlines()
+            if lines and lines[-1].strip() == 'END_OF_CMD':
+                break
+
+    if print_output:
+        with open(output_text, 'r') as f:
+            print_cmd(full_cmd, f.read().strip())
+
+    os.remove(output_text)
+
+def pexpect_cmd_with_args(command: str, child_runs: list, output_text: str = os.getcwd(),print_output:bool=False) -> int:
+    """
+    Run a command using pexpect and handle its prompts with specified responses.
+
+    Args:
+        command (str): Command to be executed.
+        child_runs (list): List of prompts and their respective responses.
+        output_text (str, optional): Path to store the command output. Defaults to the current working directory.
+
+    Returns:
+        int: Exit status of the command.
+    """
+    child = pexpect.spawn(command)
+
+    for each in child_runs:
+        # Wait for the process to prompt for the input and respond with it
+        child.expect(each["prompt"])
+
+        # Respond with the corresponding input
+        if each["pass"] is not None:
+            pass_phrase = each["pass"]
+        else:
+            args = {}
+            if "key" in each:
+                if each["key"] is not None:
+                    args["key"] = each["key"]
+            if "env_path" in each:
+                if each["env_path"] is not None:
+                    args["start_path"] = each["env_path"]
+
+            pass_phrase = get_env_value(**args)
+
+        child.sendline(pass_phrase)
+        if print_output:
+            print("Output after handling prompt:")
+            print(each["prompt"])
+
+    # Wait for the process to finish
+    child.expect(pexpect.EOF)
+    output = child.before.decode("utf-8")
+
+    # Write output to the output file
+    with open(get_output_text(), "w") as f:
+        f.write(output)
+    if print_output:
+        print_cmd(command, output)
+
+    return child.exitstatus
+def get_user_pass_host_key(**kwargs):
+    args = ['password','user_at_host','host','key','user']
+    kwargs['del_kwarg']=kwargs.get('del_kwarg',False)
+    values,kwargs = get_from_kwargs(*args,**kwargs)
+    return values
+
+# --- Base remote checker -----------------------------------------------------
+def _remote_test(path: str, test_flag: str, timeout: int = 5,*args, **kwargs) -> bool:
+    """
+    Run a remote shell test (e.g. -f, -d) via SSH.
+    Returns True if test succeeds, False otherwise.
+    """
+    try:
+        kwargs['cmd']=f"[ {test_flag} {shlex.quote(path)} ] && echo 1 || echo 0"
+        kwargs['text']=True
+        kwargs['timeout']=timeout
+        kwargs['stderr']=subprocess.DEVNULL
+        result = run_pruned_func(run_cmd,**kwargs)
+        return result.strip() == "1"
+    except Exception:
+        return False

abstract_utilities/ssh_utils/imports/__init__.py

@@ -0,0 +1,3 @@
+from .imports import *
+from .module_imports import *
+from .utils import *

abstract_utilities/ssh_utils/imports/imports.py

@@ -0,0 +1,5 @@
+# remote_fs.py
+from __future__ import annotations
+from typing import *
+from ...imports import shlex, os,subprocess,pexpect, fnmatch, glob, posixpath, re
+

abstract_utilities/ssh_utils/imports/module_imports.py

@@ -0,0 +1,6 @@
+from ...string_utils import get_from_kwargs,eatAll,eatOuter
+from ...type_utils import make_list  # whatever you already have
+from ...time_utils import get_sleep
+from abstract_security import *
+
+from ...class_utils import get_caller, get_caller_path, get_caller_dir,SingletonMeta,run_pruned_func

abstract_utilities/ssh_utils/imports/utils.py

@@ -0,0 +1,189 @@
+from .imports import *
+from .module_imports import *
+def get_pass_from_key(key=None,env_path=None):
+    if key:
+        return get_env_value(key=key,path=env_path)
+def get_password(password=None,key=None,env_path=None):
+    password = password or get_pass_from_key(key=key,env_path=env_path)
+    return password
+
+def get_print_sudo_cmd(
+        cmd: str,
+        password=None,
+        key=None,
+        env_path=None
+    ):
+    password = get_password(password=password,key=key,env_path=env_path)
+    if password != None:
+        
+        cmd = get_password_cmd(password=password,cmd=cmd)
+    return cmd
+def get_password_cmd(password:str,cmd:str):
+    sudo_cmd = get_sudo_cmd(cmd)
+    password_sudo_cmd = get_raw_password_sudo_cmd(password=password,sudo_cmd=sudo_cmd)
+    return password_sudo_cmd
+def get_sudo_cmd(cmd: str):
+    return f"sudo -S -k {cmd}"
+def get_raw_password_sudo_cmd(password:str,sudo_cmd:str):
+    return f"printf %s {shlex.quote(password)} | {sudo_cmd}"
+def get_remote_bash(
+            cmd: str,
+            cwd: str | None = None
+        ):
+    return f"bash -lc {shlex.quote((f'cd {shlex.quote(cwd)} && {cmd}') if cwd else cmd)}"
+def get_remote_ssh(
+            user_at_host: str=None,
+            remote:str=None
+        ):
+    return f"ssh {shlex.quote(user_at_host)} {shlex.quote(remote)}"
+def get_remote_cmd(
+            cmd: str,
+            user_at_host: str,
+            cwd: str | None = None,
+            password=None,
+            key=None,
+            env_path=None
+            
+        ):
+    cmd = get_print_sudo_cmd(
+            cmd=cmd,
+            password=password,
+            key=key,
+            env_path=env_path
+        )
+    remote = get_remote_bash(
+        cmd=cmd,
+        cwd=cwd
+        )
+    full = get_remote_ssh(
+        user_at_host=user_at_host,
+        remote=remote
+        )
+    return full
+
+
+def execute_cmd(
+        *args,
+        outfile=None,
+        **kwargs
+    ) -> str:
+    proc = subprocess.run(*args, **kwargs)
+    output = (proc.stdout or "") + (proc.stderr or "")
+    if outfile:
+        try:
+            with open(outfile, "w", encoding="utf-8", errors="ignore") as f:
+                f.write(output)
+        except Exception:
+            pass
+    return output
+
+def run_local_cmd(
+        cmd: str,
+        cwd: str | None = None,
+        outfile: Optional[str] = None,
+        shell=True,
+        text=True,
+        capture_output=True,
+        user_at_host: str=None,
+        password=None,
+        key=None,
+        env_path=None
+    ) -> str:
+    cmd = get_print_sudo_cmd(
+            cmd=cmd,
+            password=password,
+            key=key,
+            env_path=env_path
+        )
+    return execute_cmd(
+            cmd,
+            outfile=outfile,
+            shell=shell,
+            cwd=cwd,
+            text=text,
+            capture_output=capture_output
+        )
+
+def run_remote_cmd(
+        user_at_host: str,
+        cmd: str,
+        cwd: str | None = None,
+        outfile: Optional[str] = None,
+        shell=True,
+        text=True,
+        capture_output=True,
+        password=None,
+        key=None,
+        env_path=None
+    ) -> str:
+    """
+    Run on remote via SSH; capture stdout+stderr locally; write to local outfile.
+    NOTE: we do *not* try to write the file on the remote to avoid later scp.
+    """
+    cmd = get_print_sudo_cmd(
+            cmd=cmd,
+            password=password,
+            key=key,
+            env_path=env_path
+        )
+    # wrap in bash -lc for PATH/profile + allow 'cd && ...'
+    cmd = get_remote_cmd(
+        cmd=cmd,
+        user_at_host=user_at_host,
+        cwd=cwd
+        )
+    return execute_cmd(
+            cmd,
+            outfile=outfile,
+            shell=shell,
+            text=text,
+            capture_output=capture_output
+        )
+
+def run_cmd(
+        cmd: str=None,
+        cwd: str | None = None,
+        outfile: Optional[str] = None,
+        shell=True,
+        text=True,
+        capture_output=True,
+        user_at_host: str=None,
+        password=None,
+        key=None,
+        env_path=None
+    ) -> str:
+
+    if user_at_host:
+        return run_ssh_cmd(
+                user_at_host=user_at_host,
+                cmd=cmd,
+                cwd=cwd,
+                outfile=outfile,
+                shell=shell,
+                text=text,
+                capture_output=capture_output,
+                password=password,
+                key=key,
+                env_path=env_path
+            )
+    return run_local_cmd(
+            cmd=cmd,
+            cwd=cwd,
+            outfile=outfile,
+            shell=shell,
+            text=text,
+            capture_output=capture_output,
+            password=password,
+            key=key,
+            env_path=env_path
+        )
+run_ssh_cmd = run_remote_cmd
+remote_cmd = run_remote_cmd
+ssh_cmd = run_remote_cmd
+
+local_cmd = run_local_cmd
+
+
+run_any_cmd = run_cmd
+any_cmd = run_cmd
+cmd_run = run_cmd

abstract_utilities/ssh_utils/pexpect_utils.py

@@ -1,6 +1,4 @@
-from .classes import *
-from .utils import *
-from ..env_utils import *
+from .imports import *
 # pexpect is optional; import lazily if you prefer
 
 # keep your execute_cmd; add a thin wrapper that supports stdin text cleanly
@@ -36,17 +34,17 @@ def exec_sudo_capture(
     """
     if password is None:
         password = get_env_value(key=key) if key else get_sudo_password()
-    password = f"{password}\n" if password else password
+
     sudo_cmd = f"sudo -S -k {cmd}"
 
     if user_at_host:
         # build the remote command (bash -lc + optional cd)
         remote = get_remote_cmd(cmd=sudo_cmd, user_at_host=user_at_host, cwd=cwd)
         # feed password to remote's stdin (ssh forwards stdin)
-        out = execute_cmd_input(remote, input_text=password,
+        out = execute_cmd_input(remote, input_text=password + "\n",
                                 shell=True, text=True, capture_output=True)
     else:
-        out = execute_cmd_input(sudo_cmd, input_text=password,
+        out = execute_cmd_input(sudo_cmd, input_text=password + "\n",
                                 shell=True, text=True, capture_output=True, cwd=cwd)
 
     if print_output:
@@ -123,8 +121,8 @@ def cmd_run(
             out = execute_cmd(remote, shell=True, text=True, capture_output=True)
         else:
             out = execute_cmd(cmd, shell=True, text=True, capture_output=True, cwd=cwd)
-##        if print_output:
-##            print_cmd(cmd, out or "")
+        if print_output:
+            print_cmd(cmd, out or "")
         return out or ""
 
     # ---- legacy file-backed path (unchanged in spirit) ----
@@ -150,10 +148,9 @@ def cmd_run(
             if lines and lines[-1].strip() == 'END_OF_CMD':
                 break
 
-##    if print_output:
-##        print(full_cmd)
-##        with open(output_text, 'r') as f:
-##            print_cmd(full_cmd, f.read().strip())
+    if print_output:
+        with open(output_text, 'r') as f:
+            print_cmd(full_cmd, f.read().strip())
 
     try:
         os.remove(output_text)
@@ -212,8 +209,8 @@ def exec_expect(
 
     child.expect(pexpect.EOF)
     out = child.before.decode("utf-8", errors="ignore")
-##    if print_output:
-##        print_cmd(command, out)
+    if print_output:
+        print_cmd(command, out)
 
     return child.exitstatus if child.exitstatus is not None else 0
 
@@ -261,7 +258,6 @@ def cmd_run_sudo(
     remote_sudo_line = f'printf %s {shlex.quote(pw)} | {sudo_cmd}'
     remote_full = get_remote_cmd(cmd=remote_sudo_line, user_at_host=user_at_host, cwd=cwd)
     return cmd_run(remote_full, output_text=output_text, print_output=print_output)
-
 def pexpect_cmd_with_args(
     command: str,
     child_runs: list,
@@ -310,6 +306,3 @@ def pexpect_cmd_with_args(
     else:
         if print_output:
             print_cmd(command, out)
-
-    return child.exitstatus if child.exitstatus is not None else 0
-cmd_input = execute_cmd_input