refactor(index): dedupe the copied indexing pipeline behind deprecation shims

The new SDK copied the legacy indexing pipeline into pageindex/index/
instead of moving it, leaving two divergent copies of page_index.py /
page_index_md.py / utils.py. They had already drifted (the legacy copy
still compared IndexConfig booleans against 'yes' — a separate fix),
and every pipeline change had to be applied twice.

Make pageindex/index/ the single source of truth (same pattern as the
LegacyCloudAPI shim for the 0.2.x cloud SDK):

- pageindex/index/utils.py absorbs the 27 legacy-only helpers/classes
  (get_page_tokens, convert_page_to_int, ConfigLoader, PDF text helpers,
  ...) so it's the sole utils module. Reconciled the diverged funcs:
  kept the modern versions, backported the #331 get_leaf_nodes .get()
  fix, and restored remove_fields' max_len parameter (superset).
- index/page_index*.py now import `from .utils import *`;
  index/legacy_utils.py (a re-export of the old top-level utils) deleted.
- Top-level page_index.py / page_index_md.py / utils.py become thin
  re-export shims that emit PendingDeprecationWarning. The md_to_tree
  shim coerces legacy 'yes'/'no' string flags to bool (the canonical
  version is boolean-typed).
- ConfigLoader no longer reads the deleted config.yaml; it builds
  defaults from IndexConfig (was an unconditional FileNotFoundError).
- __init__.py and retrieve.py import from pageindex.index.* directly so
  `import pageindex` does not trip the shims.

Adds tests/test_legacy_shims.py pinning the contract: clean top-level
import doesn't warn, legacy submodule imports warn, symbols still
resolve, shim and canonical share one implementation, the #331 fix and
ConfigLoader-without-yaml both hold, and the md_to_tree coercion works.

Claude-Session: https://claude.ai/code/session_01Kx5DgKbhK1N8autqXH8SmS
This commit is contained in:
mountain 2026-07-07 10:41:29 +08:00
parent 956147d864
commit 6c948a332b
11 changed files with 593 additions and 2288 deletions

View file

@ -0,0 +1,83 @@
"""The top-level pageindex.page_index / .page_index_md / .utils modules are
now deprecation shims over the canonical pageindex.index.* modules. These
tests pin the compatibility contract."""
import asyncio
import importlib
import warnings
import pytest
def test_plain_import_pageindex_does_not_warn():
# `import pageindex` must not route through the deprecation shims.
with warnings.catch_warnings():
warnings.simplefilter("error", PendingDeprecationWarning)
importlib.import_module("pageindex")
@pytest.mark.parametrize("mod", [
"pageindex.utils",
"pageindex.page_index",
"pageindex.page_index_md",
])
def test_legacy_submodule_import_warns(mod):
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
importlib.reload(importlib.import_module(mod))
assert any(issubclass(w.category, PendingDeprecationWarning) for w in caught)
def test_legacy_symbols_resolve_through_shims():
with warnings.catch_warnings():
warnings.simplefilter("ignore")
from pageindex.utils import ( # noqa: F401
get_page_tokens, ConfigLoader, convert_page_to_int,
get_leaf_nodes, remove_fields,
)
from pageindex.page_index import page_index, page_index_main # noqa: F401
from pageindex.page_index_md import md_to_tree # noqa: F401
def test_canonical_and_shim_share_one_implementation():
with warnings.catch_warnings():
warnings.simplefilter("ignore")
import pageindex.utils as shim
import pageindex.index.utils as canonical
# Same function object -> a single source of truth (no divergence possible).
assert shim.get_leaf_nodes is canonical.get_leaf_nodes
assert shim.get_page_tokens is canonical.get_page_tokens
def test_get_leaf_nodes_has_331_fix():
"""Canonical get_leaf_nodes must use .get('nodes'); clean_node deletes the
key on leaf nodes so [...]['nodes'] would KeyError (issue #330)."""
from pageindex.index.utils import get_leaf_nodes
# A leaf node with the 'nodes' key deleted (as clean_node leaves it).
leaves = get_leaf_nodes({"title": "Leaf", "start_index": 1, "end_index": 2})
assert leaves == [{"title": "Leaf", "start_index": 1, "end_index": 2}]
def test_configloader_no_longer_needs_config_yaml():
"""config.yaml was removed; ConfigLoader must build defaults from IndexConfig."""
from pageindex.index.utils import ConfigLoader
cfg = ConfigLoader().load({"model": "gpt-5.4"})
assert cfg.model == "gpt-5.4"
assert cfg.if_add_node_summary is True # IndexConfig default
with pytest.raises(ValueError, match="Unknown config keys"):
ConfigLoader().load({"nope": 1})
def test_md_to_tree_shim_coerces_yes_no_strings(monkeypatch):
"""Canonical md_to_tree takes booleans; the shim must coerce legacy
'yes'/'no' strings so a bare 'no' doesn't read as truthy True."""
import pageindex.page_index_md as shim
captured = {}
async def fake(*args, **kwargs):
captured.update(kwargs)
return {"ok": True}
monkeypatch.setattr(shim, "_md_to_tree", fake)
asyncio.run(shim.md_to_tree(md_path="x.md", if_add_node_summary="no", if_add_node_id="yes"))
assert captured["if_add_node_summary"] is False
assert captured["if_add_node_id"] is True