shotgun-sh 0.1.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

shotgun/tui/screens/welcome.py

@@ -0,0 +1,198 @@
+"""Welcome screen for choosing between Shotgun Account and BYOK."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, cast
+
+from textual import on
+from textual.app import ComposeResult
+from textual.containers import Container, Horizontal, Vertical
+from textual.screen import Screen
+from textual.widgets import Button, Markdown, Static
+
+if TYPE_CHECKING:
+    from ..app import ShotgunApp
+
+
+class WelcomeScreen(Screen[None]):
+    """Welcome screen for first-time setup."""
+
+    CSS = """
+        WelcomeScreen {
+            layout: vertical;
+            align: center middle;
+        }
+
+        #titlebox {
+            width: 100%;
+            height: auto;
+            margin: 2 0;
+            padding: 1;
+            border: hkey $border;
+            content-align: center middle;
+
+            & > * {
+                text-align: center;
+            }
+        }
+
+        #welcome-title {
+            padding: 1 0;
+            text-style: bold;
+            color: $text-accent;
+        }
+
+        #welcome-subtitle {
+            padding: 0 1;
+        }
+
+        #options-container {
+            width: 100%;
+            height: auto;
+            padding: 2;
+            align: center middle;
+        }
+
+        #options {
+            width: auto;
+            height: auto;
+        }
+
+        .option-box {
+            width: 45;
+            height: auto;
+            border: solid $primary;
+            padding: 2;
+            margin: 0 1;
+            background: $surface;
+        }
+
+        .option-box:focus-within {
+            border: solid $accent;
+        }
+
+        .option-title {
+            text-style: bold;
+            color: $text-accent;
+            padding: 0 0 1 0;
+        }
+
+        .option-benefits {
+            padding: 1 0;
+        }
+
+        .option-button {
+            margin: 1 0 0 0;
+            width: 100%;
+        }
+    """
+
+    BINDINGS = [
+        ("ctrl+c", "app.quit", "Quit"),
+    ]
+
+    def compose(self) -> ComposeResult:
+        with Vertical(id="titlebox"):
+            yield Static("Welcome to Shotgun", id="welcome-title")
+            yield Static(
+                "Choose how you'd like to get started",
+                id="welcome-subtitle",
+            )
+
+        with Container(id="options-container"):
+            with Horizontal(id="options"):
+                # Left box - Shotgun Account
+                with Vertical(classes="option-box", id="shotgun-box"):
+                    yield Static("Use a Shotgun Account", classes="option-title")
+                    yield Markdown(
+                        "**Benefits:**\n"
+                        "• Use of all models in the Model Garden\n"
+                        "• We'll pick the optimal models to give you the best "
+                        "experience for things like web search, codebase indexing",
+                        classes="option-benefits",
+                    )
+                    yield Button(
+                        "Sign Up for/Use your Shotgun Account",
+                        variant="primary",
+                        id="shotgun-button",
+                        classes="option-button",
+                    )
+
+                # Right box - BYOK
+                with Vertical(classes="option-box", id="byok-box"):
+                    yield Static("Bring Your Own Key (BYOK)", classes="option-title")
+                    yield Markdown(
+                        "**Benefits:**\n"
+                        "• 100% Supported by the application\n"
+                        "• Use your existing API keys from OpenAI, Anthropic, or Google",
+                        classes="option-benefits",
+                    )
+                    yield Button(
+                        "Configure API Keys",
+                        variant="success",
+                        id="byok-button",
+                        classes="option-button",
+                    )
+
+    def on_mount(self) -> None:
+        """Focus the first button on mount."""
+        self.query_one("#shotgun-button", Button).focus()
+        # Update BYOK button text asynchronously
+        self.run_worker(self._update_byok_button_text(), exclusive=False)
+
+    async def _update_byok_button_text(self) -> None:
+        """Update BYOK button text based on whether user has existing providers."""
+        byok_button = self.query_one("#byok-button", Button)
+        app = cast("ShotgunApp", self.app)
+        if await app.config_manager.has_any_provider_key():
+            byok_button.label = "I'll stick with my BYOK setup"
+
+    @on(Button.Pressed, "#shotgun-button")
+    def _on_shotgun_pressed(self) -> None:
+        """Handle Shotgun Account button press."""
+        self.run_worker(self._start_shotgun_auth(), exclusive=True)
+
+    @on(Button.Pressed, "#byok-button")
+    def _on_byok_pressed(self) -> None:
+        """Handle BYOK button press."""
+        self.run_worker(self._start_byok_config(), exclusive=True)
+
+    async def _start_byok_config(self) -> None:
+        """Launch BYOK provider configuration flow."""
+        await self._mark_welcome_shown()
+
+        app = cast("ShotgunApp", self.app)
+
+        # If user already has providers, just dismiss and continue to chat
+        if await app.config_manager.has_any_provider_key():
+            self.dismiss()
+            return
+
+        # Otherwise, push provider config screen and wait for result
+        from .provider_config import ProviderConfigScreen
+
+        await self.app.push_screen_wait(ProviderConfigScreen())
+
+        # Dismiss welcome screen after config if providers are now configured
+        if await app.config_manager.has_any_provider_key():
+            self.dismiss()
+
+    async def _start_shotgun_auth(self) -> None:
+        """Launch Shotgun Account authentication flow."""
+        from .shotgun_auth import ShotgunAuthScreen
+
+        # Mark welcome screen as shown before auth
+        await self._mark_welcome_shown()
+
+        # Push the auth screen and wait for result
+        await self.app.push_screen_wait(ShotgunAuthScreen())
+
+        # Dismiss welcome screen after auth
+        self.dismiss()
+
+    async def _mark_welcome_shown(self) -> None:
+        """Mark the welcome screen as shown in config."""
+        app = cast("ShotgunApp", self.app)
+        config = await app.config_manager.load()
+        config.shown_welcome_screen = True
+        await app.config_manager.save(config)

shotgun/tui/services/__init__.py

@@ -0,0 +1,5 @@
+"""Services for TUI business logic."""
+
+from shotgun.tui.services.conversation_service import ConversationService
+
+__all__ = ["ConversationService"]

shotgun/tui/services/conversation_service.py

@@ -0,0 +1,184 @@
+"""Service for managing conversation persistence and restoration.
+
+This service extracts conversation save/load/restore logic from ChatScreen,
+making it testable and reusable.
+"""
+
+import logging
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import aiofiles.os
+
+from shotgun.agents.conversation_history import ConversationHistory, ConversationState
+from shotgun.agents.conversation_manager import ConversationManager
+from shotgun.agents.models import AgentType
+
+if TYPE_CHECKING:
+    from shotgun.agents.agent_manager import AgentManager
+    from shotgun.agents.usage_manager import SessionUsageManager
+
+logger = logging.getLogger(__name__)
+
+
+class ConversationService:
+    """Handles conversation persistence and restoration.
+
+    This service provides:
+    - Save current conversation to disk
+    - Load conversation from disk
+    - Restore conversation state to agent manager
+    - Handle corrupted conversations gracefully
+    """
+
+    def __init__(
+        self,
+        conversation_manager: ConversationManager | None = None,
+        conversation_path: Path | None = None,
+    ):
+        """Initialize the conversation service.
+
+        Args:
+            conversation_manager: Optional conversation manager. If not provided,
+                                creates a default one.
+            conversation_path: Optional custom path for conversation storage.
+        """
+        if conversation_manager:
+            self.conversation_manager = conversation_manager
+        elif conversation_path:
+            self.conversation_manager = ConversationManager(conversation_path)
+        else:
+            self.conversation_manager = ConversationManager()
+
+    async def save_conversation(self, agent_manager: "AgentManager") -> bool:
+        """Save the current conversation to persistent storage.
+
+        Args:
+            agent_manager: The agent manager containing conversation state.
+
+        Returns:
+            True if save was successful, False otherwise.
+        """
+        try:
+            # Get conversation state from agent manager
+            state = agent_manager.get_conversation_state()
+
+            # Create conversation history object
+            conversation = ConversationHistory(
+                last_agent_model=state.agent_type,
+            )
+            conversation.set_agent_messages(state.agent_messages)
+            conversation.set_ui_messages(state.ui_messages)
+
+            # Save to file (now async)
+            await self.conversation_manager.save(conversation)
+            logger.debug("Conversation saved successfully")
+            return True
+        except Exception as e:
+            logger.exception(f"Failed to save conversation: {e}")
+            return False
+
+    async def load_conversation(self) -> ConversationHistory | None:
+        """Load conversation from persistent storage.
+
+        Returns:
+            The loaded conversation history, or None if no conversation exists
+            or if loading failed.
+        """
+        try:
+            conversation = await self.conversation_manager.load()
+            if conversation is None:
+                logger.debug("No conversation file found")
+                return None
+
+            logger.debug("Conversation loaded successfully")
+            return conversation
+        except Exception as e:
+            logger.exception(f"Failed to load conversation: {e}")
+            return None
+
+    async def check_for_corrupted_conversation(self) -> bool:
+        """Check if a conversation backup exists (indicating corruption).
+
+        Returns:
+            True if a backup exists (conversation was corrupted), False otherwise.
+        """
+        backup_path = self.conversation_manager.conversation_path.with_suffix(
+            ".json.backup"
+        )
+        return await aiofiles.os.path.exists(str(backup_path))
+
+    async def restore_conversation(
+        self,
+        agent_manager: "AgentManager",
+        usage_manager: "SessionUsageManager | None" = None,
+    ) -> tuple[bool, str | None, AgentType | None]:
+        """Restore conversation state from disk.
+
+        Args:
+            agent_manager: The agent manager to restore state to.
+            usage_manager: Optional usage manager to restore usage state.
+
+        Returns:
+            Tuple of (success, error_message, restored_agent_type)
+            - success: True if restoration succeeded
+            - error_message: Error message if restoration failed, None otherwise
+            - restored_agent_type: The agent type from restored conversation
+        """
+        conversation = await self.load_conversation()
+
+        if conversation is None:
+            # Check for corruption
+            if await self.check_for_corrupted_conversation():
+                return (
+                    False,
+                    "⚠️ Previous session was corrupted and has been backed up. Starting fresh conversation.",
+                    None,
+                )
+            return True, None, None  # No conversation to restore is not an error
+
+        try:
+            # Restore agent state
+            agent_messages = conversation.get_agent_messages()
+            ui_messages = conversation.get_ui_messages()
+
+            # Create ConversationState for restoration
+            state = ConversationState(
+                agent_messages=agent_messages,
+                ui_messages=ui_messages,
+                agent_type=conversation.last_agent_model,
+            )
+
+            agent_manager.restore_conversation_state(state)
+
+            # Restore usage state if manager provided
+            if usage_manager:
+                await usage_manager.restore_usage_state()
+
+            restored_type = AgentType(conversation.last_agent_model)
+            logger.info(f"Conversation restored successfully (mode: {restored_type})")
+            return True, None, restored_type
+
+        except Exception as e:
+            logger.exception(f"Failed to restore conversation state: {e}")
+            return (
+                False,
+                "⚠️ Could not restore previous session. Starting fresh conversation.",
+                None,
+            )
+
+    async def clear_conversation(self) -> bool:
+        """Clear the saved conversation file.
+
+        Returns:
+            True if clearing succeeded, False otherwise.
+        """
+        try:
+            conversation_path = self.conversation_manager.conversation_path
+            if await aiofiles.os.path.exists(str(conversation_path)):
+                await aiofiles.os.unlink(str(conversation_path))
+                logger.info("Conversation file cleared")
+            return True
+        except Exception as e:
+            logger.exception(f"Failed to clear conversation: {e}")
+            return False

shotgun/tui/state/__init__.py

@@ -0,0 +1,7 @@
+"""State management utilities for TUI."""
+
+from .processing_state import ProcessingStateManager
+
+__all__ = [
+    "ProcessingStateManager",
+]

shotgun/tui/state/processing_state.py

@@ -0,0 +1,185 @@
+"""Processing state management for TUI operations.
+
+This module provides centralized management of processing state including:
+- Tracking whether operations are in progress
+- Managing worker references for cancellation
+- Coordinating spinner widget updates
+- Providing clean cancellation API
+"""
+
+from typing import TYPE_CHECKING, Any
+
+from shotgun.logging_config import get_logger
+from shotgun.posthog_telemetry import track_event
+
+if TYPE_CHECKING:
+    from textual.screen import Screen
+    from textual.worker import Worker
+
+    from shotgun.tui.components.spinner import Spinner
+
+logger = get_logger(__name__)
+
+
+class ProcessingStateManager:
+    """Manages processing state and spinner coordination for async operations.
+
+    This class centralizes the logic for tracking whether the TUI is processing
+    an operation, managing the current worker for cancellation, and updating
+    spinner text.
+
+    Example:
+        ```python
+        # In ChatScreen
+        self.processing_state = ProcessingStateManager(self)
+
+        # Start processing
+        @work
+        async def some_operation(self) -> None:
+            self.processing_state.start_processing("Doing work...")
+            self.processing_state.bind_worker(get_current_worker())
+            try:
+                # ... do work ...
+            finally:
+                self.processing_state.stop_processing()
+        ```
+    """
+
+    def __init__(
+        self, screen: "Screen[Any]", telemetry_context: dict[str, Any] | None = None
+    ) -> None:
+        """Initialize the processing state manager.
+
+        Args:
+            screen: The Textual screen this manager is attached to
+            telemetry_context: Optional context to include in telemetry events
+                (e.g., {"agent_mode": "research"})
+        """
+        self.screen = screen
+        self._working = False
+        self._current_worker: Worker[Any] | None = None
+        self._spinner_widget: Spinner | None = None
+        self._default_spinner_text = "Processing..."
+        self._telemetry_context = telemetry_context or {}
+
+    @property
+    def is_working(self) -> bool:
+        """Check if an operation is currently in progress.
+
+        Returns:
+            True if processing, False if idle
+        """
+        return self._working
+
+    def bind_spinner(self, spinner: "Spinner") -> None:
+        """Bind a spinner widget for state coordination.
+
+        Should be called during screen mount after the spinner widget is available.
+
+        Args:
+            spinner: The Spinner widget to coordinate with
+        """
+        self._spinner_widget = spinner
+        logger.debug(f"Spinner widget bound: {spinner}")
+
+    def start_processing(self, spinner_text: str | None = None) -> None:
+        """Start processing state with optional custom spinner text.
+
+        Args:
+            spinner_text: Custom text to display in spinner. If None, uses default.
+        """
+        if self._working:
+            logger.warning("Attempted to start processing while already processing")
+            return
+
+        self._working = True
+        text = spinner_text or self._default_spinner_text
+
+        # Update screen's reactive working state
+        if hasattr(self.screen, "working"):
+            self.screen.working = True
+
+        if self._spinner_widget:
+            self._spinner_widget.text = text
+            logger.debug(f"Processing started with spinner text: {text}")
+        else:
+            logger.warning("Processing started but no spinner widget bound")
+
+    def stop_processing(self) -> None:
+        """Stop processing state and reset to default."""
+        if not self._working:
+            logger.debug("stop_processing called when not working (no-op)")
+            return
+
+        self._working = False
+        self._current_worker = None
+
+        # Update screen's reactive working state
+        if hasattr(self.screen, "working"):
+            self.screen.working = False
+
+        # Reset spinner to default text
+        if self._spinner_widget:
+            self._spinner_widget.text = self._default_spinner_text
+            logger.debug("Processing stopped, spinner reset to default")
+
+    def bind_worker(self, worker: "Worker[Any]") -> None:
+        """Bind a worker for cancellation tracking.
+
+        Should be called immediately after starting a @work decorated method
+        using get_current_worker().
+
+        Args:
+            worker: The Worker instance to track for cancellation
+        """
+        self._current_worker = worker
+        logger.debug(f"Worker bound: {worker}")
+
+    def cancel_current_operation(self, cancel_key: str | None = None) -> bool:
+        """Attempt to cancel the current operation if one is running.
+
+        Automatically tracks cancellation telemetry with context from initialization.
+
+        Args:
+            cancel_key: Optional key that triggered cancellation (e.g., "Escape")
+
+        Returns:
+            True if an operation was cancelled, False if no operation was running
+        """
+        if not self._working or not self._current_worker:
+            logger.debug("No operation to cancel")
+            return False
+
+        try:
+            self._current_worker.cancel()
+            logger.info("Operation cancelled successfully")
+
+            # Track cancellation event with context
+            event_data = {**self._telemetry_context}
+            if cancel_key:
+                event_data["cancel_key"] = cancel_key
+
+            track_event("agent_cancelled", event_data)
+
+            return True
+        except Exception as e:
+            logger.error(f"Failed to cancel operation: {e}", exc_info=True)
+            return False
+
+    def update_spinner_text(self, text: str) -> None:
+        """Update spinner text during processing.
+
+        Args:
+            text: New text to display in spinner
+        """
+        if not self._working:
+            logger.warning(
+                f"Attempted to update spinner text while not working: {text}"
+            )
+            return
+
+        if self._spinner_widget:
+            self._spinner_widget.text = text
+            logger.debug(f"Spinner text updated to: {text}")
+        else:
+            logger.warning(f"Cannot update spinner text, widget not bound: {text}")

shotgun/tui/utils/mode_progress.py

@@ -3,6 +3,8 @@
 import random
 from pathlib import Path
 
+import aiofiles
+
 from shotgun.agents.models import AgentType
 from shotgun.utils.file_system_utils import get_shotgun_base_path
 
@@ -30,7 +32,7 @@ class ModeProgressChecker:
         """
         self.base_path = base_path or get_shotgun_base_path()
 
-    def has_mode_content(self, mode: AgentType) -> bool:
+    async def has_mode_content(self, mode: AgentType) -> bool:
         """Check if a mode has meaningful content.
 
         Args:
@@ -52,7 +54,8 @@ class ModeProgressChecker:
                 for item in export_path.glob("*"):
                     if item.is_file() and not item.name.startswith("."):
                         try:
-                            content = item.read_text(encoding="utf-8")
+                            async with aiofiles.open(item, encoding="utf-8") as f:
+                                content = await f.read()
                             if len(content.strip()) > self.MIN_CONTENT_SIZE:
                                 return True
                         except (OSError, UnicodeDecodeError):
@@ -65,13 +68,16 @@ class ModeProgressChecker:
             return False
 
         try:
-            content = file_path.read_text(encoding="utf-8")
+            async with aiofiles.open(file_path, encoding="utf-8") as f:
+                content = await f.read()
             # Check if file has meaningful content
             return len(content.strip()) > self.MIN_CONTENT_SIZE
         except (OSError, UnicodeDecodeError):
             return False
 
-    def get_next_suggested_mode(self, current_mode: AgentType) -> AgentType | None:
+    async def get_next_suggested_mode(
+        self, current_mode: AgentType
+    ) -> AgentType | None:
         """Get the next suggested mode based on current progress.
 
         Args:
@@ -94,7 +100,7 @@ class ModeProgressChecker:
             return None
 
         # Check if current mode has content
-        if not self.has_mode_content(current_mode):
+        if not await self.has_mode_content(current_mode):
             # Current mode is empty, no suggestion for next mode
             return None
 
@@ -222,8 +228,9 @@ class PlaceholderHints:
         if current_mode not in self.HINTS:
             return f"Enter your {current_mode.value} mode prompt (SHIFT+TAB to switch modes)"
 
-        # Determine if mode has content
-        has_content = self.progress_checker.has_mode_content(current_mode)
+        # For placeholder text, we default to "no content" state (initial hints)
+        # This avoids async file system checks in the UI rendering path
+        has_content = False
 
         # Get hint variations for this mode and state
         hints_list = self.HINTS[current_mode][has_content]

shotgun/tui/widgets/__init__.py

@@ -0,0 +1,5 @@
+"""Widget utilities and coordinators for TUI."""
+
+from shotgun.tui.widgets.widget_coordinator import WidgetCoordinator
+
+__all__ = ["WidgetCoordinator"]