replbase 0.0.17__tar.gz → 0.0.18__tar.gz

{replbase-0.0.17 → replbase-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: replbase
-Version: 0.0.17
+Version: 0.0.18
 Summary: "Combination of other REPL tools into a reusable class that generates a REPL"
 License: MIT
 Author: Joseph Bochinski

{replbase-0.0.17 → replbase-0.0.18}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "replbase"
-version = "0.0.17"
+version = "0.0.18"
 description = "\"Combination of other REPL tools into a reusable class that generates a REPL\""
 authors = [ "Joseph Bochinski <stirgejr@gmail.com>",]
 license = "MIT"

replbase-0.0.18/replbase/__init__.py

@@ -0,0 +1,5 @@
+""" Package for the ReplBase project. """
+
+from replbase.repl_base import ReplBase, ReplTheme, SuggestFromLs, TestRepl
+
+__all__ = ["ReplBase", "ReplTheme", "SuggestFromLs", "TestRepl"]

{replbase-0.0.17 → replbase-0.0.18}/replbase/repl_base.py

@@ -23,11 +23,15 @@ from dataclasses import dataclass, field
 from typing import Any, Callable, Literal
 
 from prompt_toolkit import PromptSession
+from prompt_toolkit.buffer import Buffer
+from prompt_toolkit.document import Document
+from prompt_toolkit.auto_suggest import AutoSuggest, Suggestion
 from prompt_toolkit.history import FileHistory
 from prompt_toolkit.completion import WordCompleter
 from prompt_toolkit.styles import Style
 from ptpython.repl import embed
 from rich.console import Console
+from rich.theme import Theme
 
 # endregion Imports
 
@@ -45,6 +49,27 @@ def is_num_str(val: str) -> bool:
     return bool(re.match(r"^-?\d+(\.\d+)?$", val))
 
 
+@dataclass
+class ReplTheme(Theme):
+    title: str = "bold cyan"
+    prompt: str = "bold green"
+    warn: str = "bold yellow"
+    error: str = "bold red"
+    cmd_name: str = "bold green"
+    cmd_desc: str = "cyan"
+    exit_kw: str = "bold green"
+    exit_str: str = "cyan"
+    greeting: str = "cyan"
+    addl_styles: dict = None
+
+    def __post_init__(self) -> None:
+        styles = dict(vars(self))
+        extras = styles.pop("addl_styles", {})
+        if extras:
+            styles.update(extras)
+        super().__init__(styles)
+
+
 @dataclass
 class ReplCommand:
     """Class definition for a provided CLI REPL command"""
@@ -65,7 +90,7 @@ class ReplBase:
     title: str = None
     """Title of the CLI REPL Prompt"""
 
-    exit_keywords: list[str] = None  # field(default_factory=list)
+    exit_keywords: list[str] = None
     """List of strings that cause the REPL to close, defaults to x, q, 
         exit, and quit"""
 
@@ -75,6 +100,8 @@ class ReplBase:
     color_system: ColorSystem = None
     """Color syste for the rich console"""
 
+    theme: ReplTheme | dict = None
+
     console: Console = None
     """ Rich Console instance """
 
@@ -84,17 +111,19 @@ class ReplBase:
     temp_file: str = None
     """Path to prompt temporary file"""
 
-    style: dict | Style = None  # field(default_factory=dict)
+    style: dict | Style = None
     """Style for the prompt"""
 
     ignore_case: bool = None
     """Ignore case setting for the WordCompleter instance"""
 
-    commands: dict[str, ReplCommand] = None  # field(default_factory=dict)
+    commands: dict[str, ReplCommand] = None
     """Command dictionary for prompt_toolkit. Keys are command names,
         values are the corresponding description/help text"""
 
-    parent: ReplBase = None
+    parent: ReplBase | dict = None
+
+    session: PromptSession = None
 
     def __post_init__(self) -> None:
         if isinstance(self.commands, dict):
@@ -110,20 +139,33 @@ class ReplBase:
         self.exit_keywords = self.exit_keywords or ["x", "q", "exit", "quit"]
 
         exit_kw_str = ", ".join(
-            f'[bold green]"{kw}"[/bold green]' for kw in self.exit_keywords
+            f'[exit_kw]"{kw}"[/exit_kw]' for kw in self.exit_keywords
         )
         exit_kw_pref = "Type one of " if len(self.exit_keywords) > 1 else "Type "
-        exit_str = f"[cyan]{exit_kw_pref}{exit_kw_str} to exit[/cyan]"
+        exit_str = f"[exit_str]{exit_kw_pref}{exit_kw_str} to exit[/exit_str]"
 
         self.init_prompt = self.init_prompt or [
-            f"[bold cyan]<<| {self.title} |>>[/bold cyan]",
+            f"[title]<<| {self.title} |>>[/title]",
             exit_str,
-            '[cyan]Type [bold green]"help"[/bold green] to view available commands.',
+            '[greeting]Type [cmd_name]"help"[/cmd_name] to view available commands.[/greeting]',
         ]
 
         self.color_system = self.color_system or "truecolor"
 
-        self.console = Console(color_system=self.color_system)
+        if isinstance(self.theme, dict):
+            props = list(dict(vars(ReplTheme())).keys())
+            init = {"addl_styles": {}}
+            for key, value in self.theme.items():
+                if key in props:
+                    init[key] = value
+                else:
+                    init["addl_styles"][key] = value
+
+            self.theme = ReplTheme(**init)
+        elif self.theme is None:
+            self.theme = ReplTheme()
+
+        self.console = Console(color_system=self.color_system, theme=self.theme)
 
         self.history = self.history or os.path.expanduser(
             "~/.config/.prompt_history"
@@ -187,8 +229,10 @@ class ReplBase:
         """Shortcut to console.print"""
         self.console.print(*args)
 
-    def input(self, *args) -> str:
+    def input(self, *args, suggestions: AutoSuggest = None) -> str:
         """Shortcut to console.input"""
+        if self.session:
+            return self.session.prompt(*args, auto_suggest=suggestions)
         return self.console.input(*args)
 
     def input_int(self, *args) -> int:
@@ -297,7 +341,7 @@ class ReplBase:
 
         for cmd_name, cmd in self.commands.items():
             self.print(
-                f"[bold green]{cmd_name}:[/bold green] [cyan]{cmd.help_txt}[/cyan]"
+                f"[cmd_name]{cmd_name}:[/cmd_name] [cmd_desc]{cmd.help_txt}[/cmd_desc]"
             )
 
     def print_prompt(self) -> None:
@@ -316,7 +360,7 @@ class ReplBase:
             self.get_cmd_names(), ignore_case=self.ignore_case
         )
 
-        session = PromptSession(
+        self.session = PromptSession(
             completer=completer,
             style=self.style,
             history=FileHistory(self.history),
@@ -327,29 +371,23 @@ class ReplBase:
 
         while True:
             try:
-                user_input = session.prompt("> ", complete_while_typing=True)
+                user_input = self.session.prompt("> ", complete_while_typing=True)
 
                 if user_input.lower() in ["help", "h"]:
                     self.show_help()
                 elif user_input.lower() in self.exit_keywords:
-                    self.print(
-                        f"[bold yellow]Exiting REPL ({self.title})...[/bold yellow]"
-                    )
+                    self.print(f"[warn]Exiting REPL ({self.title})...[/warn]")
                     break
                 else:
                     args = shlex.split(user_input)
                     if not args:
-                        self.print(
-                            "[bold yellow][WARNING]: No command provided[/bold yellow]"
-                        )
+                        self.print("[warn][WARNING]: No command provided[/warn]")
                         continue
 
                     cmd = self.commands.get(args[0])
 
                     if not cmd:
-                        self.print(
-                            "[bold yellow][WARNING]: Invalid command[/bold yellow]"
-                        )
+                        self.print("[warn][WARNING]: Invalid command[/warn]")
                         continue
 
                     cmd_args = args[1:]
@@ -372,18 +410,44 @@ class ReplBase:
                                 cmd.command(*cmd_args)
                     else:
                         self.print(
-                            "[bold yellow][WARNING]: No function provided for command[/bold yellow]"
+                            "[warn][WARNING]: No function provided for command[/warn]"
                         )
             except (EOFError, KeyboardInterrupt):
-                self.print(
-                    f"[bold yellow]Exiting REPL ({self.title})...[/bold yellow]"
-                )
+                self.print(f"[warn]Exiting REPL ({self.title})...[/warn]")
                 break
 
         if self.parent:
             self.parent.print_prompt()
 
 
+class SuggestFromLs(AutoSuggest):
+
+    def get_suggestion(
+        self, buffer: Buffer, document: Document
+    ) -> Suggestion | None:
+        files = os.listdir()
+
+        # Consider only the last line for the suggestion.
+        text = document.text.rsplit("\n", 1)[-1]
+
+        if text.strip():
+            for item in files:
+                if item.lower().startswith(text.lower()):
+                    return Suggestion(item[len(text) :])
+        return None
+
+
+@dataclass
+class TestRepl(ReplBase):
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        self.add_command("test_cmd", self.test_cmd, help_txt="Test command")
+
+    def test_cmd(self) -> None:
+        user_input = self.input("Testing prompt: ", suggestions=SuggestFromLs())
+        self.print(user_input)
+
+
 # endregion Classes
 
 

replbase-0.0.17/replbase/__init__.py

@@ -1,5 +0,0 @@
-""" Package for the ReplBase project. """
-
-from replbase.repl_base import ReplBase
-
-__all__ = ["ReplBase"]