Merge origin/main into docs/agents-pr-only
CI / Backend (push) Successful in 11s
CI / CLI (push) Successful in 11s

This commit is contained in:
2026-06-04 17:44:34 +02:00
7 changed files with 146 additions and 17 deletions
+3
View File
@@ -1,3 +1,6 @@
__pycache__/
.pytest_cache/
*.egg-info/
.venv/
.venv-ci/
build/
+11 -1
View File
@@ -9,8 +9,17 @@ Two separate Python packages live here:
The repo also includes a Gitea Actions workflow at `.gitea/workflows/ci.yml` that tests and builds both packages on pushes to `main` and pull requests.
## Backend setup
## Docker backend (no image build)
Run the backend directly from an official Python image without creating a Dockerfile:
```bash
docker compose up backend
```
This uses `python:3.14-slim`, installs `ffmpeg` and `openai-whisper` at container startup, mounts this repo into the container, and serves the API on `http://localhost:8000`.
## Backend setup
```bash
cd backend
pip install -e .
@@ -50,3 +59,4 @@ whisper-remote ./audio.mp3 --model base --language en --output-format txt
- backend-side cleanup of uploaded and generated files after each request
By default the CLI prints the returned transcript to stdout. Use `--to-file` to save it locally.
+10
View File
@@ -17,6 +17,7 @@ CONTENT_TYPES = {
}
app = FastAPI(title="whisper-remote-backend")
WHISPER_PROCESS_TIMEOUT_SECONDS = 300
def validate_output_format(output_format: str) -> str:
@@ -112,12 +113,21 @@ async def transcribe(
check=False,
capture_output=True,
text=True,
timeout=WHISPER_PROCESS_TIMEOUT_SECONDS,
)
except FileNotFoundError as exc:
raise HTTPException(
status_code=500,
detail="The 'whisper' CLI was not found on PATH on the backend host.",
) from exc
except subprocess.TimeoutExpired as exc:
raise HTTPException(
status_code=504,
detail=(
"Whisper CLI timed out after "
f"{WHISPER_PROCESS_TIMEOUT_SECONDS}s and was terminated."
),
) from exc
if completed.returncode != 0:
detail = completed.stderr.strip() or completed.stdout.strip() or "Whisper CLI failed."
+30 -2
View File
@@ -43,7 +43,7 @@ def test_transcriptions_returns_generated_artifact(monkeypatch, tmp_path: Path)
lambda prefix="": FakeTemporaryDirectory(tmp_path, prefix, created_paths),
)
def fake_run(command: list[str], check: bool, capture_output: bool, text: bool):
def fake_run(command: list[str], check: bool, capture_output: bool, text: bool, timeout: int):
output_dir = Path(command[command.index("--output_dir") + 1])
(output_dir / "clip.txt").write_text("hello world", encoding="utf-8")
@@ -77,7 +77,7 @@ def test_transcriptions_maps_subprocess_failure(monkeypatch, tmp_path: Path) ->
lambda prefix="": FakeTemporaryDirectory(tmp_path, prefix, created_paths),
)
def fake_run(command: list[str], check: bool, capture_output: bool, text: bool):
def fake_run(command: list[str], check: bool, capture_output: bool, text: bool, timeout: int):
class Result:
returncode = 1
stdout = ""
@@ -97,3 +97,31 @@ def test_transcriptions_maps_subprocess_failure(monkeypatch, tmp_path: Path) ->
assert response.json()["detail"] == "bad whisper day"
assert created_paths
assert all(not path.exists() for path in created_paths)
def test_transcriptions_maps_subprocess_timeout(monkeypatch, tmp_path: Path) -> None:
created_paths: list[Path] = []
monkeypatch.setattr(
server,
"TemporaryDirectory",
lambda prefix="": FakeTemporaryDirectory(tmp_path, prefix, created_paths),
)
def fake_run(command: list[str], check: bool, capture_output: bool, text: bool, timeout: int):
raise server.subprocess.TimeoutExpired(cmd=command, timeout=timeout)
monkeypatch.setattr(server.subprocess, "run", fake_run)
response = client.post(
"/transcriptions",
data={"model": "base", "output_format": "txt"},
files={"file": ("clip.wav", b"audio", "audio/wav")},
)
assert response.status_code == 504
assert (
response.json()["detail"]
== f"Whisper CLI timed out after {server.WHISPER_PROCESS_TIMEOUT_SECONDS}s and was terminated."
)
assert created_paths
assert all(not path.exists() for path in created_paths)
+17 -1
View File
@@ -59,6 +59,19 @@ def save_response(response: httpx.Response, destination: Path) -> None:
destination.write_bytes(response.content)
def format_http_error(response: httpx.Response, endpoint: str) -> str:
body = response.text.strip() or "<empty response body>"
return f"HTTP {response.status_code} from {endpoint}: {body}"
def format_request_error(exc: httpx.RequestError, endpoint: str) -> str:
if isinstance(exc, httpx.TimeoutException):
return f"Request to {endpoint} timed out."
reason = str(exc).strip() or exc.__class__.__name__
return f"Request to {endpoint} failed: {reason}"
def main() -> int:
parser = build_parser()
args = parser.parse_args()
@@ -70,6 +83,7 @@ def main() -> int:
server = resolve_server(args)
endpoint = f"{server}/transcriptions"
try:
with input_file.open("rb") as handle, httpx.Client(timeout=300.0) as client:
response = client.post(
endpoint,
@@ -80,11 +94,13 @@ def main() -> int:
},
files={"file": (input_file.name, handle, "application/octet-stream")},
)
except httpx.RequestError as exc:
parser.exit(1, f"{format_request_error(exc, endpoint)}\n")
try:
response.raise_for_status()
except httpx.HTTPStatusError as exc:
message = exc.response.text.strip() or str(exc)
message = format_http_error(exc.response, endpoint)
parser.exit(1, f"{message}\n")
if args.to_file:
+43 -3
View File
@@ -1,9 +1,10 @@
import os
from argparse import Namespace
from dataclasses import dataclass
from pathlib import Path
import sys
from dataclasses import dataclass
import httpx
import pytest
sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
@@ -32,6 +33,37 @@ def test_infer_output_path_for_explicit_file(tmp_path: Path) -> None:
assert destination == tmp_path / "custom-name.txt"
def test_format_http_error_with_body() -> None:
request = httpx.Request("POST", "http://localhost:8000/transcriptions")
response = httpx.Response(500, text="Internal Server Error", request=request)
message = main.format_http_error(response, "http://localhost:8000/transcriptions")
assert message == "HTTP 500 from http://localhost:8000/transcriptions: Internal Server Error"
def test_format_http_error_with_empty_body() -> None:
request = httpx.Request("POST", "http://localhost:8000/transcriptions")
response = httpx.Response(500, text="", request=request)
message = main.format_http_error(response, "http://localhost:8000/transcriptions")
assert message == "HTTP 500 from http://localhost:8000/transcriptions: <empty response body>"
def test_format_request_error_timeout() -> None:
request = httpx.Request("POST", "http://localhost:8000/transcriptions")
exc = httpx.ReadTimeout("read timed out", request=request)
message = main.format_request_error(exc, "http://localhost:8000/transcriptions")
assert message == "Request to http://localhost:8000/transcriptions timed out."
def test_format_request_error_network_failure() -> None:
request = httpx.Request("POST", "http://localhost:8000/transcriptions")
exc = httpx.ConnectError("connection refused", request=request)
message = main.format_request_error(exc, "http://localhost:8000/transcriptions")
assert (
message
== "Request to http://localhost:8000/transcriptions failed: connection refused"
)
@dataclass
class FakeResponse:
content: bytes
@@ -61,8 +93,16 @@ def test_main_writes_transcript_to_file(monkeypatch, tmp_path: Path, capsys) ->
destination = tmp_path / "saved" / "clip.txt"
monkeypatch.setenv("WHISPER_REMOTE", "http://localhost:8000")
monkeypatch.setattr(main.httpx, "Client", lambda timeout: FakeClient(FakeResponse(b"hello world", "hello world")))
monkeypatch.setattr(sys, "argv", ["whisper-remote", str(input_file), "--model", "base", "--to-file", str(destination)])
monkeypatch.setattr(
main.httpx,
"Client",
lambda timeout: FakeClient(FakeResponse(b"hello world", "hello world")),
)
monkeypatch.setattr(
sys,
"argv",
["whisper-remote", str(input_file), "--model", "base", "--to-file", str(destination)],
)
exit_code = main.main()
+22
View File
@@ -0,0 +1,22 @@
services:
backend:
image: python:3.14-slim
working_dir: /app/backend
ports:
- "8000:8000"
volumes:
- ./:/app
- whisper_cache:/root/.cache
environment:
- PYTHONUNBUFFERED=1
command: >-
sh -lc "
apt-get update
&& apt-get install -y --no-install-recommends ffmpeg
&& rm -rf /var/lib/apt/lists/*
&& pip install --no-cache-dir -e . openai-whisper
&& uvicorn server:app --app-dir src --host 0.0.0.0 --port 8000
"
volumes:
whisper_cache: