File size: 6,400 Bytes
81b02bf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | """Providers for launching ASGI applications via ``uv run``."""
from __future__ import annotations
import os
import socket
import subprocess
import time
from typing import Dict, Optional
import requests
from .providers import RuntimeProvider
def _check_uv_installed() -> None:
try:
subprocess.check_output(["uv", "--version"])
except FileNotFoundError as exc:
raise RuntimeError(
"`uv` executable not found. Install uv from https://docs.astral.sh and ensure it is on PATH."
) from exc
def _find_free_port() -> int:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
sock.bind(("", 0))
sock.listen(1)
return sock.getsockname()[1]
def _create_uv_command(
*,
host: str,
port: int,
reload: bool,
workers: int,
app: str,
project_path: str,
) -> list[str]:
command: list[str] = ["uv", "run", "--isolated", "--project", project_path]
command.append("--")
command.extend(
[
"uvicorn",
app,
"--host",
host,
"--port",
str(port),
"--workers",
str(workers),
]
)
if reload:
command.append("--reload")
return command
def _poll_health(health_url: str, timeout_s: float) -> None:
"""Poll a health endpoint until it returns HTTP 200 or times out."""
deadline = time.time() + timeout_s
while time.time() < deadline:
try:
timeout = max(0.0001, min(deadline - time.time(), 2.0))
response = requests.get(health_url, timeout=timeout)
if response.status_code == 200:
return
except requests.RequestException:
continue
time.sleep(0.5)
raise TimeoutError(f"Server did not become ready within {timeout_s:.1f} seconds")
class UVProvider(RuntimeProvider):
"""
RuntimeProvider implementation backed by ``uv run``.
Args:
project_path: Local path to a uv project (passed to ``uv run --project``)
app: ASGI application path for uvicorn (defaults to ``server.app:app``)
host: Host interface to bind to (defaults to ``0.0.0.0``)
reload: Whether to enable uvicorn's reload mode
env_vars: Environment variables to pass through to the spawned process
context_timeout_s: How long to wait for the environment to become ready
Example:
>>> provider = UVProvider(project_path="/path/to/env")
>>> base_url = provider.start()
>>> print(base_url) # http://localhost:8000
>>> # Use the environment via base_url
>>> provider.stop()
"""
def __init__(
self,
*,
project_path: str,
app: str = "server.app:app",
host: str = "0.0.0.0",
reload: bool = False,
env_vars: Optional[Dict[str, str]] = None,
context_timeout_s: float = 60.0,
):
"""Initialize the UVProvider."""
self.project_path = os.path.abspath(project_path)
self.app = app
self.host = host
self.reload = reload
self.env_vars = env_vars
self.context_timeout_s = context_timeout_s
_check_uv_installed()
self._process = None
self._base_url = None
def start(
self,
port: Optional[int] = None,
env_vars: Optional[Dict[str, str]] = None,
workers: int = 1,
**_: Dict[str, str],
) -> str:
"""
Start the environment via `uv run`.
Args:
port: The port to bind the environment to
env_vars: Environment variables to pass to the environment
workers: The number of workers to use
Returns:
The base URL of the environment
Raises:
RuntimeError: If the environment is already running
"""
if self._process is not None and self._process.poll() is None:
raise RuntimeError("UVProvider is already running")
bind_port = port or _find_free_port()
command = _create_uv_command(
host=self.host,
port=bind_port,
reload=self.reload,
workers=workers,
app=self.app,
project_path=self.project_path,
)
env = os.environ.copy()
if self.env_vars:
env.update(self.env_vars)
if env_vars:
env.update(env_vars)
try:
self._process = subprocess.Popen(command, env=env)
except OSError as exc:
raise RuntimeError(f"Failed to launch `uv run`: {exc}") from exc
client_host = "127.0.0.1" if self.host in {"0.0.0.0", "::"} else self.host
self._base_url = f"http://{client_host}:{bind_port}"
return self._base_url
def wait_for_ready(self, timeout_s: float = 60.0) -> None:
"""
Wait for the environment to become ready.
Args:
timeout_s: The timeout to wait for the environment to become ready
Raises:
RuntimeError: If the environment is not running
TimeoutError: If the environment does not become ready within the timeout
"""
if self._process and self._process.poll() is not None:
code = self._process.returncode
raise RuntimeError(f"uv process exited prematurely with code {code}")
_poll_health(f"{self._base_url}/health", timeout_s=timeout_s)
def stop(self) -> None:
"""
Stop the environment.
Raises:
RuntimeError: If the environment is not running
"""
if self._process is None:
return
if self._process.poll() is None:
self._process.terminate()
try:
self._process.wait(timeout=10.0)
except subprocess.TimeoutExpired:
self._process.kill()
self._process.wait(timeout=5.0)
self._process = None
self._base_url = None
@property
def base_url(self) -> str:
"""
The base URL of the environment.
Returns:
The base URL of the environment
Raises:
RuntimeError: If the environment is not running
"""
if self._base_url is None:
raise RuntimeError("UVProvider has not been started")
return self._base_url
|