Python SDK (polylingo)

Oficiální Python klient pro PolyLingo REST API. Používá httpx a poskytuje jak sync, tak async klienty se stejnými názvy metod.

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

Pro podrobnosti o surovém HTTP viz API reference.

Instalace

pip install polylingo

Python: >= 3.9

Sync klient

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # nepovinné; výchozí hodnota
    timeout=120.0,  # nepovinné; sekundy na požadavek (výchozí 120)
)

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

client.close()

Správce kontextu:

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

Async klient

import polylingo

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

Použijte await client.aclose(), pokud nepoužíváte async with.

Názvy metod odpovídají sync klientovi; všechny síťové metody jsou async def.

Metody (sync a 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",  # nepovinné
    source="en",        # nepovinné
    model="standard",   # nepovinné: "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 — vrací tělo 202 (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs také přijímá: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Když status == "completed", odpovědi obsahují translations a usage na nejvyšší úrovni.

translate(...) — pohodlí

Polling dokud není completed nebo failed, nebo dokud nevyprší čas.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekundy mezi pollováním; výchozí 5.0
    timeout=600.0,        # **celkový** časový limit v sekundách; výchozí 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,
)

Stavy API: pending, processing, completed, failed.

Výjimky

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 vzor (shrnutí)

1. Manuální: jobs.create → smyčka jobs.get dokud není konečný stav.
2. Pomocník: jobs.translate s poll_interval, timeout a volitelným on_progress.

Preferujte jobs pro velmi velký obsah, kde synchronní translate může narazit na timeouty klienta nebo serveru.

Typy

Balíček obsahuje py.typed. Odpovědní objekty jsou obyčejné dict hodnoty sladěné s API; použijte anotace ve stylu TypedDict ve svém kódu, pokud chcete.

Změny

0.1.0

• První vydání: sync PolyLingo, async AsyncPolyLingo, plné pokrytí endpointů včetně pomocníka pro polling jobs.translate.