Python SDK (polylingo)

Client Python ufficiale per la PolyLingo REST API. Utilizza httpx e fornisce client sia sincroni che asincroni con gli stessi nomi di metodo.

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

Per dettagli HTTP grezzi, vedi API reference.

Installazione

pip install polylingo

Python: >= 3.9

Client sincrono

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # opzionale; default mostrato
    timeout=120.0,  # opzionale; secondi per richiesta (default 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())

Client asincrono

import polylingo

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

Usa await client.aclose() se non usi async with.

I nomi dei metodi corrispondono al client sincrono; tutti i metodi di rete sono async def.

Metodi (sincroni e asincroni)

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",  # opzionale
    source="en",        # opzionale
    model="standard",   # opzionale: "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 — restituisce il corpo 202 (job_id, status, …).

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

get(job_id) / await get(job_id)

GET /jobs/:id. Quando status == "completed", le risposte includono translations e usage a livello superiore.

translate(...) — comodità

Fa polling finché non è completed o failed, o finché il tempo non scade.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # secondi tra i polling; default 5.0
    timeout=600.0,        # budget totale in secondi; default 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,
)

Stati API: pending, processing, completed, failed.

Eccezioni

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)

Pattern lavori asincroni (sintesi)

1. Manuale: jobs.create → ciclo jobs.get fino a stato terminale.
2. Helper: jobs.translate con poll_interval, timeout e opzionale on_progress.

Preferisci jobs per contenuti molto grandi dove translate sincrono potrebbe incorrere in timeout client o server.

Tipi

Il pacchetto include py.typed. Gli oggetti di risposta sono valori dict semplici allineati con l'API; usa annotazioni in stile TypedDict nel tuo codice se desideri.

Changelog

0.1.0

• Rilascio iniziale: sync PolyLingo, async AsyncPolyLingo, copertura completa degli endpoint incluso helper polling jobs.translate.