✨ Show if there's a new fastapi-cloud-cli version available

Shortcake-Parent: main

Author: patrick91

pyproject.toml

@@ -38,6 +38,7 @@ dependencies = [
     "pydantic[email] >= 2.12.0; python_version >= '3.14'",
     "sentry-sdk >= 2.20.0",
     "fastar >= 0.10.0",
+    "detect-installer>=0.1.0",
 ]
 
 [project.optional-dependencies]

src/fastapi_cloud_cli/commands/whoami.py

@@ -1,33 +1,35 @@
 import logging
 from typing import Any
 
-from rich import print
-from rich_toolkit.progress import Progress
-
 from fastapi_cloud_cli.utils.api import APIClient
 from fastapi_cloud_cli.utils.auth import Identity
+from fastapi_cloud_cli.utils.cli import get_rich_toolkit
 
 logger = logging.getLogger(__name__)
 
 
 def whoami() -> Any:
     identity = Identity()
 
-    if not identity.is_logged_in():
-        print("No credentials found. Use [blue]`fastapi login`[/] to login.")
-    else:
-        with APIClient() as client:
-            with Progress(title="⚡ Fetching profile", transient=True) as progress:
-                with client.handle_http_errors(progress, default_message=""):
-                    response = client.get("/users/me")
-                    response.raise_for_status()
-
-            data = response.json()
-
-            print(f"⚡ [bold]{data['email']}[/bold]")
-
-    if identity.has_deploy_token():
-        print(
-            "⚡ [bold]Using API token from environment variable for "
-            "[blue]`fastapi deploy`[/blue] command.[/bold]"
-        )
+    with get_rich_toolkit(minimal=True) as toolkit:
+        if not identity.is_logged_in():
+            toolkit.print("No credentials found. Use [blue]`fastapi login`[/] to login.")
+        else:
+            with APIClient() as client:
+                with toolkit.progress(
+                    title="⚡ Fetching profile",
+                    transient=True,
+                ) as progress:
+                    with client.handle_http_errors(progress, default_message=""):
+                        response = client.get("/users/me")
+                        response.raise_for_status()
+
+                data = response.json()
+
+                toolkit.print(f"⚡ [bold]{data['email']}[/bold]")
+
+        if identity.has_deploy_token():
+            toolkit.print(
+                "⚡ [bold]Using API token from environment variable for "
+                "[blue]`fastapi deploy`[/blue] command.[/bold]"
+            )

src/fastapi_cloud_cli/utils/cli.py

@@ -1,11 +1,22 @@
 import logging
+import os
+from types import TracebackType
 from typing import Any, Literal
 
+import click
 from rich.segment import Segment
+from rich.style import Style
+from rich.text import Text
 from rich_toolkit import RichToolkit, RichToolkitTheme
-from rich_toolkit.styles import MinimalStyle, TaggedStyle
+from rich_toolkit.styles import BaseStyle, MinimalStyle, TaggedStyle
+
+from fastapi_cloud_cli.utils.version_check import (
+    DISABLE_VERSION_CHECK_ENV,
+    BackgroundVersionCheck,
+)
 
 logger = logging.getLogger(__name__)
+VERSION_CHECK_CONTEXT_KEY = "fastapi_cloud_cli.version_check"
 
 
 class FastAPIStyle(TaggedStyle):
@@ -20,9 +31,17 @@ def _get_tag_segments(
         animation_status: Literal["started", "stopped", "error"] | None = None,
     ) -> tuple[list[Segment], int]:
         if not is_animated:
-            return super()._get_tag_segments(
+            tag_segments, left_padding = super()._get_tag_segments(
                 metadata, is_animated, done, animation_status=animation_status
             )
+            tag_style = metadata.get("tag_style")
+            if isinstance(tag_style, (str, Style)):
+                style = self.console.get_style(tag_style)
+                tag_segments = [
+                    Segment(segment.text, style=style) for segment in tag_segments
+                ]
+
+            return tag_segments, left_padding
 
         emojis = [
             "🥚",
@@ -47,14 +66,96 @@ def _get_tag_segments(
         return [Segment(tag)], left_padding
 
 
-def get_rich_toolkit(minimal: bool = False) -> RichToolkit:
+class FastAPIRichToolkit(RichToolkit):
+    def __init__(
+        self,
+        style: BaseStyle | None = None,
+        theme: RichToolkitTheme | None = None,
+        handle_keyboard_interrupts: bool = True,
+        print_spacing: bool = True,
+    ) -> None:
+        super().__init__(
+            style=style,
+            theme=theme,
+            handle_keyboard_interrupts=handle_keyboard_interrupts,
+        )
+        self._print_spacing = print_spacing
+        self._version_check: BackgroundVersionCheck | None = None
+        self._print_update_on_exit = False
+
+    def __enter__(self) -> "FastAPIRichToolkit":
+        self._version_check = self._get_version_check()
+
+        if self._print_spacing:
+            self.console.print()
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> bool | None:
+        is_keyboard_interrupt = exc_type is KeyboardInterrupt
+
+        if is_keyboard_interrupt and self._version_check is not None:
+            self._version_check.suppress()
+        elif self._print_update_on_exit:
+            self._print_update_message()
+
+        if self._print_spacing and not is_keyboard_interrupt:
+            self.console.print()
+
+        if self.handle_keyboard_interrupts and is_keyboard_interrupt:
+            return True
+
+        return None
+
+    def _get_version_check(self) -> BackgroundVersionCheck | None:
+        if os.environ.get(DISABLE_VERSION_CHECK_ENV) == "1":
+            return None
+
+        context = click.get_current_context(silent=True)
+        if context is None:
+            version_check = BackgroundVersionCheck()
+            version_check.start()
+            self._print_update_on_exit = True
+            return version_check
+
+        stored_version_check = context.meta.get(VERSION_CHECK_CONTEXT_KEY)
+        if isinstance(stored_version_check, BackgroundVersionCheck):
+            return stored_version_check
+
+        version_check = BackgroundVersionCheck()
+        version_check.start()
+        context.meta[VERSION_CHECK_CONTEXT_KEY] = version_check
+        context.call_on_close(self._print_update_message)
+
+        return version_check
+
+    def _print_update_message(self) -> None:
+        if self._version_check is None:
+            return
+
+        message = self._version_check.get_update_message()
+        if message:
+            self.print(Text.from_markup(message), tag="update", tag_style="tag.update")
+
+
+def get_rich_toolkit(
+    minimal: bool = False,
+    *,
+    print_spacing: bool = True,
+    handle_keyboard_interrupts: bool = True,
+) -> RichToolkit:
     style = MinimalStyle() if minimal else FastAPIStyle(tag_width=11)
 
     theme = RichToolkitTheme(
         style=style,
         theme={
             "tag.title": "white on #009485",
             "tag": "white on #007166",
+            "tag.update": "black on yellow",
             "placeholder": "grey62",
             "text": "white",
             "selected": "#007166",
@@ -65,4 +166,8 @@ def get_rich_toolkit(minimal: bool = False) -> RichToolkit:
         },
     )
 
-    return RichToolkit(theme=theme)
+    return FastAPIRichToolkit(
+        theme=theme,
+        handle_keyboard_interrupts=handle_keyboard_interrupts,
+        print_spacing=print_spacing,
+    )