Python SDK (polylingo)

Oficjalny klient Python dla PolyLingo REST API. Używa httpx i zapewnia zarówno klientów sync, jak i async z tymi samymi nazwami metod.

• PyPI: polylingo
• Źródło: UsePolyLingo/polylingo-python

Szczegóły surowego HTTP znajdziesz w odniesieniu do API.

Instalacja

pip install polylingo

Python: >= 3.9

Klient synchroniczny

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # opcjonalne; domyślne
    timeout=120.0,  # opcjonalne; sekundy na żądanie (domyślnie 120)
)

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

client.close()

Menedżer kontekstu:

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

Klient asynchroniczny

import polylingo

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

Użyj await client.aclose(), jeśli nie korzystasz z async with.

Nazwy metod są takie same jak w kliencie synchronicznym; wszystkie metody sieciowe są async def.

Metody (sync i 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",  # opcjonalne
    source="en",        # opcjonalne
    model="standard",   # opcjonalne: "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()

Zadania — client.jobs

create / await create

POST /jobs — zwraca ciało 202 (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs również akceptowane: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Gdy status == "completed", odpowiedzi zawierają na najwyższym poziomie translations i usage.

translate(...) — metoda wygodna

Polling aż do completed lub failed, lub do wyczerpania czasu.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekundy między pollingiem; domyślnie 5.0
    timeout=600.0,        # **całkowity** budżet sekund; domyślnie 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,
)

Statusy API: pending, processing, completed, failed.

Wyjątki

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)

Wzorzec zadań asynchronicznych (podsumowanie)

1. Ręcznie: jobs.create → pętla jobs.get aż do stanu końcowego.
2. Pomocnik: jobs.translate z poll_interval, timeout i opcjonalnym on_progress.

Preferuj zadania dla bardzo dużych treści, gdzie synchroniczne translate może napotkać timeouty klienta lub serwera.

Typy

Pakiet zawiera py.typed. Obiekty odpowiedzi to zwykłe wartości dict zgodne z API; używaj adnotacji w stylu TypedDict w swoim kodzie, jeśli chcesz.

Dziennik zmian

0.1.0

• Pierwsze wydanie: sync PolyLingo, async AsyncPolyLingo, pełne pokrycie endpointów w tym pomocnik pollingu jobs.translate.