replbase 0.0.24__tar.gz → 0.0.25__tar.gz

{replbase-0.0.24 → replbase-0.0.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: replbase
-Version: 0.0.24
+Version: 0.0.25
 Summary: "Combination of other REPL tools into a reusable class that generates a REPL"
 License: MIT
 Author: Joseph Bochinski
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: prompt-toolkit (>=3.0.48,<4.0.0)
 Requires-Dist: ptpython (>=3.0.29,<4.0.0)
 Requires-Dist: rich (>=13.9.4,<14.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Description-Content-Type: text/markdown
 
 # replbase

{replbase-0.0.24 → replbase-0.0.25}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "replbase"
-version = "0.0.24"
+version = "0.0.25"
 description = "\"Combination of other REPL tools into a reusable class that generates a REPL\""
 authors = [ "Joseph Bochinski <stirgejr@gmail.com>",]
 license = "MIT"
@@ -15,3 +15,4 @@ python = "^3.12"
 prompt-toolkit = "^3.0.48"
 ptpython = "^3.0.29"
 rich = "^13.9.4"
+tabulate = "^0.9.0"

{replbase-0.0.24 → replbase-0.0.25}/replbase/repl_base.py

@@ -15,9 +15,14 @@
 from __future__ import annotations
 
 import argparse
+import grp
+import math
 import os
+import pwd
 import re
 import shlex
+import stat
+import time
 
 from dataclasses import dataclass, field
 from typing import Any, Callable, Literal
@@ -32,6 +37,7 @@ from prompt_toolkit.styles import Style
 from ptpython.repl import embed
 from rich.console import Console
 from rich.theme import Theme
+from tabulate import tabulate
 
 # endregion Imports
 
@@ -49,6 +55,77 @@ def is_num_str(val: str) -> bool:
     return bool(re.match(r"^-?\d+(\.\d+)?$", val))
 
 
+def ls_liah(path: str = "."):
+    """Print output similar to using `ls -liah` in the terminal"""
+
+    files = os.listdir(path)
+    files_info = []
+
+    for file_name in files:
+        # Get the full path
+        full_path = os.path.join(path, file_name)
+
+        # Get file stats
+        file_stat = os.lstat(full_path)
+
+        # Get permissions
+        permissions = stat.filemode(file_stat.st_mode)
+
+        # Get number of hard links
+        hard_links = file_stat.st_nlink
+
+        # Get UID and GID, convert to names
+        uid_name = pwd.getpwuid(file_stat.st_uid).pw_name
+        gid_name = grp.getgrgid(file_stat.st_gid).gr_name
+
+        # Get file size
+        size = file_stat.st_size
+
+        # Convert size to human-readable form
+        size_human = convert_size(size)
+
+        # Get last modification time
+        mtime = time.strftime("%Y-%m-%d %H:%M", time.localtime(file_stat.st_mtime))
+
+        # Append the information
+        files_info.append(
+            [
+                file_stat.st_ino,
+                permissions,
+                hard_links,
+                uid_name,
+                gid_name,
+                size_human,
+                mtime,
+                file_name,
+            ]
+        )
+
+    # Print in tabular format
+    headers = [
+        "Inode",
+        "Permissions",
+        "Links",
+        "UID",
+        "GID",
+        "Size",
+        "Last Modified",
+        "Name",
+    ]
+    print(tabulate(files_info, headers=headers, tablefmt="plain"))
+
+
+def convert_size(size_bytes):
+    """Convert a size in bytes to a human-readable string."""
+    if size_bytes == 0:
+        return "0B"
+    size_name = ("B", "K", "M", "G", "T", "P", "E", "Z", "Y")
+    i = int(math.floor(math.log(size_bytes, 1024)))
+    p = math.pow(1024, i)
+    s = round(size_bytes / p, 2)
+    return f"{s}{size_name[i]}"
+
+
 @dataclass
 class ReplTheme(Theme):
     title: str = "bold cyan"
@@ -332,6 +409,76 @@ class ReplBase:
         self.commands[cmd_name] = new_cmd
         return new_cmd
 
+    def setup_cmds(self, *cmd_names: list[str]) -> None:
+        """Automatically configure commands based on the provided names
+            The ReplCommand objects are populated based on function meta
+            data retrieved from the provided function names
+        Args:
+            cmd_names (list[str]): List of class methods to convert to REPL commands
+        """
+
+        funcs: list[Callable] = [
+            getattr(self, name)
+            for name in cmd_names
+            if hasattr(self, name) and callable(getattr(self, name))
+        ]
+
+        for func in funcs:
+            help_text = func.__doc__
+            name = func.__name__
+            self.add_command(name, func, help_txt=help_text)
+
+    def warn(self, msg: str) -> None:
+        """Print a message to the REPL preformatted as a warning"""
+
+        self.print(f"[warn]{msg}[/warn]")
+
+    def pretty_print(self, obj: Any) -> None:
+        pretty.pprint(obj)
+
+    def pwd(self) -> str:
+        """Print out the current path location
+
+        Returns:
+            str: The current path
+        """
+
+        self.print(f"Current location: {os.getcwd()}")
+        return os.getcwd()
+
+    def cd(self, path: str = "..") -> str:
+        """Move the terminal to a new path location
+
+        Args:
+            path (str, optional): Path to move to. Defaults to "..".
+
+        Returns:
+            str: The new location
+        """
+
+        try:
+            os.chdir(path)
+        except FileNotFoundError:
+            self.warn(
+                f"Path: {path} does not exist, remaining in current directory"
+            )
+        new_pwd = os.getcwd()
+        self.print(f"New dir: {new_pwd}")
+        return new_pwd
+
+    def ls(self, path: str = ".") -> list[str]:
+        """List metadata about the files/directories at the given path
+
+        Args:
+            path (str, optional): Path to list. Defaults to ".".
+
+        Returns:
+            list[str]: List of file and directory names at the location
+        """
+
+        ls_liah(path)
+        return os.listdir(path)
+
     def interactive(self, *args, **kwargs) -> None:
         """Starts an interactive session from within the class"""
         if kwargs: