mirror of
https://github.com/VectifyAI/PageIndex.git
synced 2026-07-24 21:41:04 +02:00
1170b10ee0
`import pageindex` eagerly pulled the whole indexing stack — litellm (which fetches a remote model cost map at import) and PyPDF2 — costing ~3.3s plus a network attempt for cloud-only 0.2.x users who never touch local indexing. Legacy pre-SDK names now resolve via PEP 562 __getattr__; a TYPE_CHECKING block keeps real signatures for IDEs. Import drops to ~0.3s with zero network and no litellm/PyPDF2 in sys.modules until a legacy indexing name is actually used.
112 lines
3.8 KiB
Python
112 lines
3.8 KiB
Python
# pageindex/__init__.py
|
|
# Load .env first so env-based credentials (e.g. OPENAI_API_KEY) are set.
|
|
from dotenv import load_dotenv as _load_dotenv
|
|
_load_dotenv()
|
|
|
|
# Backward compatibility: honor CHATGPT_API_KEY as an alias for OPENAI_API_KEY.
|
|
import os as _os
|
|
_chatgpt_key = _os.getenv("CHATGPT_API_KEY")
|
|
if not _os.getenv("OPENAI_API_KEY") and _chatgpt_key:
|
|
_os.environ["OPENAI_API_KEY"] = _chatgpt_key
|
|
|
|
from typing import TYPE_CHECKING as _TYPE_CHECKING
|
|
if _TYPE_CHECKING:
|
|
# Static-only bindings for the lazily-loaded legacy names below, so type
|
|
# checkers and IDEs see real signatures without the runtime import cost.
|
|
from .index.page_index import page_index, page_index_main, tree_parser
|
|
from .index.page_index_md import md_to_tree
|
|
from .index.utils import ConfigLoader, llm_completion, llm_acompletion
|
|
from .retrieve import get_document, get_document_structure, get_page_content
|
|
|
|
# SDK exports — lightweight, no LLM/indexing libraries.
|
|
from .client import PageIndexClient, LocalClient, CloudClient
|
|
from .config import IndexConfig, set_llm_params
|
|
from .collection import Collection
|
|
from .types import DocumentInfo, DocumentDetail, PageContent
|
|
from .parser.protocol import ContentNode, ParsedDocument, DocumentParser
|
|
from .storage.protocol import StorageEngine
|
|
from .events import QueryEvent
|
|
from .errors import (
|
|
PageIndexError,
|
|
PageIndexAPIError,
|
|
CollectionNotFoundError,
|
|
DocumentNotFoundError,
|
|
IndexingError,
|
|
CloudAPIError,
|
|
FileTypeError,
|
|
)
|
|
|
|
__all__ = [
|
|
"PageIndexClient",
|
|
"LocalClient",
|
|
"CloudClient",
|
|
"IndexConfig",
|
|
"set_llm_params",
|
|
"Collection",
|
|
"DocumentInfo",
|
|
"DocumentDetail",
|
|
"PageContent",
|
|
"ContentNode",
|
|
"ParsedDocument",
|
|
"DocumentParser",
|
|
"StorageEngine",
|
|
"QueryEvent",
|
|
"PageIndexError",
|
|
"PageIndexAPIError",
|
|
"CollectionNotFoundError",
|
|
"DocumentNotFoundError",
|
|
"IndexingError",
|
|
"CloudAPIError",
|
|
"FileTypeError",
|
|
# Legacy top-level exports (pre-SDK API), kept so `from pageindex import *`
|
|
# still binds them.
|
|
"page_index",
|
|
"page_index_main",
|
|
"tree_parser",
|
|
"ConfigLoader",
|
|
"llm_completion",
|
|
"llm_acompletion",
|
|
"md_to_tree",
|
|
"get_document",
|
|
"get_document_structure",
|
|
"get_page_content",
|
|
]
|
|
|
|
# Legacy (pre-SDK) exports resolve lazily via PEP 562: importing the indexing
|
|
# stack costs seconds (litellm fetches a remote model cost map at import), so
|
|
# plain `import pageindex` for cloud-only use must not pay for it.
|
|
_LAZY_LEGACY = {
|
|
"md_to_tree": ".index.page_index_md",
|
|
"get_document": ".retrieve",
|
|
"get_document_structure": ".retrieve",
|
|
"get_page_content": ".retrieve",
|
|
}
|
|
|
|
|
|
def __getattr__(name):
|
|
if name.startswith("_"):
|
|
# Tooling probes dunders (pickle, IPython, …) — never let those
|
|
# trigger the heavy legacy import.
|
|
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
import importlib
|
|
if name in ("utils", "page_index_md"):
|
|
return importlib.import_module(f".{name}", __name__)
|
|
module = _LAZY_LEGACY.get(name)
|
|
if module is not None:
|
|
value = getattr(importlib.import_module(module, __name__), name)
|
|
globals()[name] = value
|
|
return value
|
|
# Everything else from the pre-SDK surface (page_index, page_index_main,
|
|
# tree_parser, ConfigLoader, llm_completion, …) lives in the canonical
|
|
# index.page_index namespace (which star-exports index.utils).
|
|
legacy = importlib.import_module(".index.page_index", __name__)
|
|
try:
|
|
value = getattr(legacy, name)
|
|
except AttributeError:
|
|
raise AttributeError(f"module {__name__!r} has no attribute {name!r}") from None
|
|
globals()[name] = value
|
|
return value
|
|
|
|
|
|
def __dir__():
|
|
return sorted(set(globals()) | set(__all__) | {"utils", "page_index_md"})
|