Python SDK (polylingo)

Officiell Python-klient för PolyLingo REST API. Den använder httpx och tillhandahåller både synkrona och asynkrona klienter med samma metodnamn.

• PyPI: polylingo
• Källa: UsePolyLingo/polylingo-python

För råa HTTP-detaljer, se API-referens.

Installation

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",  # valfritt; standardvärde visas
    timeout=120.0,  # valfritt; sekunder per förfrågan (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())

Asynkron klient

import polylingo

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

Använd await client.aclose() om du inte använder async with.

Metodnamnen matchar den synkrona klienten; alla nätverksmetoder är async def.

Metoder (sync och 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",  # valfritt
    source="en",        # valfritt
    model="standard",   # valfritt: "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 — returnerar 202-kroppen (job_id, status, …).

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

get(job_id) / await get(job_id)

GET /jobs/:id. När status == "completed" inkluderar svaren translations och usage på översta nivån.

translate(...) — bekvämlighet

Pollar tills completed eller failed, eller tills tiden går ut.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekunder mellan pollar; standard 5.0
    timeout=600.0,        # totalt antal sekunder; 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-statusar: pending, processing, completed, failed.

Undantag

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-mönster (sammanfattning)

1. Manuell: jobs.create → loopa jobs.get tills terminalt tillstånd.
2. Hjälp: jobs.translate med poll_interval, timeout och valfri on_progress.

Föredra jobs för mycket stort innehåll där synkron translate kan träffa klient- eller server-timeouter.

Typer

Paketet levereras med py.typed. Svarobjekt är vanliga dict-värden anpassade till API; använd TypedDict-liknande annotationer i din kod om du vill.

Changelog

0.1.0

• Initial release: sync PolyLingo, async AsyncPolyLingo, full endpoint-täckning inklusive jobs.translate polling-hjälp.