abstract-utilities 0.2.2.456__py3-none-any.whl → 0.2.2.458__py3-none-any.whl

abstract_utilities/file_utils/file_utils/__init__.py

@@ -5,3 +5,4 @@ from .map_utils import *
 from .pdf_utils import *
 from .file_reader import *
 from .find_collect import *
+from .type_checks import *

abstract_utilities/file_utils/file_utils/type_checks.py

@@ -0,0 +1,83 @@
+from .imports import *
+import subprocess, os
+from typing import Optional
+
+# --- Base remote checker -----------------------------------------------------
+def _remote_test(path: str, test_flag: str, user_at_host: str, timeout: int = 5) -> bool:
+    """
+    Run a remote shell test (e.g. -f, -d) via SSH.
+    Returns True if test succeeds, False otherwise.
+    """
+    cmd = f"[ {test_flag} {shlex.quote(path)} ] && echo 1 || echo 0"
+    try:
+        result = subprocess.check_output(
+            ["ssh", user_at_host, cmd],
+            stderr=subprocess.DEVNULL,
+            text=True,
+            timeout=timeout
+        ).strip()
+        return result == "1"
+    except Exception:
+        return False
+
+
+# --- Individual path checks --------------------------------------------------
+def is_remote_file(path: str, user_at_host: str) -> bool:
+    """True if remote path is a file."""
+    return _remote_test(path, "-f", user_at_host)
+
+
+def is_remote_dir(path: str, user_at_host: str) -> bool:
+    """True if remote path is a directory."""
+    return _remote_test(path, "-d", user_at_host)
+
+
+def is_local_file(path: str) -> bool:
+    """True if local path is a file."""
+    return os.path.isfile(path)
+
+
+def is_local_dir(path: str) -> bool:
+    """True if local path is a directory."""
+    return os.path.isdir(path)
+
+
+# --- Unified interface -------------------------------------------------------
+def is_file(path: str,*args, user_at_host: Optional[str] = None,**kwargs) -> bool:
+    """Determine if path is a file (works local or remote)."""
+    if user_at_host:
+        return is_remote_file(path, user_at_host)
+    return is_local_file(path)
+
+
+def is_dir(path: str, *args,user_at_host: Optional[str] = None,**kwargs)) -> bool:
+    """Determine if path is a directory (works local or remote)."""
+    if user_at_host:
+        return is_remote_dir(path, user_at_host)
+    return is_local_dir(path)
+
+
+# --- Optional: keep your original all-in-one wrapper ------------------------
+def check_path_type(
+    path: str,
+    user_at_host: Optional[str] = None,
+) -> str:
+    """
+    Return 'file', 'directory', 'missing', or 'unknown'.
+    Uses isolated is_file/is_dir functions.
+    """
+    if user_at_host:
+        if is_remote_file(path, user_at_host):
+            return "file"
+        elif is_remote_dir(path, user_at_host):
+            return "directory"
+        else:
+            return "missing"
+    else:
+        if os.path.isfile(path):
+            return "file"
+        elif os.path.isdir(path):
+            return "directory"
+        elif not os.path.exists(path):
+            return "missing"
+        return "unknown"

abstract_utilities/read_write_utils.py

@@ -12,16 +12,14 @@ Usage:
     from abstract_utilities.read_write_utils import *
 """
 
-import os, json
+import os
 from .ssh_utils.utils import run_cmd
+from .file_utils.file_utils.type_checks import is_file,is_dir
 from .abstract_classes import run_pruned_func
 _FILE_PATH_KEYS = ['file', 'filepath', 'file_path', 'path', 'directory', 'f', 'dst', 'dest']
 _CONTENTS_KEYS = ['cont', 'content', 'contents', 'data', 'datas', 'dat', 'src', 'source']
 
 
-
-META_SUFFIX = ".meta.json"
-
 # --- Helper utilities --------------------------------------------------------
 def string_in_keys(strings, kwargs):
     """Find a matching keyword in kwargs that contains any of the given substrings."""
@@ -76,28 +74,59 @@ def check_read_write_params(*args, **kwargs):
         raise ValueError("Missing file_path argument.")
     return file_path, contents
 
-
-def write_to_file(*args, **kwargs):
+def write_to_path(
+        file_path: str,
+        contents: str,
+        *,
+        user_at_host: str = None,
+        cwd: str | None = None,
+        password=None,
+        key=None,
+        env_path=None,
+        **kwargs
+    ) -> str:
     """
-    Write contents to a file and save optional metadata like user_at_host.
+    Completely overwrite a file (locally or remotely).
+    Supports sudo and password-based remote execution.
     """
-    file_path, contents = check_read_write_params(*args, **kwargs)
-    if contents is None:
-        raise ValueError("Missing contents to write.")
 
-    os.makedirs(os.path.dirname(file_path) or ".", exist_ok=True)
-    with open(file_path, "w", encoding="utf-8") as f:
-        f.write(str(contents))
+    # sanitize for shell safety
+    quoted_path = shlex.quote(file_path)
+    quoted_data = shlex.quote(str(contents))
 
-    # Store user_at_host metadata if provided
-    user_at_host = kwargs.get("user_at_host")
-    if user_at_host:
-        meta_path = file_path + META_SUFFIX
-        with open(meta_path, "w", encoding="utf-8") as m:
-            json.dump({"user_at_host": user_at_host}, m)
+    # shell command that fully overwrites
+    # (no append, replaces contents entirely)
+    base_cmd = f"echo {quoted_data} > {quoted_path}"
 
-    return file_path
-# --- Core functionality -------------------------------------------------------
+    # optional sudo password injection
+    full_cmd = get_print_sudo_cmd(
+        cmd=base_cmd,
+        password=password,
+        key=key,
+        env_path=env_path
+    )
+
+    # local or remote dispatch
+    if user_at_host:
+        return run_remote_cmd(
+            user_at_host=user_at_host,
+            cmd=full_cmd,
+            cwd=cwd,
+            password=password,
+            key=key,
+            env_path=env_path,
+            **kwargs
+        )
+    else:
+        return run_local_cmd(
+            cmd=full_cmd,
+            cwd=cwd,
+            password=password,
+            key=key,
+            env_path=env_path,
+            **kwargs
+        )
+### --- Core functionality -------------------------------------------------------
 ##def write_to_file(*args, **kwargs):
 ##    """
 ##    Write contents to a file (create if missing).
@@ -112,6 +141,32 @@ def write_to_file(*args, **kwargs):
 ##    with open(file_path, "w", encoding="utf-8") as f:
 ##        f.write(str(contents))
 ##    return file_path
+# --- Core functionality -------------------------------------------------------
+def write_to_file(*args, **kwargs):
+    """
+    Write contents to a file (create if missing).
+
+    Returns the file_path written.
+    """
+    file_path, contents = check_read_write_params(*args, **kwargs)
+    if contents is None:
+        raise ValueError("Missing contents to write.")
+    user_at_host = kwargs.get("user_at_host")
+    if user_at_host:
+        kwargs["cwd"] = kwargs.get('cwd') or os.path.dirname(file_path)
+        # sanitize for shell safety
+        quoted_path = shlex.quote(file_path)
+        quoted_data = shlex.quote(str(contents))
+        # shell command that fully overwrites
+        # (no append, replaces contents entirely)
+        kwargs["cmd"] = f"echo {quoted_data} > {quoted_path}"
+        return run_pruned_func(run_cmd,**kwargs)
+
+
+    os.makedirs(os.path.dirname(file_path) or ".", exist_ok=True)
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write(str(contents))
+    return file_path
 
 
 def read_from_file(file_path,**kwargs):

{abstract_utilities-0.2.2.456.dist-info → abstract_utilities-0.2.2.458.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: abstract_utilities
-Version: 0.2.2.456
+Version: 0.2.2.458
 Summary: abstract_utilities is a collection of utility modules providing a variety of functions to aid in tasks such as data comparison, list manipulation, JSON handling, string manipulation, mathematical computations, and time operations.
 Home-page: https://github.com/AbstractEndeavors/abstract_utilities
 Author: putkoff

{abstract_utilities-0.2.2.456.dist-info → abstract_utilities-0.2.2.458.dist-info}/RECORD

@@ -14,7 +14,7 @@ abstract_utilities/log_utils.py,sha256=W74Y-CmdQP4Kj88HmAgejVxWgyWlvgCKMwLvOfyFf
 abstract_utilities/math_utils.py,sha256=0o1ls1En03UAkYmxTBildCCJDfHygmNuvVnrNrLYtK0,6578
 abstract_utilities/parse_utils.py,sha256=Z5OGRwHuzCzY91fz0JJojk1BPAo1XF2quNNLuBF4_Vk,18602
 abstract_utilities/path_utils.py,sha256=X_U9cPBbNu5Wi0F3hQE0gXQX1gfhzxhxALbairTEOZU,19252
-abstract_utilities/read_write_utils.py,sha256=OeOzohHVpGnXYyA50aV4W_Xj6qarvwMhN9xNEy8KhW0,5254
+abstract_utilities/read_write_utils.py,sha256=UAtan9PUS3EPuGExEOSgOAq6NgSqdCkjrJ_-PIEUBbk,6860
 abstract_utilities/safe_utils.py,sha256=_uoZny6dJjopVakOiaf0UIZcvRRXMh51FpfDUooe0xY,3733
 abstract_utilities/string_clean.py,sha256=-gY9i2yqjX5UClvSaKsSrzA4GjR7eaNI3GnFjZpt2bo,5923
 abstract_utilities/string_utils.py,sha256=02xdIEDySWEexrtY3skBYOdeDmr3XgE5j1nqAeAv7w8,352
@@ -41,7 +41,7 @@ abstract_utilities/env_utils/imports/imports.py,sha256=ZrGEf-J2lyVbb4MrNBX3DwHR0
 abstract_utilities/env_utils/imports/utils.py,sha256=oB7WhIm_-cHLrUHRXypZGCdWUtNRyePaVO5_kq5Cv84,4490
 abstract_utilities/file_utils/__init__.py,sha256=I4md5xU5nuBuKyxumvKmnrR0-UgBePX9QfY-QNS-Zso,101
 abstract_utilities/file_utils/req.py,sha256=CsdGHAWIHOLqjzyoOSZ7XYbNciVYnTgaUs5qOCHttE0,11837
-abstract_utilities/file_utils/file_utils/__init__.py,sha256=FjtDxrP7FGqSz6iF8zp_VJdtrWpTnEZmDO2JMUrqV9w,188
+abstract_utilities/file_utils/file_utils/__init__.py,sha256=WOsWvRf7lomRoS80xT1n-R0jvbyHsxPXMsdoPAN62cc,215
 abstract_utilities/file_utils/file_utils/file_filters.py,sha256=khfbonAPEAhW1wxfFo0I4dawYPCrIKEjNc7VKb1RvzA,3437
 abstract_utilities/file_utils/file_utils/file_reader.py,sha256=2MRj2PGKq4C-iKL8dmhHwWnhmA8GPVsNaWkTREOF9vo,24545
 abstract_utilities/file_utils/file_utils/file_utils.py,sha256=2aVuD0sB-P2gmo_kUsE11aHc6WzLvHUAerMkmy3y9vk,7751
@@ -50,6 +50,7 @@ abstract_utilities/file_utils/file_utils/find_collect.py,sha256=bPM7EDrNHlvwZx7C
 abstract_utilities/file_utils/file_utils/imports.py,sha256=SXCMBuHUwqXbfRBk4LjKehsBKZa8-Po5UfEcNTwn4Es,24
 abstract_utilities/file_utils/file_utils/map_utils.py,sha256=B_MlkLP8s-o0yU0R3Y2LcTpBntBzysJO18qq181xz9c,1043
 abstract_utilities/file_utils/file_utils/pdf_utils.py,sha256=D_wg8h-SapCvqinxRIKxMri1jWZNpr5jGvKq9EJePfY,10335
+abstract_utilities/file_utils/file_utils/type_checks.py,sha256=g5-Pwham8Ax6axfwkv4JA6hNdkz7I-Gf2H0YaIbW5ew,2626
 abstract_utilities/file_utils/imports/__init__.py,sha256=VWN_3t0gRSYCalXI0nRLEUB3O2kbqA_Y8wnFq_m5F7A,131
 abstract_utilities/file_utils/imports/classes.py,sha256=zw16D_h5AxJiks4ydbqkWkXVfvgmE-BpiC4eKInY_KI,12259
 abstract_utilities/file_utils/imports/constants.py,sha256=eIeSj48vtfa8CTYKuuZXbgJQepBrMracfVguaSuN41U,1626
@@ -78,7 +79,7 @@ abstract_utilities/ssh_utils/classes.py,sha256=3Q9BfLpyagNFYyiF4bt-5UCezeUJv9NK9
 abstract_utilities/ssh_utils/imports.py,sha256=oX8WAv-pkhizzko_h3fIUp9Vhsse4nR7RN2vwONxIx0,317
 abstract_utilities/ssh_utils/pexpect_utils.py,sha256=JBdOIXBTXAqE5TrsFjmPWJgwSaWyRJN8rbJ6y3_zKPY,10556
 abstract_utilities/ssh_utils/utils.py,sha256=smUWAx3nW1h0etTndJ_te9bkUX5YzQ8kYd9_gD1TXLk,4882
-abstract_utilities-0.2.2.456.dist-info/METADATA,sha256=7xIkE91A13osv1AF4TpEe6an6XkbK0z2j8Sgo9ovrco,28108
-abstract_utilities-0.2.2.456.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-abstract_utilities-0.2.2.456.dist-info/top_level.txt,sha256=BF0GZ0xVFfN1K-hFIWPO3viNsOs1sSF86n1vHBg39FM,19
-abstract_utilities-0.2.2.456.dist-info/RECORD,,
+abstract_utilities-0.2.2.458.dist-info/METADATA,sha256=MIT6HiI0-qSgcKCCOLaltyuBOBlRLIihTERdENlK-h4,28108
+abstract_utilities-0.2.2.458.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+abstract_utilities-0.2.2.458.dist-info/top_level.txt,sha256=BF0GZ0xVFfN1K-hFIWPO3viNsOs1sSF86n1vHBg39FM,19
+abstract_utilities-0.2.2.458.dist-info/RECORD,,