Python SDK (polylingo)

Offizieller Python-Client für die PolyLingo REST API. Er verwendet httpx und bietet sowohl sync als auch async Clients mit denselben Methodennamen.

• PyPI: polylingo
• Quelle: UsePolyLingo/polylingo-python

Für rohe HTTP-Details siehe API reference.

Installation

pip install polylingo

Python: >= 3.9

Sync-Client

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # optional; Standardwert angezeigt
    timeout=120.0,  # optional; Sekunden pro Anfrage (Standard 120)
)

result = client.translate(content="# Hello", targets=["es", "fr"], format="markdown")
print(result["translations"]["es"])

client.close()

Context Manager:

with polylingo.PolyLingo(api_key="...") as client:
    print(client.languages())

Async-Client

import polylingo

async with polylingo.AsyncPolyLingo(api_key="...") as client:
    r = await client.translate(content="Hi", targets=["de"])

Verwenden Sie await client.aclose(), wenn Sie async with nicht verwenden.

Methodennamen entsprechen dem Sync-Client; alle Netzwerkmethoden sind async def.

Methoden (sync und async)

health() / await health()

GET /health

h = client.health()
# async: h = await client.health()

languages() / await languages()

GET /languages

data = client.languages()
langs = data["languages"]

translate(...)

POST /translate

r = client.translate(
    content="# Hello",
    targets=["es", "fr"],
    format="markdown",  # optional
    source="en",        # optional
    model="standard",   # optional: "standard" | "advanced"
)
r["translations"]["es"]
r["usage"]["total_tokens"]

batch(...)

POST /translate/batch

b = client.batch(
    items=[
        {"id": "a", "content": "Hello"},
        {"id": "b", "content": "## Title", "format": "markdown"},
    ],
    targets=["de"],
)
b["results"][0]["translations"]["de"]

usage() / await usage()

GET /usage

u = client.usage()

Jobs — client.jobs

create / await create

POST /jobs — gibt den 202 Body zurück (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs werden ebenfalls akzeptiert: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Wenn status == "completed", enthalten die Antworten translations und usage auf oberster Ebene.

translate(...) — Komfortfunktion

Pollt, bis completed oder failed erreicht ist oder die Zeit abgelaufen ist.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # Sekunden zwischen den Polls; Standard 5.0
    timeout=600.0,        # **Gesamt** Sekundenbudget; Standard 1200 (20 Min)
    on_progress=lambda pos: print(f"Queue: {pos}"),
)
done["translations"]["de"]

Async:

done = await client.jobs.translate(
    content=long_md,
    targets=["de"],
    poll_interval=2.0,
    timeout=300.0,
)

API-Status: pending, processing, completed, failed.

Ausnahmen

import polylingo

try:
    client.translate(content="x", targets=["es"])
except polylingo.AuthError as e:
    print(e.status, e.error)
except polylingo.RateLimitError as e:
    print(e.retry_after)
except polylingo.JobFailedError as e:
    print(e.job_id)
except polylingo.PolyLingoError as e:
    print(e.status, e.error)

Async Jobs Muster (Zusammenfassung)

1. Manuell: jobs.create → Schleife jobs.get bis Endzustand.
2. Helfer: jobs.translate mit poll_interval, timeout und optional on_progress.

Bevorzugen Sie Jobs für sehr große Inhalte, bei denen synchrones translate Client- oder Server-Timeouts verursachen könnte.

Typen

Das Paket enthält py.typed. Antwortobjekte sind einfache dict-Werte, die mit der API übereinstimmen; verwenden Sie TypedDict-ähnliche Annotationen in Ihrem Code, falls gewünscht.

Änderungsprotokoll

0.1.0

• Erste Veröffentlichung: sync PolyLingo, async AsyncPolyLingo, vollständige Endpunktabdeckung einschließlich jobs.translate Polling-Helfer.