Python SDK (polylingo)

Официальный Python-клиент для PolyLingo REST API. Использует httpx и предоставляет как синхронных, так и асинхронных клиентов с одинаковыми именами методов.

• PyPI: polylingo
• Исходники: UsePolyLingo/polylingo-python

Для подробностей по HTTP смотрите справочник API.

Установка

pip install polylingo

Python: >= 3.9

Синхронный клиент

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # необязательно; значение по умолчанию
    timeout=120.0,  # необязательно; секунд на запрос (по умолчанию 120)
)

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

client.close()

Контекстный менеджер:

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

Асинхронный клиент

import polylingo

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

Используйте await client.aclose(), если не используете async with.

Имена методов совпадают с синхронным клиентом; все сетевые методы — async def.

Методы (sync и 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",  # необязательно
    source="en",        # необязательно
    model="standard",   # необязательно: "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 — возвращает тело 202 (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs также принимаются: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Когда status == "completed", ответы содержат translations и usage на верхнем уровне.

translate(...) — удобство

Опрос до completed или failed, либо пока не истечёт время.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # секунд между опросами; по умолчанию 5.0
    timeout=600.0,        # общий лимит времени в секундах; по умолчанию 1200 (20 мин)
    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: pending, processing, completed, failed.

Исключения

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)

Паттерн асинхронных заданий (кратко)

1. Ручной: jobs.create → цикл jobs.get до терминального состояния.
2. Помощник: jobs.translate с poll_interval, timeout и опциональным on_progress.

Предпочитайте jobs для очень большого контента, где синхронный translate может вызвать таймаут клиента или сервера.

Типы

Пакет содержит py.typed. Объекты ответа — простые словари (dict), соответствующие API; используйте аннотации в стиле TypedDict в вашем коде при необходимости.

История изменений

0.1.0

• Первоначальный релиз: синхронный PolyLingo, асинхронный AsyncPolyLingo, полное покрытие эндпоинтов включая помощник опроса jobs.translate.