Skip to main content

A client library for accessing Pachca API

Project description

Pachca Python SDK

Python клиент для Pachca API.

Установка

pip install pachca-sdk==1.0.1

Использование

from pachca import PachcaClient, MessageCreateRequestMessage

client = PachcaClient("YOUR_TOKEN")

# Создание сообщения
msg = await client.messages.create_message(
    MessageCreateRequestMessage(entity_id=334, content="Hello!")
)

# Получение сообщения
fetched = await client.messages.get_message(msg.id)

# Реакция (≤2 полей — передаются как kwargs)
await client.reactions.add_reaction(msg.id, code="👀")

# Закрепление
await client.messages.pin_message(msg.id)

# Список сообщений чата (с пагинацией)
messages = await client.messages.list_chat_messages(chat_id=198)
print(messages.next_cursor)  # курсор следующей страницы

Конвенции

  • Вход: path-параметры и body-поля (если ≤2) разворачиваются в аргументы метода. Иначе — один объект-запрос.
  • Выход: если ответ API содержит единственное поле data, SDK возвращает его содержимое напрямую.
# ≤2 поля → развёрнуто в аргументы
await client.reactions.add_reaction(message_id, ReactionRequest(code="👍"))
await client.messages.pin_message(message_id)

# >2 полей → объект-запрос
await client.messages.create_message(MessageCreateRequest(...))

# Ответ: API возвращает {"data": ...}, SDK возвращает объект напрямую
message = await client.messages.create_message(...)  # Message, не {"data": Message}

Пагинация

Для эндпоинтов с курсорной пагинацией SDK генерирует *_all-методы, которые автоматически обходят все страницы:

# Вручную
chats = []
cursor = None
while True:
    response = await client.chats.list_chats(cursor=cursor)
    chats.extend(response.data)
    cursor = response.meta.paginate.next_page if response.meta and response.meta.paginate else None
    if not cursor:
        break

# Автоматически
all_chats = await client.chats.list_chats_all()

Доступные методы: list_chats_all, list_users_all, list_tasks_all, list_tags_all, list_members_all, list_chat_messages_all, list_reactions_all, search_chats_all, search_messages_all, search_users_all и др.

Повторные запросы

SDK автоматически повторяет запросы при получении ответа 429 Too Many Requests. Используется заголовок Retry-After для определения задержки, с экспоненциальным backoff (до 3 попыток).

Загрузка файлов

Загрузка файла — трёхшаговый процесс:

# 1. Получить параметры загрузки
params = await client.common.get_upload_params()

# 2. Загрузить файл на S3
with open("photo.png", "rb") as f:
    await client.common.upload_file(params, f, "photo.png")

# 3. Прикрепить к сообщению (используя key из params)

Обработка ошибок

from pachca import PachcaClient, ApiError, OAuthError

try:
    await client.messages.get_message(999999)
except OAuthError as e:
    print(f"Ошибка авторизации: {e.message}")
except ApiError as e:
    print(f"Ошибка API: {e.errors}")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pachca_sdk-1.0.10.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pachca_sdk-1.0.10-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file pachca_sdk-1.0.10.tar.gz.

File metadata

  • Download URL: pachca_sdk-1.0.10.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for pachca_sdk-1.0.10.tar.gz
Algorithm Hash digest
SHA256 49aa56a1789437e15710f094b4e04eaa2623ebf53caff2ff8ad5282d6f073815
MD5 72207c12aa023d6deaa164d67fc85537
BLAKE2b-256 4c7d3521d8cccace7e0e1850ee7feb5f085843ce5fcf90b0600b08423c738752

See more details on using hashes here.

File details

Details for the file pachca_sdk-1.0.10-py3-none-any.whl.

File metadata

  • Download URL: pachca_sdk-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for pachca_sdk-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 056d2003ec0510a7cf36c9126596a1e6d18b37346c1123cdaad70c5189e3834b
MD5 adcf12322473b991d1be828787414de7
BLAKE2b-256 6a9d1724d28cf8f02b122afc9cbd91e46e4efbedc69e2d68130cdb80bbc31889

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page