Перейти к содержанию

Плагины и расширения odpm (4.4+)

odpm 4.4+ добавляет extension API на host: prepare steps, compose fragments и lifecycle hooks. Плагины не получают прямой доступ к mutable Config — только frozen ExtensionHostContext.

Версия API (4.5+)

Стабильная версия extension API: EXTENSION_API_VERSION = "1.0" (dev_project/extensions/api.py). Breaking changes в протоколах pluggy или manifest hooks требуют major bump API. Политика: ADR-004.

Три способа расширить проект

Механизм Где объявляется Когда выполняется
Manifest services odpm.json v2 → services Prepare compose.fragments + odpm plan → compose.fragment.<name>
Manifest hooks odpm.json v2 → hooks post_clone после git materialize; post_prepare после prepare; pre_up перед compose up
Python entry points pyproject.toml пакета Pluggy: odpm.prepare_steps, odpm.hooks
Project-local plugins .odpm/plugins/*.py или extensions.local Импорт при bootstrap (только внутри project_dir)

Подробнее о полях v2: odpm.json. ADR: adr-001-extensions-and-manifest-v2.md.

Декларативный сервис (Mailpit)

Тестовый SMTP с веб-интерфейсом на порту 8025. Добавьте в nested manifest v2:

{
  "manifest_schema": 2,
  "requires_odpm": "4.4.3",
  "services": {
    "mailpit": {
      "image": "axllent/mailpit",
      "restart": "unless-stopped",
      "ports": ["8025:8025", "1025:1025"]
    }
  }
}

Тот же spec в коде: dev_project.extensions.reference.mailpit.MAILPIT_SERVICE_SPEC.

После odpm up сервис появится в сгенерированном docker-compose.yml (блок {COMPOSE_SERVICE_FRAGMENTS}). Артефакты materialize: .odpm/compose/fragments/mailpit.yml (gitignored).

Lifecycle hooks в manifest

"hooks": {
  "post_prepare": [
    ["./scripts/notify.sh", "prepare-done"],
    "mycompany.odpm.hooks.warmup"
  ],
  "pre_up": [
    ["docker", "network", "create", "odpm-dev", "||", "true"]
  ]
}

Каждый элемент — либо argv (массив строк, выполняется в project_dir), либо plugin id (строка) для pluggy hook runner.

Порядок по ADR-004:

  1. Git materialize
  2. hooks.post_clone (если задан)
  3. Все prepare steps (built-in + odpm.prepare_steps + local plugins), сортировка по order
  4. hooks.post_prepare
  5. Runtime: debug profile, IDE, database drift
  6. hooks.pre_up
  7. docker compose up

odpm plan показывает шаги hooks.* и compose.fragment.<service> когда они настроены.

Поле order у prepare steps

Меньшее значение order выполняется раньше среди extension steps (built-in порядок фиксирован в registry). Конфликт id с built-in step → ValueError при регистрации.

Ошибка shell-hook → PipelineError с кодом выхода команды.

Python-плагин: compose fragment

# my_odpm_mailpit/__init__.py
from dev_project.extensions import ExtensionHostContext, register_compose_fragment
from dev_project.extensions.reference.mailpit import MAILPIT_SERVICE_SPEC

class MailpitFragment:
    name = "mailpit"

    def compose_services(self, ctx: ExtensionHostContext) -> dict:
        return {"mailpit": dict(MAILPIT_SERVICE_SPEC)}

def _register():
    register_compose_fragment("mailpit", MailpitFragment())

Регистрация при импорте пакета или через entry point (см. ниже).

Python-плагин: prepare step

[project.entry-points."odpm.prepare_steps"]
my_step = "my_odpm_plugin.steps:plugin_factory"

from dataclasses import dataclass
from dev_project.prepare.helpers import make_plan_step
from dev_project.prepare.types import PrepareContext

@dataclass(frozen=True)
class MyPrepareStep:
    id: str = "mycompany.custom.step"
    description: str = "Custom prepare work"
    order: int = 500

    def evaluate(self, ctx: PrepareContext):
        return make_plan_step(self.id, self.description, "run", True, "always run")

    def execute(self, ctx: PrepareContext) -> None:
        ...

def plugin_factory():
    return MyPrepareStep()

evaluate должен быть без side effects — odpm plan вызывает только evaluate.

Python-плагин: lifecycle hook runner

[project.entry-points."odpm.hooks"]
warmup = "my_odpm_plugin.hooks:WarmupRunner"

class WarmupRunner:
    name = "mycompany.odpm.hooks.warmup"

    def run_post_clone(self, ctx) -> None:
        ...

    def run_post_prepare(self, ctx) -> None:
        ...

    def run_pre_up(self, ctx) -> None:
        ...

Id в manifest ("mycompany.odpm.hooks.warmup") должен совпадать с name runner.

Пример pyproject.toml пакета

[project]
name = "odpm-services-mailpit"
version = "0.1.0"
dependencies = ["odpm>=4.4"]

[project.entry-points."odpm.hooks"]
# optional lifecycle runners

[project.entry-points."odpm.prepare_steps"]
# optional prepare steps

Установите пакет в venv host (pip install -e .) рядом с odpm.

Project-local plugins (4.5+)

Без отдельного pip-пакета можно положить модули в .odpm/plugins/ проекта (только этот каталог, без .. в именах). Опциональный allow-list в manifest v2:

"extensions": {
  "local": ["mailpit_local"]
}

Загружается project_dir/.odpm/plugins/mailpit_local.py. Пример fixture: tests/fixtures/sample_plugin/.

Cookbook (минимальный плагин)

  1. Manifest v2 services.mailpit или register_compose_fragment в Python.
  2. Prepare step с evaluate без side effects + execute для записи файлов.
  3. Hook runner с name, совпадающим с id в hooks.post_prepare.
  4. pip install -e . или .odpm/plugins/my_plugin.py.
  5. odpm plan — проверить шаги compose.fragment.*, hooks.*, extension prepare step.

Шаблон pyproject.toml: tests/fixtures/sample_plugin/pyproject.toml.

Ограничения

  • Container-side ContainerConfig остаётся stdlib-only (без новых PyPI deps в образе).
  • Compose YAML генерируется host-движком dev_project/yaml/ (ruamel.yaml); YAML anchors/merge aliases не поддерживаются.
  • Конфликт имён: plugin compose fragment перезаписывает одноимённый service из manifest.

См. также