diff --git a/.gitignore b/.gitignore index feb6cfb..3ac71cf 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ __pycache__/ *.egg-info/ .pytest_cache/ config.local.json +config.local.yml +config.local.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index 73d8028..8e9e0c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,24 @@ # Changelog -Все значимые изменения **tools/index** (индекс метаданных и модулей 1С) фиксируются в этом файле. +Все значимые изменения утилиты **index** (индекс метаданных и модулей 1С) фиксируются в этом файле. Формат: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Версионирование: [Semantic Versioning](https://semver.org/lang/ru/). +## [0.3.2] - 2026-07-17 + +### Added + +- `--config` в формате **YAML** (`.yml`/`.yaml`) с поддержкой комментариев; пример `config.example.yml`. +- Блок **`default_baseconfs`** в конфиге: `reindex` без `-b` индексирует только этот список; без блока — автосканирование `/src/`. +- **Автопоиск** локального конфига без `--config`: `config.local.yml` / `config.local.yaml` / `config.local.json`. + +### Changed + +- Документация и тексты `--help`: обобщённые примеры вместо локальных имён выгрузок и проектов. +- Алиасы `--baseconf` — через `baseconf_aliases` в YAML-конфиге (не в коде). +- Список конфигураций для `reindex` без `-b`: автообнаружение или `default_baseconfs` из конфига. + ## [0.3.1] - 2026-07-17 ### Changed @@ -15,7 +29,7 @@ ### Fixed -- `query_1c.py`: `-b` / `--baseconf` до подкоманды (`query_1c.py -b crm3-26 search …`) корректно применяется к запросу. +- `query_1c.py`: `-b` / `--baseconf` до подкоманды (`query_1c.py -b my-config search …`) корректно применяется к запросу. ## [0.3.0] - 2026-07-16 @@ -48,7 +62,7 @@ ### Changed -- Параметр конфигурации 1С: **`--baseconf` / `-b`** (алиасы `target`→`crm3-26`, `source`→`crm3-dev`). +- Параметр конфигурации 1С: **`--baseconf` / `-b`**; алиасы через `baseconf_aliases` в `--config`. - **`--config` / `-c`** — только файл настроек утилиты (JSON), не выгрузка 1С. - Информативные ошибки: нет индекса / нет папки `src/` / baseconf не проиндексирован / объект не найден (с подсказками). - Расширена документация `README.md` (примеры, режимы, применение в Cursor). @@ -67,6 +81,8 @@ - `query_1c.py`: `search`, `show`, `refs`, `modules`, `module`. - Инкремент по `mtime`+`size` файлов; индекс модулей `**/*.bsl`. -[0.3.0]: https://git.p7net.ru/1c/index/-/tags/v0.3.0 -[0.2.0]: https://git.p7net.ru/1c/index/-/tags/v0.2.0 -[0.1.0]: https://git.p7net.ru/1c/index/-/tags/v0.1.0 +[0.3.2]: v0.3.2 +[0.3.1]: v0.3.1 +[0.3.0]: v0.3.0 +[0.2.0]: v0.2.0 +[0.1.0]: v0.1.0 diff --git a/README.md b/README.md index 9b0c522..ddcd8e7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Индекс метаданных и модулей конфигураций 1С -**Версия:** см. [`VERSION`](VERSION) (текущая: **0.3.1**) · [CHANGELOG](CHANGELOG.md) +**Версия:** см. [`VERSION`](VERSION) (текущая: **0.3.2**) · [CHANGELOG](CHANGELOG.md) **Автор:** Michael BAG · [mk@p7net.ru](mailto:mk@p7net.ru) **Лицензия:** [GNU GPL v3](LICENSE) · [русский перевод (справочно)](LICENSE.ru) @@ -11,19 +11,16 @@ | [`index_1c.py`](index_1c.py) | построение и обновление индекса | | [`query_1c.py`](query_1c.py) | поиск и просмотр по готовому индексу | -Репозиторий утилиты: -Правило для Cursor (в корне CRM3-26): `.cursor/rules/1c-meta-index.mdc` - ```bash -python tools/index/index_1c.py --version -python tools/index/query_1c.py --version +python index_1c.py --version +python query_1c.py --version ``` --- ## Зачем это нужно -Обход десятков тысяч XML/BSL в `crm3-26/src` и соседних выгрузках через Grep в Cursor медленный. Индекс один раз разбирает метаданные и модули и даёт: +Обход десятков тысяч XML/BSL в `<выгрузка>/src` через Grep в IDE медленный. Индекс один раз разбирает метаданные и модули и даёт: | Задача | Команда | |--------|---------| @@ -32,9 +29,9 @@ python tools/index/query_1c.py --version | Кто ссылается на справочник/документ | `query_1c.py refs` | | Документ ↔ регистры движений | `query_1c.py movements` | | Найти процедуру/фрагмент в BSL | `query_1c.py modules` | -| Сравнить целевую и исходную конфигурацию | `-b target` / `-b source` | +| Сравнить несколько выгрузок в одном репозитории | `-b cfg1 -b cfg2` | -**Типичный workflow агента:** +**Типичный workflow:** `reindex` (после выгрузки) → `object` / `search` → `refs` / `modules` → открыть конкретный `.xml` / `.bsl`. --- @@ -43,22 +40,33 @@ python tools/index/query_1c.py --version | Параметр | Короткий | Назначение | |----------|----------|------------| -| `--config` | `-c` | Файл **настроек утилиты** (JSON). **Не** конфигурация 1С. См. [`config.example.json`](config.example.json). | -| `--root` | `-r` | Корень проекта CRM3-26 (если запуск не из дерева проекта). | +| `--config` | `-c` | Файл **настроек утилиты** (YAML). **Не** конфигурация 1С. См. [`config.example.yml`](config.example.yml). | +| `--root` | `-r` | Корень проекта с выгрузками 1С (если запуск не из дерева проекта). | | `--baseconf` | `-b` | Выгрузка конфигурации 1С: папка `/src/` в репозитории. Можно несколько раз. | | `--version` | | Версия утилиты. | -Приоритет корня проекта: `--root` > `project_root` в `--config` > авто из расположения `tools/index/`. +Приоритет корня проекта: `--root` > `project_root` в `--config` > авто (каталог с `index_1c.py` и `VERSION`). +Если `--config` не указан, утилита пытается автоматически найти +`config.local.yml`, `config.local.yaml` или `config.local.json`. ### Алиасы `--baseconf` -| Алиас | Папка | -|-------|-------| -| `target`, `crm3_26` | `crm3-26` | -| `source`, `crm3_old`, `crm3-old`, `crm3_dev` | `crm3-dev` | +Краткие имена задаются в файле `--config`, поле **`baseconf_aliases`**: -Другие выгрузки без алиаса: `crm3-26.rhana`, `crm3-dev.rhana`, `ws-rhana`, `bu-corp`, … -Полный список: `python tools/index/index_1c.py list` +```yaml +project_root: "/path/to/project" +baseconf_aliases: + main: "my-config" + ext: "my-config.ext" +``` + +После этого `-b main` эквивалентно `-b my-config`. + +Если в YAML задан блок `default_baseconfs`, то `reindex` без `-b` использует этот список. +Если блока нет — `reindex` без `-b` индексирует **все** каталоги с `src/` в корне проекта. +`query_1c.py` без `-b` ищет по **всем** конфигурациям в индексе. + +Список выгрузок: `python index_1c.py list` --- @@ -78,9 +86,9 @@ python tools/index/query_1c.py --version |-------|-----------| | `reindex -j 12` | инкремент: только файлы с изменившимися `mtime`/`size` | | `reindex --full -j 12` | удалить всю БД и собрать заново все известные выгрузки | -| `reindex --full -b crm3-26` | пересобрать только указанную конфигурацию | -| `reindex -b target -t Documents,Catalogs` | только выбранные типы объектов | -| `reindex -b ws-rhana --no-modules` | метаданные без BSL | +| `reindex --full -b my-config` | пересобрать только указанную конфигурацию | +| `reindex -b main -t Documents,Catalogs` | только выбранные типы объектов | +| `reindex -b my-config --no-modules` | метаданные без BSL | | `reindex --md` | дополнительно Markdown в `cache/1c_meta/md//` | `-j` / `--workers` — число потоков (по умолчанию 4–16). @@ -96,17 +104,17 @@ python tools/index/query_1c.py --version ### Примеры переиндексации ```bash -# после обновления выгрузки целевой конфигурации -python tools/index/index_1c.py reindex -b target -j 12 +# после обновления одной выгрузки +python index_1c.py reindex -b my-config -j 12 # полная пересборка всего проекта -python tools/index/index_1c.py reindex --full -j 12 +python index_1c.py reindex --full -j 12 -# только документы и справочники исходной + расширения -python tools/index/index_1c.py reindex -b source -b crm3-dev.rhana -t Documents,Catalogs -j 8 +# основная конфигурация + расширение, только документы и справочники +python index_1c.py reindex -b main -b ext -t Documents,Catalogs -j 8 -python tools/index/index_1c.py status -python tools/index/index_1c.py list +python index_1c.py status +python index_1c.py list ``` --- @@ -122,7 +130,7 @@ python tools/index/index_1c.py list | `search` | строка | объекты метаданных (FTS) | `-b`, `--type`, `--limit` | | `object` | имя/синоним объекта **или** реквизита | дерево структуры | `-b`, `--type`, `--clear`, `--limit` | | `show` | имя объекта | полная карточка JSON | `-b` | -| `refs` | `Catalog.Партнеры` / `ЗаказКлиента` | обратные ссылки полей | `-b`, `--limit` (на каждую baseconf) | +| `refs` | `Catalog.Customers` / `Contract` | обратные ссылки полей | `-b`, `--limit` (на каждую baseconf) | | `movements` | документ или регистр | регистратор ↔ регистры движений | `-b`, `--type`, `--limit` | | `modules` | строка | поиск по BSL | `-b`, `-n` / `--names-only`, `--limit` | | `module` | путь или owner | символы модуля, строки | `-b` | @@ -131,22 +139,22 @@ python tools/index/index_1c.py list ```bash # полная структура документа -python tools/index/query_1c.py object ЗаказКлиента -b target +python query_1c.py object Contract -b my-config -# только реквизиты с именем/синонимом «Партнер» в документах -python tools/index/query_1c.py object Партнер -b target --type Document --clear +# только реквизиты с именем/синонимом «Partner» в документах +python query_1c.py object Partner -b my-config --type Document --clear # совпал сам объект → --clear печатает только заголовок -python tools/index/query_1c.py object ЗаказКлиента -b target --clear +python query_1c.py object Contract -b my-config --clear ``` Формат строки реквизита: ```text -├── `Attribute.Партнер` — Клиент [обяз.] : CatalogRef.Партнеры -├── `Attribute.СуммаДокумента` — … [необяз.] : DefinedType.ДенежнаяСуммаЛюбогоЗнака -├── `TabularSection.Товары` — Товары -│ └── `Column.Номенклатура` — … [обяз.] : CatalogRef.Номенклатура +├── `Attribute.Partner` — Клиент [обяз.] : CatalogRef.Customers +├── `Attribute.Amount` — … [необяз.] : DefinedType.MoneyAmount +├── `TabularSection.Lines` — Строки +│ └── `Column.Item` — … [обяз.] : CatalogRef.Items ``` - **[обяз.]** — `FillChecking=ShowError`; **[необяз.]** — `DontCheck` @@ -156,24 +164,24 @@ python tools/index/query_1c.py object ЗаказКлиента -b target --clear ### `refs` — кто ссылается ```bash -python tools/index/query_1c.py refs "ЗаказКлиента" -python tools/index/query_1c.py refs Catalog.Партнеры -b target --limit 50 -python tools/index/query_1c.py refs Document.ЗаказКлиента -b source +python query_1c.py refs "Contract" +python query_1c.py refs Catalog.Customers -b my-config --limit 50 +python query_1c.py refs Document.Contract -b main ``` Без `-b` — все конфигурации в индексе; `--limit` действует **на каждую**. -Составной тип поля: `→ DocumentRef.ЗаказКлиента (среди прочего: DocumentRef.…)`. +Составной тип поля: `→ DocumentRef.Contract (среди прочего: DocumentRef.…)`. ### `movements` — регистратор ↔ регистры движений ```bash # документ → регистры, в которых он регистратор -python tools/index/query_1c.py movements ЗаказКлиента -b target -python tools/index/query_1c.py movements Document.РеализацияТоваровУслуг -b target +python query_1c.py movements Contract -b my-config +python query_1c.py movements Document.Sales -b my-config # регистр → документы-регистраторы -python tools/index/query_1c.py movements AccumulationRegister.ТоварыНаСкладах -b target -python tools/index/query_1c.py movements ТоварыНаСкладах -b target --type AccumulationRegister +python query_1c.py movements AccumulationRegister.Stock -b my-config +python query_1c.py movements Stock -b my-config --type AccumulationRegister ``` Данные из свойства метаданных `RegisterRecords` (таблица `register_records` в индексе). @@ -182,18 +190,18 @@ python tools/index/query_1c.py movements ТоварыНаСкладах -b targe ### `modules` / `module` ```bash -python tools/index/query_1c.py modules "ОбработатьHealth" -b ws-rhana -python tools/index/query_1c.py modules "РВС_Transfer" -b ws-rhana -n -python tools/index/query_1c.py module CommonModules/РВС_TransferAPIДокументы -b ws-rhana +python query_1c.py modules "ProcessData" -b my-config +python query_1c.py modules "MyModule" -b my-config.ext -n +python query_1c.py module CommonModules/MyModule -b my-config ``` ### Прочие примеры ```bash -python tools/index/query_1c.py search "ЗаказКлиента" -python tools/index/query_1c.py search "Партнер" --type Document -b crm3-26 -python tools/index/query_1c.py show Document.ЗаказКлиента -b target -python tools/index/query_1c.py search "Партнер" -b source -b crm3-dev.rhana +python query_1c.py search "Contract" +python query_1c.py search "Partner" --type Document -b my-config +python query_1c.py show Document.Contract -b main +python query_1c.py search "Partner" -b main -b ext ``` ### Ошибки и подсказки @@ -201,7 +209,7 @@ python tools/index/query_1c.py search "Партнер" -b source -b crm3-dev.rha | Ситуация | Поведение | |----------|-----------| | Нет `index.sqlite` | подсказка `index_1c.py reindex --full` | -| `-b` без папки `src/` | список доступных выгрузок + алиасы | +| `-b` без папки `src/` | список доступных выгрузок | | `-b` есть в репо, нет в индексе | список проиндексированных + команда `reindex -b …` | | `show` / `object` не нашли | похожие имена из индекса | @@ -210,29 +218,29 @@ python tools/index/query_1c.py search "Партнер" -b source -b crm3-dev.rha ## Файл настроек утилиты (`--config`) ```bash -cp tools/index/config.example.json tools/index/config.local.json -# project_root: "/path/to/crm3-26" -python tools/index/query_1c.py --config tools/index/config.local.json search "Заказ" +cp config.example.yml config.local.yml +# project_root: "/path/to/project" +python query_1c.py --config config.local.yml search "Contract" ``` -`config.local.json` в `.gitignore` (локальные пути). +`config.local.yml` в `.gitignore` (локальные пути и алиасы). +Legacy-вариант `config.local.json` тоже поддерживается и подхватывается авто-поиском. --- -## Применение в Cursor +## Применение в Cursor / IDE -1. После выгрузки из EDT/конфигуратора: `python tools/index/index_1c.py reindex -j 12` (или `-b target`). +1. После выгрузки из EDT/конфигуратора: `python index_1c.py reindex -j 12` (или `-b my-config`). 2. Метаданные и связи — через `query_1c.py`, не Grep по всему `src/`. -3. Разделять контекст: `-b target` vs `-b source`. +3. При нескольких выгрузках — ограничивать `-b` нужной baseconf. 4. Код: `modules` → открыть `rel_path`; структура документа: `object`. -5. Правило агента: `.cursor/rules/1c-meta-index.mdc`. --- ## Артефакты кэша ```text -cache/1c_meta/ # в корне проекта CRM3-26 (gitignore) +cache/1c_meta/ # в корне проекта (обычно в .gitignore) index.sqlite # единая БД INDEX.md manifest.json @@ -251,8 +259,6 @@ Per-config `search.sqlite` устарели и не используются. | **E-mail** | [mk@p7net.ru](mailto:mk@p7net.ru) | | **Предложения, вопросы, ошибки** | пишите на **mk@p7net.ru** | -Репозиторий: - --- ## Лицензирование diff --git a/VERSION b/VERSION index 9e11b32..d15723f 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.3.1 +0.3.2 diff --git a/config.example.json b/config.example.json deleted file mode 100644 index 1b7f9b9..0000000 --- a/config.example.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "project_root": "/path/to/crm3-26", - "comment": "Файл настроек утилиты tools/index (НЕ конфигурация 1С). Копируйте в config.local.json и укажите --config config.local.json" -} diff --git a/config.example.yml b/config.example.yml new file mode 100644 index 0000000..7e5f9f5 --- /dev/null +++ b/config.example.yml @@ -0,0 +1,24 @@ +# Пример локальной конфигурации tools/index. +# Скопируйте в config.local.yml и передавайте: +# python index_1c.py --config config.local.yml reindex +# python query_1c.py --config config.local.yml search "..." +# +# ВАЖНО: +# - Это файл настроек утилиты, НЕ конфигурация 1С. +# - Файл обычно не коммитят (локальные пути/алиасы). + +# Корень проекта, в котором лежат выгрузки (/src/). +project_root: "/path/to/project" + +# Короткие алиасы для --baseconf. +# Пример: -b main эквивалентно -b my-config +baseconf_aliases: + main: "my-config" + ext: "my-config.ext" + +# Необязательный whitelist baseconf для reindex без -b. +# Если блок задан, то reindex (без -b) возьмет ТОЛЬКО эти конфигурации. +# Если блока нет — работает автосканирование всех /src/ в project_root. +default_baseconfs: + - main + - ext diff --git a/index1c/__init__.py b/index1c/__init__.py index e9521d9..07fabe6 100644 --- a/index1c/__init__.py +++ b/index1c/__init__.py @@ -2,7 +2,7 @@ from pathlib import Path -__version__ = "0.3.1" +__version__ = "0.3.2" __status__ = "in development" __author__ = "Michael BAG" __email__ = "mk@p7net.ru" diff --git a/index1c/cli.py b/index1c/cli.py index 2f38dd5..eb77fa4 100644 --- a/index1c/cli.py +++ b/index1c/cli.py @@ -3,7 +3,6 @@ from __future__ import annotations import argparse -import json import sys from pathlib import Path from typing import Any @@ -21,25 +20,89 @@ class BaseconfError(Exception): def load_tool_config(path: Path) -> dict[str, Any]: - """Файл настроек утилиты index (JSON). Не путать с конфигурацией 1С.""" + """Файл настроек утилиты index (YAML; legacy JSON поддерживается).""" + ext = path.suffix.lower() try: - data = json.loads(path.read_text(encoding="utf-8")) + raw = path.read_text(encoding="utf-8") except OSError as e: raise BaseconfError(f"Не удалось прочитать --config {path}: {e}", exit_code=1) from e - except json.JSONDecodeError as e: - raise BaseconfError(f"Некорректный JSON в --config {path}: {e}", exit_code=1) from e + + if ext == ".json": + try: + import json + + data = json.loads(raw) + except Exception as e: + raise BaseconfError(f"Некорректный JSON в --config {path}: {e}", exit_code=1) from e + if not isinstance(data, dict): + raise BaseconfError(f"--config {path}: ожидается JSON-объект", exit_code=1) + return data + + try: + import yaml # type: ignore + except Exception as e: + raise BaseconfError( + "Для чтения --config в формате YAML нужен пакет pyyaml: pip install pyyaml", + exit_code=1, + ) from e + try: + data = yaml.safe_load(raw) + except Exception as e: + raise BaseconfError(f"Некорректный YAML в --config {path}: {e}", exit_code=1) from e if not isinstance(data, dict): - raise BaseconfError(f"--config {path}: ожидается JSON-объект", exit_code=1) + raise BaseconfError(f"--config {path}: ожидается YAML-объект", exit_code=1) return data +def discover_local_tool_config() -> Path | None: + """Автопоиск локального конфига без --config.""" + candidates = ("config.local.yml", "config.local.yaml", "config.local.json") + roots = [Path.cwd(), project_root_from_here()] + seen: set[Path] = set() + for root in roots: + for rel in (Path("tools/index"), Path(".")): + base = (root / rel).resolve() + if base in seen or not base.is_dir(): + continue + seen.add(base) + for name in candidates: + p = base / name + if p.is_file(): + return p + return None + + +def apply_tool_config(data: dict[str, Any]) -> None: + """Применить настройки из YAML (--config): алиасы и дефолтные baseconf.""" + from .config import set_config_aliases, set_default_baseconfs + + aliases = data.get("baseconf_aliases") + if aliases is not None: + if not isinstance(aliases, dict): + raise BaseconfError("--config: baseconf_aliases должен быть объектом YAML") + set_config_aliases({str(k): str(v) for k, v in aliases.items()}) + default_baseconfs = data.get("default_baseconfs") + if default_baseconfs is not None: + if not isinstance(default_baseconfs, list): + raise BaseconfError("--config: default_baseconfs должен быть YAML-списком") + set_default_baseconfs([str(x) for x in default_baseconfs]) + else: + set_default_baseconfs([]) + + def resolve_project_root(args: argparse.Namespace) -> Path: - """Корень проекта: --root → project_root из --config → авто.""" + """Корень проекта: --root → --config/auto-config → авто.""" if getattr(args, "root", None): return Path(args.root).resolve() cfg_path = getattr(args, "config", None) + if not cfg_path: + auto = discover_local_tool_config() + if auto is not None: + cfg_path = str(auto) + setattr(args, "config", cfg_path) if cfg_path: data = load_tool_config(Path(cfg_path)) + apply_tool_config(data) pr = data.get("project_root") if pr: return Path(pr).resolve() @@ -52,13 +115,16 @@ def add_tool_args(parser: argparse.ArgumentParser) -> None: "--config", "-c", metavar="FILE", - help="JSON с настройками утилиты (project_root и др.), см. config.example.json", + help=( + "YAML с настройками утилиты (project_root и др.), см. config.example.yml. " + "Без параметра: автопоиск config.local.yml/.yaml/.json" + ), ) parser.add_argument( "--root", "-r", metavar="DIR", - help="Корень проекта CRM3-26 (перекрывает project_root из --config)", + help="Корень проекта с выгрузками 1С (перекрывает project_root из --config)", ) @@ -69,7 +135,10 @@ def add_baseconf_args( ) -> None: """Фильтр по выгрузке конфигурации 1С в репозитории.""" if mode == "index": - default_hint = "Без параметра — индексировать все выгрузки с src/ в репозитории." + default_hint = ( + "Без параметра — default_baseconfs из --config; " + "если блок не задан, индексировать все выгрузки с src/." + ) else: default_hint = "Без параметра — поиск по всем проиндексированным." parser.add_argument( @@ -80,8 +149,8 @@ def add_baseconf_args( dest="baseconf", help=( "Конфигурация 1С в репозитории (папка /src/). " - "Можно несколько раз или через запятую: -b target,source. " - "Алиасы: target→crm3-26, source→crm3-dev. " + "Можно несколько раз или через запятую: -b cfg1,cfg2. " + "Краткие имена (алиасы) — в baseconf_aliases файла --config. " f"{default_hint}" ), ) @@ -192,7 +261,7 @@ def validate_baseconfs( lines.extend( [ "", - "Алиасы: target→crm3-26, source→crm3-dev, crm3_old→crm3-dev", + "Краткие имена (алиасы) для -b задаются в baseconf_aliases файла --config.", ] ) raise BaseconfError("\n".join(lines)) @@ -216,7 +285,7 @@ def validate_baseconfs( lines.extend( [ "", - f"Переиндексация: python tools/index/index_1c.py reindex --full -b {not_indexed[0]}", + f"Переиндексация: python index_1c.py reindex --full -b {not_indexed[0]}", ] ) raise BaseconfError("\n".join(lines)) @@ -297,7 +366,7 @@ def index_db_missing_message(project_root: Path) -> str: return ( f"Индекс не найден: {path}\n" "Сначала выполните:\n" - " python tools/index/index_1c.py reindex --full -j 12\n" + " python index_1c.py reindex --full -j 12\n" "или для одной конфигурации:\n" - " python tools/index/index_1c.py reindex --full -b crm3-26" + " python index_1c.py reindex --full -b <имя-выгрузки>" ) diff --git a/index1c/config.py b/index1c/config.py index 7dd20ce..be23c8b 100644 --- a/index1c/config.py +++ b/index1c/config.py @@ -5,28 +5,10 @@ from __future__ import annotations from dataclasses import dataclass from pathlib import Path -# Папки выгрузок относительно корня проекта (есть src/). -DEFAULT_CONFIGS: tuple[str, ...] = ( - "crm3-26", - "crm3-26.rhana", - "crm3-dev", - "crm3-dev.rhana", - "crm3-dev.docs", - "ws-rhana", - "bu-corp", - "bu-corp.rhana", - "diadoc.ext.rhana", -) - -# Алиасы имён конфигураций 1С для CLI (--baseconf / -b). -CONFIG_ALIASES: dict[str, str] = { - "crm3_26": "crm3-26", - "crm3_old": "crm3-dev", - "crm3-old": "crm3-dev", - "crm3_dev": "crm3-dev", - "target": "crm3-26", - "source": "crm3-dev", -} +# Алиасы имён конфигураций 1С для CLI (--baseconf / -b), задаются через --config +# (поле baseconf_aliases в YAML). См. config.example.yml. +_RUNTIME_ALIASES: dict[str, str] = {} +_RUNTIME_DEFAULT_BASECONFS: list[str] = [] # Папка EDT → канонический тип (английский идентификатор выгрузки). OBJECT_TYPE_FOLDERS: dict[str, str] = { @@ -192,13 +174,52 @@ class ConfigPaths: def project_root_from_here() -> Path: - """tools/index/index1c → корень проекта.""" - return Path(__file__).resolve().parents[3] + """Корень проекта: каталог с index_1c.py и VERSION.""" + here = Path(__file__).resolve().parent + for candidate in (here.parent, here.parent.parent, here.parent.parent.parent): + if (candidate / "index_1c.py").is_file() and (candidate / "VERSION").is_file(): + return candidate + return here.parent + + +def set_config_aliases(aliases: dict[str, str] | None) -> None: + """Задать алиасы baseconf из файла --config (baseconf_aliases).""" + global _RUNTIME_ALIASES + _RUNTIME_ALIASES = {str(k): str(v) for k, v in (aliases or {}).items()} + + +def get_config_aliases() -> dict[str, str]: + return dict(_RUNTIME_ALIASES) + + +def set_default_baseconfs(names: list[str] | None) -> None: + """Задать default_baseconfs из файла --config (YAML).""" + global _RUNTIME_DEFAULT_BASECONFS + _RUNTIME_DEFAULT_BASECONFS = [str(x) for x in (names or []) if str(x).strip()] + + +def get_default_baseconfs() -> list[str]: + """Список baseconf по умолчанию для reindex без -b.""" + return list(_RUNTIME_DEFAULT_BASECONFS) def resolve_config_name(name: str) -> str: key = name.strip() - return CONFIG_ALIASES.get(key, CONFIG_ALIASES.get(key.lower(), key)) + aliases = get_config_aliases() + return aliases.get(key, aliases.get(key.lower(), key)) + + +def list_config_dirs(project_root: Path) -> list[str]: + """Все каталоги с выгрузкой 1С (/src/) в корне проекта.""" + if not project_root.is_dir(): + return [] + found: list[str] = [] + for child in sorted(project_root.iterdir()): + if not child.is_dir() or child.name.startswith("."): + continue + if (child / "src").is_dir(): + found.append(child.name) + return found def resolve_object_type(name: str) -> str: @@ -217,7 +238,7 @@ def resolve_object_type(name: str) -> str: def discover_configs(project_root: Path, names: list[str] | None = None) -> list[ConfigPaths]: - wanted = [resolve_config_name(n) for n in names] if names else list(DEFAULT_CONFIGS) + wanted = [resolve_config_name(n) for n in names] if names else list_config_dirs(project_root) found: list[ConfigPaths] = [] for name in wanted: root = project_root / name diff --git a/index1c/db.py b/index1c/db.py index 09168a6..6b782ac 100644 --- a/index1c/db.py +++ b/index1c/db.py @@ -245,7 +245,7 @@ def init_db(conn: sqlite3.Connection) -> None: if ver > SCHEMA_VERSION: raise RuntimeError( f"Индекс новее утилиты (схема {ver}, утилита {SCHEMA_VERSION}). " - "Обновите tools/index." + "Обновите утилиту index до более новой версии." ) if ver < SCHEMA_VERSION: migrate_schema(conn, ver) diff --git a/index1c/search.py b/index1c/search.py index 4e479a1..784df6a 100644 --- a/index1c/search.py +++ b/index1c/search.py @@ -23,7 +23,7 @@ def open_index(project_root: Path, *, readonly: bool = True) -> sqlite3.Connecti path = dbmod.global_db_path(cache_dir(project_root)) if not path.is_file(): raise FileNotFoundError( - f"Индекс не найден: {path}. Запустите: python tools/index/index_1c.py reindex --full" + f"Индекс не найден: {path}. Запустите: python index_1c.py reindex --full" ) # мягкая миграция схемы (например 2→3: таблица register_records) probe = dbmod.connect(path, readonly=True) @@ -403,7 +403,7 @@ def find_refs_to( Возвращает (строки, totals_by_config). При поиске по нескольким конфигурациям ``limit`` — максимум **на каждую** - конфигурацию (чтобы crm3-26 не вытеснял crm3-dev из-за ORDER BY + LIMIT). + конфигурацию (чтобы одна baseconf не вытесняла другую из-за ORDER BY + LIMIT). """ kind = "" name = target diff --git a/index1c/writers.py b/index1c/writers.py index 90d5b25..2539b0d 100644 --- a/index1c/writers.py +++ b/index1c/writers.py @@ -272,8 +272,8 @@ def write_global_index_md(cache_root: Path, summary: dict[str, Any]) -> Path: f"Режим: `{summary.get('mode', '?')}`, БД: `cache/1c_meta/index.sqlite`.", f"Потоки: {summary.get('workers', '?')}, время: {summary.get('elapsed_sec', '?')} с.", "", - "Поиск: `python tools/index/query_1c.py search \"…\"`", - "Переиндексация: `python tools/index/index_1c.py reindex` (инкремент) / `--full`.", + "Поиск: `python query_1c.py search \"…\"`", + "Переиндексация: `python index_1c.py reindex` (инкремент) / `--full`.", "", "## Конфигурации", "", diff --git a/index_1c.py b/index_1c.py index 60659bb..5c4d73d 100755 --- a/index_1c.py +++ b/index_1c.py @@ -2,19 +2,19 @@ """Переиндексация метаданных и модулей конфигураций 1С → cache/1c_meta/index.sqlite. Параметры: - --config, -c файл настроек утилиты (JSON) - --baseconf, -b какие выгрузки 1С индексировать (crm3-26, target, …) + --config, -c файл настроек утилиты (YAML) + --baseconf, -b какие выгрузки 1С индексировать (имя каталога с src/) Примеры: - python tools/index/index_1c.py reindex -j 12 - python tools/index/index_1c.py reindex --full -j 12 - python tools/index/index_1c.py reindex --full -b crm3-26 -j 12 - python tools/index/index_1c.py reindex -b target -b ws-rhana -t Documents,Catalogs - python tools/index/index_1c.py status - python tools/index/index_1c.py list + python index_1c.py reindex -j 12 + python index_1c.py reindex --full -j 12 + python index_1c.py reindex --full -b my-config -j 12 + python index_1c.py reindex -b main -b my-config.ext -t Documents,Catalogs + python index_1c.py status + python index_1c.py list -Поиск: python tools/index/query_1c.py … +Поиск: python query_1c.py … """ from __future__ import annotations @@ -39,10 +39,11 @@ from index1c.cli import ( # noqa: E402 validate_baseconfs, ) from index1c.config import ( # noqa: E402 - CONFIG_ALIASES, DEFAULT_SKIP_TYPES, cache_dir, discover_configs, + get_default_baseconfs, + get_config_aliases, resolve_object_type, ) from index1c import db as dbmod # noqa: E402 @@ -70,7 +71,17 @@ def _select_configs_for_reindex(args: argparse.Namespace, root: Path) -> list: sys.exit(e.exit_code) return discover_configs(root, names) - # без -b: все известные с src/ + # без -b: default_baseconfs из --config или автосканирование. + defaults = get_default_baseconfs() + if defaults: + try: + names = validate_baseconfs(root, defaults, require_indexed=False) + except BaseconfError as e: + print(str(e), file=sys.stderr) + sys.exit(e.exit_code) + return discover_configs(root, names) + + # fallback: все каталоги с src/ в корне проекта return discover_configs(root, None) @@ -80,7 +91,7 @@ def cmd_reindex(args: argparse.Namespace) -> int: if not configs: print( "Нет конфигураций для индексации (нужна папка /src/).\n" - "Укажите -b crm3-26 или проверьте: python tools/index/index_1c.py list", + "Укажите -b <имя-выгрузки> или проверьте: python index_1c.py list", file=sys.stderr, ) return 1 @@ -150,7 +161,7 @@ def cmd_list_configs(args: argparse.Namespace) -> int: found = discover_configs(root, None) print("Выгрузки 1С в репозитории (для --baseconf / -b):") for c in found: - aliases = [k for k, v in CONFIG_ALIASES.items() if v == c.name] + aliases = [k for k, v in get_config_aliases().items() if v == c.name] alias_s = f" алиасы: {', '.join(aliases)}" if aliases else "" print(f"- {c.name}{alias_s}") db_path = dbmod.global_db_path(cache_dir(root)) @@ -176,7 +187,7 @@ def build_parser() -> argparse.ArgumentParser: formatter_class=argparse.RawDescriptionHelpFormatter, epilog=( "Конфигурация 1С: --baseconf (-b). Файл настроек утилиты: --config (-c).\n" - "Алиасы baseconf: target→crm3-26, source→crm3-dev" + "Алиасы/default для baseconf — в YAML (--config), см. config.example.yml" ), ) p.add_argument( diff --git a/query_1c.py b/query_1c.py index d975b95..0b199cd 100755 --- a/query_1c.py +++ b/query_1c.py @@ -2,22 +2,19 @@ """Запросы к единому индексу конфигураций 1С (cache/1c_meta/index.sqlite). Параметры: - --config, -c файл настроек утилиты (JSON), не конфигурация 1С - --baseconf, -b выгрузка конфигурации 1С в репозитории (crm3-26, target, …) + --config, -c файл настроек утилиты (YAML), не конфигурация 1С + --baseconf, -b выгрузка конфигурации 1С в репозитории (имя каталога с src/) Примеры: - python tools/index/query_1c.py search \"ЗаказКлиента\" - python tools/index/query_1c.py search \"Партнер\" --type Document -b crm3-26 - python tools/index/query_1c.py show ЗаказКлиента -b target - python tools/index/query_1c.py show Document.ЗаказКлиента -b crm3-26 - python tools/index/query_1c.py modules \"РВС_Transfer\" -b ws-rhana - python tools/index/query_1c.py refs Catalog.Партнеры -b source - python tools/index/query_1c.py movements ЗаказКлиента -b target - python tools/index/query_1c.py movements AccumulationRegister.ТоварыНаСкладах -b target - python tools/index/query_1c.py object ЗаказКлиента -b target - python tools/index/query_1c.py object Партнер -b crm3-26 --clear - python tools/index/query_1c.py module CommonModules/РВС_TransferAPIДокументы + python query_1c.py search \"Contract\" + python query_1c.py search \"Partner\" --type Document -b my-config + python query_1c.py show Document.Contract -b main + python query_1c.py modules \"ProcessData\" -b my-config.ext + python query_1c.py refs Catalog.Customers -b main + python query_1c.py movements Document.Contract -b my-config + python query_1c.py object Contract -b my-config --clear + python query_1c.py module CommonModules/MyModule """ from __future__ import annotations @@ -360,7 +357,7 @@ def build_parser() -> argparse.ArgumentParser: epilog=( "Конфигурация 1С — параметр --baseconf (-b): папка выгрузки в репозитории.\n" "Можно указать до или после подкоманды; несколько раз или через запятую.\n" - "Файл настроек утилиты — --config (-c): см. tools/index/config.example.json" + "Файл настроек утилиты — --config (-c): см. config.example.yml" ), ) p.add_argument(