Поверхность: Runtime PythonСтабильность: Public StableЗрелость: StableИсходник

plugin_kit_ai_runtime

Сгенерировано через pydoc-markdown.

Официальные runtime-хелперы для Python-плагинов на plugin-kit-ai.

Эта страница собирает публичные типы, константы, функции и классы пакета plugin_kit_ai_runtime.

Оглавление

• plugin_kit_ai_runtime
  • JSONMap
  • ClaudeHandler
  • CodexHandler
  • CLAUDE_STABLE_HOOKS
  • CLAUDE_EXTENDED_HOOKS
  • allow
  • continue_
  • ClaudeApp
    • __init__
    • on
    • on_stop
    • on_pre_tool_use
    • on_user_prompt_submit
    • run
  • CodexApp
    • __init__
    • on_notify
    • run

plugin_kit_ai_runtime

Официальные runtime-хелперы для исполняемых Python-плагинов на plugin-kit-ai.

JSONMap

JSON-представление payload, которое используют Python runtime-хелперы.

ClaudeHandler

Сигнатура обработчика для Claude hooks, который возвращает JSON-объект или None.

CodexHandler

Сигнатура обработчика для Codex events, который возвращает код выхода или None.

CLAUDE_STABLE_HOOKS

Имена стабильных Claude hooks, поддерживаемых публичной Python runtime-линией.

CLAUDE_EXTENDED_HOOKS

Имена расширенных Claude hooks, доступных в beta Python runtime-линии.

allow

def allow() -> JSONMap

Возвращает пустой JSON-объект, который Claude ожидает для разрешающего ответа.

continue_

def continue_() -> int

Возвращает код выхода 0 для Codex-обработчиков, которым нужно обычное продолжение.

Объекты ClaudeApp

class ClaudeApp()

Минимальное Claude-приложение, которое маршрутизирует поддерживаемые имена hooks к обработчикам.

__init__

def __init__(allowed_hooks: Iterable[str], usage: str)

Создаёт Claude runtime-приложение.

Аргументы:

• allowed_hooks - Имена hooks, которые этот бинарник принимает через argv.
• usage - Строка помощи, которая печатается при некорректном вызове.

on

def on(hook_name: str) -> Callable[[ClaudeHandler], ClaudeHandler]

Возвращает декоратор, который регистрирует обработчик для hook_name.

on_stop

def on_stop(handler: ClaudeHandler) -> ClaudeHandler

Регистрирует обработчик для hook Stop.

on_pre_tool_use

def on_pre_tool_use(handler: ClaudeHandler) -> ClaudeHandler

Регистрирует обработчик для hook PreToolUse.

on_user_prompt_submit

def on_user_prompt_submit(handler: ClaudeHandler) -> ClaudeHandler

Регистрирует обработчик для hook UserPromptSubmit.

run

def run() -> int

Обрабатывает текущий запуск процесса и возвращает код выхода.

Объекты CodexApp

class CodexApp()

Минимальное Codex-приложение, которое маршрутизирует событие notify к обработчику.

__init__

def __init__()

Создаёт Codex runtime-приложение без зарегистрированного обработчика notify.

on_notify

def on_notify(handler: CodexHandler) -> CodexHandler

Регистрирует обработчик для события Codex notify.

run

def run() -> int

Обрабатывает текущий запуск процесса и возвращает код выхода.