Python SDK (polylingo)

Cliente oficial de Python para la API REST de PolyLingo. Utiliza httpx y proporciona clientes tanto sincrónicos como asincrónicos con los mismos nombres de métodos.

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

Para detalles HTTP en bruto, vea API reference.

Instalación

pip install polylingo

Python: >= 3.9

Cliente sincrónico

import os
import polylingo

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

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

client.close()

Administrador de contexto:

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

Cliente asincrónico

import polylingo

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

Use await client.aclose() si no usa async with.

Los nombres de métodos coinciden con el cliente sincrónico; todos los métodos de red son async def.

Métodos (sincrónicos y asincrónicos)

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()

Trabajos — client.jobs

create / await create

POST /jobs — devuelve el cuerpo 202 (job_id, status, …).

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

get(job_id) / await get(job_id)

GET /jobs/:id. Cuando status == "completed", las respuestas incluyen translations y usage a nivel superior.

translate(...) — conveniencia

Consulta hasta que esté completed o failed, o hasta que se acabe el tiempo.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # segundos entre consultas; por defecto 5.0
    timeout=600.0,        # presupuesto **total** en segundos; por defecto 1200 (20 min)
    on_progress=lambda pos: print(f"Queue: {pos}"),
)
done["translations"]["de"]

Asíncrono:

done = await client.jobs.translate(
    content=long_md,
    targets=["de"],
    poll_interval=2.0,
    timeout=300.0,
)

Estados API: pending, processing, completed, failed.

Excepciones

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)

Patrón de trabajos asíncronos (resumen)

1. Manual: jobs.create → bucle jobs.get hasta estado terminal.
2. Ayudante: jobs.translate con poll_interval, timeout y opcional on_progress.

Prefiera trabajos para contenido muy grande donde translate sincrónico podría alcanzar tiempos de espera del cliente o servidor.

Tipos

El paquete incluye py.typed. Los objetos de respuesta son valores simples dict alineados con la API; use anotaciones estilo TypedDict en su código si lo desea.

Registro de cambios

0.1.0

• Lanzamiento inicial: PolyLingo sincrónico, AsyncPolyLingo asincrónico, cobertura completa de endpoints incluyendo el ayudante de polling jobs.translate.