Merge branch 'main' into extend-terminal-guesswork

Author: davep

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "textual-dev"
-version = "1.2.0"
+version = "1.2.1"
 homepage = "https://github.com/Textualize/textual-dev"
 description = "Development tools for working with Textual"
 authors = ["Will McGugan <will@textualize.io>", "Dave Pearson <dave@textualize.io>"]
@@ -28,7 +28,7 @@ include = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-textual = ">=0.33.0"
+textual = ">=0.36.0"
 aiohttp = ">=3.8.1"
 click = ">=8.1.2"
 msgpack = ">=1.0.3"

pyproject.toml

@@ -5,7 +5,7 @@
 
 import click
 from importlib_metadata import version
-from textual.constants import DEVTOOLS_PORT
+from textual.constants import DEVTOOLS_HOST, DEVTOOLS_PORT
 
 from .tools.run import exec_command, run_app
 
@@ -91,13 +91,21 @@ def _pre_run_warnings() -> None:
 )
 @click.argument("import_name", metavar="FILE or FILE:APP")
 @click.option("--dev", "dev", help="Enable development mode.", is_flag=True)
+@click.option(
+    "--host",
+    "host",
+    type=str,
+    default=None,
+    metavar="HOST",
+    help=f"Host where the development console is running. Defaults to {DEVTOOLS_HOST}.",
+)
 @click.option(
     "--port",
     "port",
     type=int,
     default=None,
     metavar="PORT",
-    help=f"Port to use for the development mode console. Defaults to {DEVTOOLS_PORT}.",
+    help=f"Port where the development console is running. Defaults to {DEVTOOLS_PORT}.",
 )
 @click.option(
     "--press", "press", default=None, help="Comma separated keys to simulate press."
@@ -131,6 +139,7 @@ def _pre_run_warnings() -> None:
 def _run_app(
     import_name: str,
     dev: bool,
+    host: str | None,
     port: int | None,
     press: str | None,
     screenshot: int | None,
@@ -176,6 +185,8 @@ def _run_app(
         features.add("devtools")
 
     environment["TEXTUAL"] = ",".join(sorted(features))
+    if host is not None:
+        environment["TEXTUAL_DEVTOOLS_HOST"] = str(host)
     if port is not None:
         environment["TEXTUAL_DEVTOOLS_PORT"] = str(port)
     if press is not None:

src/textual_dev/cli.py

@@ -17,6 +17,7 @@
 from textual._log import LogGroup, LogVerbosity
 from textual.constants import DEVTOOLS_PORT
 
+READY_TIMEOUT = 0.5
 WEBSOCKET_CONNECT_TIMEOUT = 3
 LOG_QUEUE_MAXSIZE = 512
 
@@ -102,6 +103,7 @@ def __init__(self, host: str = "127.0.0.1", port: int | None = None) -> None:
         self.log_queue: Queue[str | bytes | Type[ClientShutdown]] | None = None
         self.spillover: int = 0
         self.verbose: bool = False
+        self._ready_event: asyncio.Event = asyncio.Event()
 
     async def connect(self) -> None:
         """Connect to the devtools server.
@@ -139,6 +141,7 @@ async def update_console() -> None:
                         self.console.width = payload["width"]
                         self.console.height = payload["height"]
                         self.verbose = payload.get("verbose", False)
+                        self._ready_event.set()
 
         async def send_queued_logs():
             """Coroutine function which is scheduled as a Task, which consumes
@@ -156,9 +159,18 @@ async def send_queued_logs():
                     await websocket.send_bytes(log)
                 log_queue.task_done()
 
+        async def server_info_received() -> None:
+            """Wait for the first server info message to be received and handled."""
+            try:
+                await asyncio.wait_for(self._ready_event.wait(), timeout=READY_TIMEOUT)
+            except asyncio.TimeoutError:
+                return
+
         self.log_queue_task = asyncio.create_task(send_queued_logs())
         self.update_console_task = asyncio.create_task(update_console())
 
+        await server_info_received()
+
     async def _stop_log_queue_processing(self) -> None:
         """Schedule end of processing of the log queue, meaning that any messages a
         user logs will be added to the queue, but not consumed and sent to

src/textual_dev/client.py

@@ -1,4 +1,5 @@
 from typing import cast
+
 from textual.app import App, ComposeResult
 from textual.containers import Vertical
 from textual.css.constants import VALID_BORDER

src/textual_dev/previews/borders.py

@@ -3,13 +3,14 @@
 from rich.console import RenderableType
 from textual._easing import EASING
 from textual.app import App, ComposeResult
-from textual_dev.previews.borders import TEXT
 from textual.containers import Horizontal, Vertical
 from textual.reactive import reactive, var
 from textual.scrollbar import ScrollBarRender
 from textual.widget import Widget
 from textual.widgets import Button, Footer, Input, Label
 
+from textual_dev.previews.borders import TEXT
+
 VIRTUAL_SIZE = 100
 WINDOW_SIZE = 10
 START_POSITION = 0.0

src/textual_dev/previews/easing.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
 import inspect
+from types import FrameType
 from typing import TYPE_CHECKING, cast
 
 from textual._log import LogGroup, LogVerbosity
+
 from .client import DevtoolsLog
 
 if TYPE_CHECKING:
@@ -27,19 +29,20 @@ def __init__(self, devtools: DevtoolsClient) -> None:
         self.devtools = devtools
         self._buffer: list[DevtoolsLog] = []
 
-    def write(self, string: str) -> None:
+    def write(self, string: str, current_frame: FrameType | None = None) -> None:
         """Write the log string to the internal buffer. If the string contains
         a newline character `\n`, the whole string will be buffered and then the
         buffer will be flushed immediately after.
 
         Args:
             string: The string to write to the buffer.
+            current_frame: The optional frame of the caller, used in logging.
         """
 
         if not self.devtools.is_connected:
             return
 
-        current_frame = inspect.currentframe()
+        current_frame = current_frame or inspect.currentframe()
         assert current_frame is not None
         previous_frame = current_frame.f_back
         assert previous_frame is not None

src/textual_dev/redirect_output.py

@@ -160,7 +160,9 @@ def _console() -> None:
 
 def diagnose() -> None:
     """Print information about Textual and its environment to help diagnose problems."""
-    print("<!-- This is valid Markdown, do not quote! -->")
+    print(
+        "<!-- This is valid Markdown, please paste the following directly in to a GitHub issue -->"
+    )
     print("# Textual Diagnostics")
     print()
     _versions()