SDK Python (polylingo)

Cliente oficial Python para a API REST do PolyLingo. Usa httpx e fornece clientes sync e async com os mesmos nomes de métodos.

• PyPI: polylingo
• Código-fonte: UsePolyLingo/polylingo-python

Para detalhes brutos do HTTP, veja referência da API.

Instalação

pip install polylingo

Python: >= 3.9

Cliente sync

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # opcional; padrão mostrado
    timeout=120.0,  # opcional; segundos por requisição (padrão 120)
)

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

client.close()

Gerenciador de contexto:

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

Cliente async

import polylingo

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

Use await client.aclose() se não usar async with.

Os nomes dos métodos coincidem com o cliente sync; todos os métodos de rede são async def.

Métodos (sync e 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",  # opcional
    source="en",        # opcional
    model="standard",   # opcional: "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 — retorna o corpo 202 (job_id, status, …).

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

get(job_id) / await get(job_id)

GET /jobs/:id. Quando status == "completed", as respostas incluem translations e usage no nível superior.

translate(...) — conveniência

Consulta até completed ou failed, ou até o tempo acabar.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # segundos entre consultas; padrão 5.0
    timeout=600.0,        # orçamento total em segundos; padrão 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,
)

Status da API: pending, processing, completed, failed.

Exceções

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)

Padrão de jobs async (resumo)

1. Manual: jobs.create → loop jobs.get até estado terminal.
2. Auxiliar: jobs.translate com poll_interval, timeout e opcional on_progress.

Prefira jobs para conteúdo muito grande onde translate síncrono pode atingir timeout do cliente ou servidor.

Tipos

O pacote inclui py.typed. Objetos de resposta são valores dict simples alinhados com a API; use anotações no estilo TypedDict no seu código se desejar.

Changelog

0.1.0

• Lançamento inicial: PolyLingo sync, AsyncPolyLingo async, cobertura completa dos endpoints incluindo helper de polling jobs.translate.