Merge pull request #222 from darrenburns/startup-time

Startup time improvements

Author: darrenburns

.coverage

@@ -1,3 +1,13 @@
+## 2.5.3 [13th March 2025]
+
+### Changed
+
+- Lazily load content of tabs which are hidden on startup (100ms saved at startup).
+- Only import openapi-pydantic when importing OpenAPI specs via `posting import` (63ms saved at startup).
+- Pin httpx and patch out httpx._main to prevent slow import (20ms saved at startup).
+- Defer import of watchfiles until app is running (6ms saved at startup).
+- Defer `HelpScreen` import until it's used (10ms saved at startup).
+
 ## 2.5.2 [8th March 2025]
 
 ### Added

docs/CHANGELOG.md

@@ -1,6 +1,6 @@
 [project]
 name = "posting"
-version = "2.5.2"
+version = "2.5.3"
 description = "The modern API client that lives in your terminal."
 authors = [
     { name = "Darren Burns", email = "darrenb900@gmail.com" }
@@ -9,18 +9,19 @@ dependencies = [
     "click>=8.1.7,<9.0.0",
     "xdg-base-dirs>=6.0.1,<7.0.0",
     "click-default-group>=1.2.4,<2.0.0",
-    "httpx[brotli]>=0.27.2,<1.0.0",
+    "httpx[brotli]==0.28.1",
+    # pinned httpx automatically since we monkeypatch _main.py
     "openapi-pydantic>=0.5.0",
     "pyperclip>=1.9.0,<2.0.0",
     "pydantic>=2.9.2,<3.0.0",
     "pyyaml>=6.0.2,<7.0.0",
     "pydantic-settings>=2.4.0,<3.0.0",
     "python-dotenv>=1.0.1,<2.0.0",
-    "textual[syntax]==2.1.1",
     # pinned intentionally
     "textual-autocomplete==4.0.0a0",
     # pinned intentionally
     "watchfiles>=0.24.0",
+    "textual[syntax]>=2.1.2,<2.2.0",
 ]
 readme = "README.md"
 requires-python = ">= 3.11"
@@ -59,6 +60,7 @@ dev-dependencies = [
     "pytest-cov>=5.0.0",
     "pytest-textual-snapshot>=1.0.0",
     "mkdocs-material>=9.5.30",
+    "pyinstrument>=5.0.1",
 ]
 
 [tool.hatch.metadata]

pyproject.toml

@@ -1,3 +1,12 @@
+# This import should be the first thing to run, to ensure that
+# the START_TIME is set as early as possible.
+from posting._start_time import START_TIME  # type: ignore # noqa: F401
+    
+
+# This is a hack to prevent httpx from importing _main.py
+import sys
+sys.modules['httpx._main'] = None
+
 from .collection import (
     Auth,
     Cookie,

src/posting/__init__.py

@@ -1,3 +1,4 @@
+"""The main entry point for the Posting CLI."""
 from pathlib import Path
 import click
 
@@ -7,7 +8,6 @@
 from posting.app import Posting
 from posting.collection import Collection
 from posting.config import Settings
-from posting.importing.open_api import import_openapi_spec
 from posting.locations import (
     config_file,
     default_collection_directory,
@@ -105,6 +105,11 @@ def import_spec(spec_path: str, output: str | None) -> None:
     console.print(
         "Importing is currently an experimental feature.", style="bold yellow"
     )
+
+    # We defer this import as it takes 64ms on an M4 MacBook Pro,
+    # and is only needed for a single CLI command - not for the main TUI.
+    from posting.importing.open_api import import_openapi_spec
+
     try:
         collection = import_openapi_spec(spec_path)
 

src/posting/__main__.py

@@ -0,0 +1,4 @@
+import time
+
+
+START_TIME = time.perf_counter_ns()

src/posting/_start_time.py

@@ -23,15 +23,8 @@
 from textual.signal import Signal
 from textual.theme import Theme, BUILTIN_THEMES as TEXTUAL_THEMES
 from textual.widget import Widget
-from textual.widgets import (
-    Button,
-    Footer,
-    Input,
-    Label,
-    TextArea,
-)
+from textual.widgets import Button, Footer, Input, Label
 from textual.widgets._tabbed_content import ContentTab
-from watchfiles import Change, awatch
 from posting.collection import (
     Collection,
     Cookie,
@@ -43,7 +36,6 @@
 
 from posting.commands import PostingProvider
 from posting.config import SETTINGS, Settings
-from posting.help_screen import HelpScreen
 from posting.jump_overlay import JumpOverlay
 from posting.jumper import Jumper
 from posting.scripts import execute_script, uncache_module, Posting as PostingContext
@@ -227,6 +219,7 @@ def compose(self) -> ComposeResult:
             yield collection_browser
             yield RequestEditor()
             yield ResponseArea()
+
         yield Footer(show_command_palette=False)
 
     def get_and_run_script(
@@ -618,8 +611,8 @@ def watch_expanded_section(
         request_editor.set_class(section == "response", "hidden")
         response_area.set_class(section == "request", "hidden")
 
-    @on(TextArea.Changed, selector="RequestBodyTextArea")
-    def on_request_body_change(self, event: TextArea.Changed) -> None:
+    @on(RequestBodyTextArea.Changed, selector="RequestBodyTextArea")
+    def on_request_body_change(self, event: RequestBodyTextArea.Changed) -> None:
         """Update the body tab to indicate if there is a body."""
         body_tab = self.query_one("#--content-tab-body-pane", ContentTab)
         if event.text_area.text:
@@ -965,9 +958,19 @@ def __init__(
     _jumping: Reactive[bool] = reactive(False, init=False, bindings=True)
     """True if 'jump mode' is currently active, otherwise False."""
 
+    def on_ready(self) -> None:
+        import time
+        from posting._start_time import START_TIME
+
+        message = f"Posting started in {(time.perf_counter_ns() - START_TIME) // 1_000_000} milliseconds."
+        log.debug(message)
+
     @work(exclusive=True, group="environment-watcher")
     async def watch_environment_files(self) -> None:
         """Watching files that were passed in as the environment."""
+
+        from watchfiles import awatch
+
         async for changes in awatch(*self.environment_files):
             # Reload the variables from the environment files.
             load_variables(
@@ -993,6 +996,9 @@ async def watch_environment_files(self) -> None:
     @work(exclusive=True, group="collection-watcher")
     async def watch_collection_files(self) -> None:
         """Watching specific files within the collection directory."""
+
+        from watchfiles import awatch, Change
+
         async for changes in awatch(self.collection.path):
             for change_type, file_path in changes:
                 if file_path.endswith(".py"):
@@ -1021,6 +1027,9 @@ async def watch_collection_files(self) -> None:
     @work(exclusive=True, group="theme-watcher")
     async def watch_themes(self) -> None:
         """Watching the theme directory for changes."""
+
+        from watchfiles import awatch
+
         async for changes in awatch(self.settings.theme_directory):
             for _change_type, file_path in changes:
                 if file_path.endswith((".yml", ".yaml")):
@@ -1283,6 +1292,8 @@ def reset_focus(_) -> None:
                 self.screen.set_focus(focused)
 
         self.set_focus(None)
+        from posting.help_screen import HelpScreen
+
         await self.push_screen(HelpScreen(widget=focused), callback=reset_focus)
 
     def exit(

src/posting/app.py

@@ -7,34 +7,18 @@
 import httpx
 from pydantic import BaseModel, Field, HttpUrl
 import rich
-import yaml
 import os
 from textual import log
 from posting.auth import HttpxBearerTokenAuth
 from posting.tuple_to_multidict import tuples_to_dict
 from posting.variables import SubstitutionError
 from posting.version import VERSION
-
+from posting.yaml import dump, load, Loader
 
 HttpRequestMethod = Literal["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]
 VALID_HTTP_METHODS = get_args(HttpRequestMethod)
 
 
-def str_presenter(dumper, data):
-    if data.count("\n") > 0:
-        data = "\n".join(
-            [line.rstrip() for line in data.splitlines()]
-        )  # Remove any trailing spaces, then put it back together again
-        return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")
-    return dumper.represent_scalar("tag:yaml.org,2002:str", data)
-
-
-yaml.add_representer(str, str_presenter)
-yaml.representer.SafeRepresenter.add_representer(
-    str, str_presenter
-)  # to use with safe_dump
-
-
 class Auth(BaseModel):
     type: Literal["basic", "digest", "bearer_token"] | None = Field(default=None)
     basic: BasicAuth | None = Field(default=None)
@@ -284,7 +268,7 @@ def to_httpx(self, client: httpx.AsyncClient) -> httpx.Request:
     def save_to_disk(self, path: Path) -> None:
         """Save the request model to a YAML file."""
         content = self.model_dump(exclude_defaults=True, exclude_none=True)
-        yaml_content = yaml.dump(
+        yaml_content = dump(
             content,
             None,
             sort_keys=False,
@@ -552,5 +536,5 @@ def load_request_from_yaml(file_path: str) -> RequestModel:
         RequestModel: The request model loaded from the YAML file.
     """
     with open(file_path, "r") as file:
-        data = yaml.safe_load(file)
+        data = load(file, Loader=Loader)
         return RequestModel(**data, path=Path(file_path))

src/posting/collection.py

@@ -12,7 +12,6 @@
 from textual.types import AnimationLevel
 
 from posting.locations import config_file, theme_directory
-
 from posting.types import PostingLayout
 
 

src/posting/config.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass, field
+
+
+@dataclass
+class HelpData:
+    """Data relating to the widget to be displayed in the HelpScreen"""
+
+    title: str = field(default="")
+    """Title of the widget"""
+    description: str = field(default="")
+    """Markdown description to be displayed in the HelpScreen"""