API Python — обзор
Справочник собирается автоматически из исходников пакета dagstack-config через pydoc-markdown.
:::info Генерация отложена
В первой версии страницы ещё не сгенерированы. Конфигурация pipeline — pydoc-markdown.yaml в корне; запуск — make api-python. Содержимое пополнится в следующих коммитах, после стабилизации реализации.
:::
Состав справочника (план)
| Модуль | Что содержит |
|---|---|
dagstack.config | Публичный верхний уровень — Config, load, load_from, load_paths, методы доступа (snake_case), ошибки. |
dagstack.config.sources | ConfigSource, YamlFileSource, JsonFileSource, InMemorySource. |
dagstack.config.errors | ConfigError, ConfigErrorReason. |
dagstack.config.subscription | Subscription (Phase 1 — inactive, callback не срабатывает). |
Как сгенерировать локально
pip install pydoc-markdown
pip install dagstack-config # в активное окружение
cd <repo-root>
make api-python
Пока справочник не сгенерирован
- Строки документации (docstrings) доступны через
help(dagstack.config)в интерпретаторе. - Страницы руководств: Объявить секцию, Тестирование.
- Спецификация: ADR-0001.