batrachian-toad 0.5.22__py3-none-any.whl

toad/settings_schema.py

@@ -0,0 +1,318 @@
+from toad.settings import SchemaDict
+
+SCHEMA: list[SchemaDict] = [
+    {
+        "key": "ui",
+        "title": "User interface settings",
+        "help": "The following settings allow you to customize the look and feel of the User Interface.",
+        "type": "object",
+        "fields": [
+            {
+                "key": "theme",
+                "title": "Theme",
+                "help": "One of the builtin Textual themes.",
+                "type": "choices",
+                "default": "dracula",
+                "choices": [
+                    "atom-one-dark",
+                    "atom-one-light",
+                    "catppuccin-latte",
+                    "catppuccin-mocha",
+                    "dracula",
+                    "flexoki",
+                    "gruvbox",
+                    "monokai",
+                    "nord",
+                    "solarized-light",
+                    "solarized-dark",
+                    "textual-dark",
+                    "textual-light",
+                    "tokyo-night",
+                    "rose-pine",
+                    "rose-pine-moon",
+                    "rose-pine-dawn",
+                ],
+            },
+            {
+                "key": "compact-input",
+                "title": "Compact text input?",
+                "help": "Remove border and margin around the text area for additional space",
+                "type": "boolean",
+                "default": False,
+            },
+            {
+                "key": "footer",
+                "title": "Enable footer?",
+                "help": "Disable the footer if you want additional room.",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "info-bar",
+                "title": "Enable info bar?",
+                "help": "The info bar is the text below the prompt text area. Disable for more space.",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "status-line",
+                "title": "Show status line in the info bar?",
+                "help": "The status line shows tokens and cost (not available in all agents).",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "agent-title",
+                "title": "Show agent title the info bar?",
+                "help": "Disable for a little extras space.",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "column",
+                "title": "Enable column?",
+                "help": "Enable for a fixed column size. Disable to use the full screen width.",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "column-width",
+                "title": "Width of the column",
+                "help": "Width of the column if enabled. Minimum 40 characters.",
+                "type": "integer",
+                "default": 100,
+                "validate": [{"type": "minimum", "value": 40}],
+            },
+            {
+                "key": "scrollbar",
+                "title": "Scrollbar size",
+                "type": "choices",
+                "default": "normal",
+                "choices": [
+                    ("Normal", "normal"),
+                    ("Thin", "thin"),
+                    ("Hidden", "hidden"),
+                ],
+            },
+            {
+                "key": "throbber",
+                "title": "Thinking animation",
+                "help": "Animation to show while the agent is busy",
+                "type": "choices",
+                "default": "quotes",
+                "choices": [
+                    ("Pulse", "pulse"),
+                    ("Quotes", "quotes"),
+                ],
+            },
+            {
+                "key": "flash_duration",
+                "title": "Flash duration",
+                "help": "Default duration of flash messages (in seconds)",
+                "type": "number",
+                "default": 3.0,
+                "validate": [{"type": "minimum", "value": 0.5}],
+            },
+            {
+                "key": "auto_copy",
+                "title": "Automatic copy",
+                "help": "Automatically copy text on selection?\nDoesn't apply to text areas (use ctrl+c to copy).",
+                "type": "boolean",
+                "default": True,
+            },
+        ],
+    },
+    {
+        "key": "notifications",
+        "title": "Notification (toasts) settings",
+        "help": "Customize how Toad displays notifications",
+        "type": "object",
+        "fields": [
+            {
+                "key": "system",
+                "title": "Show Toad notifications on your desktop?",
+                "type": "choices",
+                "default": "blur",
+                "choices": [
+                    ("Never", "never"),
+                    ("When app is not focused", "blur"),
+                    ("Always", "always"),
+                ],
+            },
+            {
+                "key": "enable_sounds",
+                "title": "Allow sound in notifications?",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "turn_over",
+                "title": "Desktop notification when agent has finished?",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "hide_low_severity",
+                "title": "Limit desktop notifications to warning and errors?",
+                "type": "boolean",
+                "default": True,
+            },
+        ],
+    },
+    {
+        "key": "sidebar",
+        "title": "Sidebar settings",
+        "help": "Customize how the sidebar is displayed.",
+        "type": "object",
+        "fields": [
+            {
+                "key": "hide",
+                "title": "Hide the sidebar when not in use?",
+                "type": "boolean",
+                "default": False,
+            }
+        ],
+    },
+    {
+        "key": "agent",
+        "title": "Agent settings",
+        "help": "Customize how you interact with agents",
+        "type": "object",
+        "fields": [
+            {
+                "key": "thoughts",
+                "title": "Agent thoughts",
+                "help": "Show agent's 'thoughts' in the conversation?",
+                "type": "boolean",
+            },
+            # {
+            #     "key": "warn",
+            #     "title": "Warning against dangerous commands?",
+            #     "help": "Please note that this can produce false positive [i]and[/i] false negatives. If you get a warning, examine the command more closely. But do not assume a command is safe if you get no warning.\n\nThis setting will have no effect if you have given the agent permissions to execute all commands.",
+            #     "type": "boolean",
+            #     "default": True,
+            # },
+        ],
+    },
+    {
+        "key": "tools",
+        "title": "Tool call settings",
+        "help": "Customize how Toad displays agent tool calls",
+        "type": "object",
+        "fields": [
+            {
+                "key": "expand",
+                "title": "Tool call expand",
+                "help": "When should Toad expand tool calls?",
+                "type": "choices",
+                "default": "fail",
+                "choices": [
+                    ("Never", "never"),
+                    ("Always", "always"),
+                    ("Success only", "success"),
+                    ("Fail only", "fail"),
+                    ("Fail and success", "both"),
+                ],
+            }
+        ],
+    },
+    {
+        "key": "shell",
+        "title": "Shell settings",
+        "help": "Customize shell interactions.",
+        "type": "object",
+        "fields": [
+            {
+                "key": "command",
+                "title": "Shell command",
+                "type": "string",
+                "help": "Command used to launch your shell on macOS.\n[bold]Note:[/] Requires restart.",
+                "default": "/bin/sh",
+            },
+            {
+                "key": "command_start",
+                "title": "Startup commands",
+                "type": "text",
+                "help": "Command(s) to run on shell start.",
+                "default": 'PS1=""',
+            },
+            {
+                "key": "warn_dangerous",
+                "title": "Warn against potentially destructive commands?",
+                "help": "If enabled, Toad will highlight potentially destructive commands that may modify the filesystem outside of the project directory.\n\nNote that false positive [i]and[/] false negatives are possible.",
+                "type": "boolean",
+                "default": True,
+            },
+            {
+                "key": "allow_commands",
+                "title": "Allow commands",
+                "help": "List of commands (one per line) which should be considered shell commands by default, rather than a part of a prompt.",
+                "type": "text",
+                "default": "python\ngit\nls\ncat\ncd\nmv\ncp\ntree\nrm\necho\nrmdir\nmkdir\ntouch\nopen\npwd\nnano",
+            },
+            {
+                "key": "directory_commands",
+                "title": "Directory commands",
+                "help": "List of commands (one per line) which accept only a directory as their first argument (used in tab completion).",
+                "type": "text",
+                "default": "cd\nrmdir",
+            },
+            {
+                "key": "file_commands",
+                "title": "File commands",
+                "help": "List of commands (one per line) which accept only a non-directory as their first argument (used in tab completion).",
+                "type": "text",
+                "default": "cat",
+            },
+        ],
+    },
+    {
+        "key": "diff",
+        "title": "Diff view settings",
+        "help": "Customize how diffs are displayed.",
+        "type": "object",
+        "fields": [
+            {
+                "key": "view",
+                "title": "Display preference",
+                "default": "auto",
+                "type": "choices",
+                "choices": [
+                    ("Unified", "unified"),
+                    ("Split", "split"),
+                    ("Best fit", "auto"),
+                ],
+            }
+        ],
+    },
+    {
+        "key": "launcher",
+        "title": "Launcher settings",
+        "help": "Customize the launcher",
+        "type": "object",
+        "editable": False,
+        "fields": [
+            {
+                "key": "agents",
+                "title": "Agents to show in the launcher",
+                "type": "text",
+                "default": "",
+            }
+        ],
+    },
+    {
+        "key": "statistics",
+        "title": "Data collection",
+        "help": "Preferences regarding data collection.",
+        "type": "object",
+        "fields": [
+            {
+                "key": "allow_collect",
+                "title": "Allow collection of anonymous usage data?",
+                "help": "Toad can collect basic usage data (number of installs, OS version, agents used, session length etc). This information is associated with a randomly generated UUID (see it in /about-toad) and contains no personal information.\n\nCollecting this information will help me (Will McGugan) convince big tech to take this project seriously. I would appreciate if you left this on, but it is entirely up to you.",
+                "type": "boolean",
+                "default": True,
+            },
+        ],
+    },
+]

toad/shell.py

@@ -0,0 +1,263 @@
+from __future__ import annotations
+
+
+from contextlib import suppress
+import os
+import asyncio
+import codecs
+import fcntl
+import platform
+import pty
+import struct
+import termios
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from textual import log
+from textual.message import Message
+
+from toad.shell_read import shell_read
+
+from toad.widgets.terminal import Terminal
+
+if TYPE_CHECKING:
+    from toad.widgets.conversation import Conversation
+
+IS_MACOS = platform.system() == "Darwin"
+
+
+def resize_pty(fd, cols, rows):
+    """Resize the pseudo-terminal"""
+    # Pack the dimensions into the format expected by TIOCSWINSZ
+    try:
+        size = struct.pack("HHHH", rows, cols, 0, 0)
+        fcntl.ioctl(fd, termios.TIOCSWINSZ, size)
+    except OSError:
+        # Possibly file descriptor closed
+        pass
+
+
+@dataclass
+class CurrentWorkingDirectoryChanged(Message):
+    """Current working directory has changed in shell."""
+
+    path: str
+
+
+@dataclass
+class ShellFinished(Message):
+    """The shell finished."""
+
+
+class Shell:
+    """Responsible for shell interactions in Conversation."""
+
+    def __init__(
+        self,
+        conversation: Conversation,
+        working_directory: str,
+        shell="",
+        start="",
+        hide_start: bool = True,
+    ) -> None:
+        self.conversation = conversation
+        self.working_directory = working_directory
+
+        self.terminal: Terminal | None = None
+        self.new_log: bool = False
+        self.shell = shell or os.environ.get("SHELL", "sh")
+        self.shell_start = start
+        self.hide_start = hide_start
+        self.master: int | None = None
+        self._task: asyncio.Task | None = None
+        self._process: asyncio.subprocess.Process | None = None
+
+        self._finished: bool = False
+        self._ready_event: asyncio.Event = asyncio.Event()
+
+        self._hide_echo: set[bytes] = set()
+        """A set of byte strings to remove from output."""
+
+        self._hide_output = hide_start
+        """Hide all output."""
+
+    @property
+    def is_finished(self) -> bool:
+        return self._finished
+
+    async def wait_for_ready(self) -> None:
+        await self._ready_event.wait()
+
+    async def send(self, command: str, width: int, height: int) -> None:
+        await self._ready_event.wait()
+        if self.master is None:
+            print("TTY FD not set")
+            return
+
+        if self.terminal is not None:
+            self.terminal.finalize()
+            self.terminal = None
+
+        try:
+            await asyncio.to_thread(resize_pty, self.master, width, max(height, 1))
+        except OSError:
+            pass
+
+        get_pwd_command = f"{command};" + r'printf "\e]2025;$(pwd);\e\\"' + "\n"
+        await self.write(get_pwd_command, hide_echo=True)
+
+    def start(self) -> None:
+        assert self._task is None
+        self._task = asyncio.create_task(self.run(), name=repr(self))
+        log("shell starting")
+
+    async def interrupt(self) -> None:
+        """Interrupt the running command."""
+        await self.write(b"\x03")
+
+    def update_size(self, width: int, height: int) -> None:
+        """Update the size of the shell pty.
+
+        Args:
+            width: Desired width.
+            height: Desired height.
+        """
+        if self.master is None:
+            return
+        with suppress(OSError):
+            resize_pty(self.master, width, max(height, 1))
+
+    async def write(
+        self, text: str | bytes, hide_echo: bool = False, hide_output: bool = False
+    ) -> int:
+        if self.master is None:
+            return 0
+        text_bytes = text.encode("utf-8", "ignore") if isinstance(text, str) else text
+
+        if hide_echo:
+            for line in text_bytes.split(b"\n"):
+                if line:
+                    self._hide_echo.add(line)
+        try:
+            result = await asyncio.to_thread(os.write, self.master, text_bytes)
+        except OSError:
+            return 0
+        self._hide_output = hide_output
+        return result
+
+    async def run(self) -> None:
+        current_directory = self.working_directory
+
+        master, slave = pty.openpty()
+        self.master = master
+
+        flags = fcntl.fcntl(master, fcntl.F_GETFL)
+        fcntl.fcntl(master, fcntl.F_SETFL, flags | os.O_NONBLOCK)
+
+        env = os.environ.copy()
+        env["FORCE_COLOR"] = "1"
+        env["TTY_COMPATIBLE"] = "1"
+        env["TERM"] = "xterm-256color"
+        env["COLORTERM"] = "truecolor"
+        env["TOAD"] = "1"
+        env["CLICOLOR"] = "1"
+
+        shell = self.shell
+
+        def setup_pty():
+            os.setsid()
+            fcntl.ioctl(slave, termios.TIOCSCTTY, 0)
+
+        try:
+            _process = await asyncio.create_subprocess_shell(
+                shell,
+                stdin=slave,
+                stdout=slave,
+                stderr=slave,
+                env=env,
+                cwd=current_directory,
+                preexec_fn=setup_pty,
+            )
+        except Exception as error:
+            self.conversation.notify(
+                f"Unable to start shell: {error}\n\nCheck your settings.",
+                title="Shell",
+                severity="error",
+            )
+            return
+
+        os.close(slave)
+        BUFFER_SIZE = 64 * 1024
+        reader = asyncio.StreamReader(BUFFER_SIZE)
+        protocol = asyncio.StreamReaderProtocol(reader)
+
+        loop = asyncio.get_event_loop()
+        transport, _ = await loop.connect_read_pipe(
+            lambda: protocol, os.fdopen(master, "rb", 0)
+        )
+
+        self._ready_event.set()
+
+        if shell_start := self.shell_start.strip():
+            shell_start = self.shell_start.strip()
+            if not shell_start.endswith("\n"):
+                shell_start += "\n"
+            await self.write(shell_start, hide_echo=False, hide_output=self.hide_start)
+
+        unicode_decoder = codecs.getincrementaldecoder("utf-8")(errors="replace")
+
+        while True:
+            data = await shell_read(reader, BUFFER_SIZE)
+
+            for string_bytes in list(self._hide_echo):
+                remove_bytes = string_bytes
+                if remove_bytes in data:
+                    remove_start = data.index(remove_bytes)
+                    try:
+                        next_line = data.index(b"\n", remove_start + len(remove_bytes))
+                    except ValueError:
+                        data = data.replace(remove_bytes, b"\x1b[2K")
+                    else:
+                        data = data[:remove_start] + b"\x1b[2K" + data[next_line + 1 :]
+
+                    self._hide_echo.discard(string_bytes)
+
+            if line := unicode_decoder.decode(data, final=not data):
+                if self.terminal is None or self.terminal.is_finalized:
+                    previous_state = (
+                        None if self.terminal is None else self.terminal.state
+                    )
+                    self.terminal = await self.conversation.new_terminal()
+                    # if previous_state is not None:
+                    #     self.terminal.set_state(previous_state)
+                    self.terminal.set_write_to_stdin(self.write)
+
+                terminal_updated = await self.terminal.write(
+                    line, hide_output=self._hide_output
+                )
+                if terminal_updated and not self.terminal.display:
+                    if (
+                        self.terminal.alternate_screen
+                        or not self.terminal.state.scrollback_buffer.is_blank
+                    ):
+                        self.terminal.display = True
+                new_directory = self.terminal.current_directory
+                if new_directory and new_directory != current_directory:
+                    current_directory = new_directory
+                    self.conversation.post_message(
+                        CurrentWorkingDirectoryChanged(current_directory)
+                    )
+            if (
+                self.terminal is not None
+                and self.terminal.is_finalized
+                and self.terminal.state.scrollback_buffer.is_blank
+            ):
+                self.terminal.finalize()
+                self.terminal = None
+
+            if not data:
+                break
+
+        self.master = None
+        self._finished = True
+        self.conversation.post_message(ShellFinished())

toad/shell_read.py

@@ -0,0 +1,42 @@
+import asyncio
+from contextlib import suppress
+from time import monotonic
+
+
+async def shell_read(
+    reader: asyncio.StreamReader,
+    buffer_size: int,
+    *,
+    buffer_period: float | None = 1 / 100,
+    max_buffer_duration: float = 1 / 60,
+) -> bytes:
+    """Read data from a stream reader, with buffer logic to reduce the number of chunks.
+
+    Args:
+        reader: A reader instance.
+        buffer_size: Maximum buffer size.
+        buffer_period: Time in seconds where reads are batched, or `None` for no batching.
+        max_buffer_duration: Maximum time in seconds to buffer.
+
+    Returns:
+        Bytes read. May be empty on the last read.
+    """
+    try:
+        data = await reader.read(buffer_size)
+    except OSError:
+        data = b""
+    if data and buffer_period is not None:
+        buffer_time = monotonic() + max_buffer_duration
+        with suppress(asyncio.TimeoutError):
+            while len(data) < buffer_size and (time := monotonic()) < buffer_time:
+                async with asyncio.timeout(min(buffer_time - time, buffer_period)):
+                    try:
+                        if chunk := await reader.read(buffer_size - len(data)):
+                            data += chunk
+                        else:
+                            break
+                    except OSError as error:
+                        print(repr(error))
+
+                        break
+    return data

toad/slash_command.py

@@ -0,0 +1,34 @@
+import rich.repr
+
+from textual.content import Content
+
+
+@rich.repr.auto
+class SlashCommand:
+    """A record of a slash command."""
+
+    def __init__(self, command: str, help: str, hint: str | None = None) -> None:
+        """
+
+        Args:
+            command: The command name.
+            help: Description of command.
+            hint: Hint text (displayed as suggestion)
+        """
+        self.command = command
+        self.help = help
+        self.hint: str | None = hint
+
+    def __rich_repr__(self) -> rich.repr.Result:
+        yield self.command
+        yield "help", self.help
+        yield "hint", self.hint, None
+
+    def __str__(self) -> str:
+        return self.command
+
+    @property
+    def content(self) -> Content:
+        return Content.assemble(
+            (self.command, "$text-success"), "\t", (self.help, "dim")
+        )