Python SDK (polylingo)

Offisiell Python-klient for PolyLingo REST API. Den bruker httpx og tilbyr både synkrone og asynkrone klienter med samme metodenavn.

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

For rå HTTP-detaljer, se API-referanse.

Installasjon

pip install polylingo

Python: >= 3.9

Synkron klient

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # valgfritt; standard vist
    timeout=120.0,  # valgfritt; sekunder per forespørsel (standard 120)
)

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

client.close()

Kontekstbehandler:

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

Asynkron klient

import polylingo

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

Bruk await client.aclose() hvis du ikke bruker async with.

Metodenavn samsvarer med den synkrone klienten; alle nettverksmetoder er async def.

Metoder (synkron og asynkron)

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",  # valgfritt
    source="en",        # valgfritt
    model="standard",   # valgfritt: "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()

Jobber — client.jobs

create / await create

POST /jobs — returnerer 202-respons (job_id, status, …).

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

get(job_id) / await get(job_id)

GET /jobs/:id. Når status == "completed", inkluderer svarene translations og usage på øverste nivå.

translate(...) — praktisk metode

Poller til completed eller failed, eller til tiden går ut.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekunder mellom polling; standard 5.0
    timeout=600.0,        # **total** sekunder budsjett; 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-statusser: pending, processing, completed, failed.

Unntak

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 jobbmønster (oppsummering)

1. Manuell: jobs.create → løkke jobs.get til terminal tilstand.
2. Hjelper: jobs.translate med poll_interval, timeout, og valgfri on_progress.

Foretrekk jobber for veldig stort innhold der synkron translate kan treffe klient- eller server-tidsavbrudd.

Typer

Pakken leveres med py.typed. Responsobjekter er vanlige dict-verdier som samsvarer med API; bruk TypedDict-stil annotasjoner i koden din om ønskelig.

Endringslogg

0.1.0

• Første utgivelse: synkron PolyLingo, asynkron AsyncPolyLingo, full endepunktdekning inkludert jobs.translate polling-hjelper.