mirror of
https://github.com/hwchase17/langchain.git
synced 2026-07-01 14:47:02 +00:00
948f6cc58c
Following on the heels of #35293 TODO: - Packages outside of this repo (e.g. LiteLLM, Nvidia, Google, AWS) --- ## Summary Surface partner package versions in `metadata.versions` on LangSmith traces. Mirrors the JS SDK's `_addVersion()` pattern ([langchainjs#10106](https://github.com/langchain-ai/langchainjs/pull/10106)). Each model constructor records its package version via `_add_version()` on `BaseLanguageModel`. The version dict accumulates through the class hierarchy — `langchain-core` is added in `BaseLanguageModel.model_post_init`, `langchain-openai` in `BaseChatOpenAI._set_openai_chat_version`, and each leaf partner in its uniquely-named `model_validator`. Traces end up with: ```json { "metadata": { "versions": { "langchain-core": "1.4.5", "langchain-openai": "1.3.0", "langchain-xai": "1.2.2" } } } ``` ### Changes - `BaseLanguageModel._add_version(pkg, version)` — appends to `self.metadata["versions"]`; accepts any `Mapping` type; emits a warning if a non-mapping value is found and replaced - `BaseLanguageModel.model_post_init` — adds `langchain-core` version; calls `super()` for MRO safety - `_merge_metadata_dicts` — one-level-deep (non-recursive) merge for nested dict metadata keys - `CallbackManager.add_metadata` — uses `_merge_metadata_dicts` instead of flat `dict.update()` so nested metadata dicts (like `versions`) coexist rather than clobber - `merge_configs` — uses `_merge_metadata_dicts` for config merging **Partners:** - Each now calls `self._add_version("langchain-<pkg>", __version__)` ### Design decisions - **Constructor-based, not `_get_ls_params`-based** — versions flow through `self.metadata` (local metadata on traces), not through `LangSmithParams`. This matches JS and makes child-class version inheritance automatic (no merge/clobber issues). - **`versions` is local (non-inheritable) metadata** — `self.metadata` is passed to `CallbackManager.configure` as `local_metadata` (`add_metadata(..., inherit=False)`), so `versions` is attached **once per chat-model run** and is **not** propagated to child runs or duplicated onto every streaming chunk. This is intentionally the opposite of the inheritable-per-chunk metadata that #36588 was reducing for performance — `versions` does not regress that path. - **`add_metadata` deep-merge is a correctness fix, not just for versions** — previously `add_metadata`/`merge_configs` did a flat top-level `dict.update`/spread, so any nested metadata dict baked into a config (e.g. via `.with_config({"metadata": {...}})`) would be wholly replaced when a caller also passed `metadata`. `_merge_metadata_dicts` merges one level deep so user-provided `config.metadata.versions` and model-set `versions` coexist instead of clobbering. The merge runs once per `configure` (not per chunk), so it is off the streaming hot path. - **One level deep only** — `_merge_metadata_dicts` is deliberately *not* a recursive deep merge; values nested more than one level are last-writer-wins. This covers the `versions` case without the ambiguity/cost of arbitrary-depth merging. - **Warn on non-dict `metadata["versions"]`** — if a user sets `metadata={"versions": "some-string"}`, `_add_version` emits a warning and replaces the value with the version dict rather than silently discarding user data or crashing. This is a soft breaking change for anyone who previously stored non-dict values at this key. ### Follow-ups (tracked separately, out of scope here) - JS `mergeConfigs` still flat-spreads nested metadata, so `metadata.versions` can still clobber on the JS side until an equivalent deep-merge lands. --- Made by [Open SWE](https://openswe.vercel.app) --------- Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>
66 lines
2.2 KiB
Python
66 lines
2.2 KiB
Python
"""Check version consistency between `pyproject.toml` and `_version.py`.
|
|
|
|
This script validates that the version defined in pyproject.toml matches the
|
|
`__version__` variable in `langchain_perplexity/_version.py`. Intended for use as a
|
|
CI check to prevent version mismatches.
|
|
"""
|
|
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
|
|
def get_pyproject_version(pyproject_path: Path) -> str | None:
|
|
"""Extract version from `pyproject.toml`."""
|
|
content = pyproject_path.read_text(encoding="utf-8")
|
|
match = re.search(r'^version\s*=\s*"([^"]+)"', content, re.MULTILINE)
|
|
return match.group(1) if match else None
|
|
|
|
|
|
def get_version_py_version(version_path: Path) -> str | None:
|
|
"""Extract `__version__` from `_version.py`."""
|
|
content = version_path.read_text(encoding="utf-8")
|
|
match = re.search(r'^__version__\s*=\s*"([^"]+)"', content, re.MULTILINE)
|
|
return match.group(1) if match else None
|
|
|
|
|
|
def main() -> int:
|
|
"""Validate version consistency."""
|
|
script_dir = Path(__file__).parent
|
|
package_dir = script_dir.parent
|
|
|
|
pyproject_path = package_dir / "pyproject.toml"
|
|
version_path = package_dir / "langchain_perplexity" / "_version.py"
|
|
|
|
if not pyproject_path.exists():
|
|
print(f"Error: {pyproject_path} not found") # noqa: T201
|
|
return 1
|
|
|
|
if not version_path.exists():
|
|
print(f"Error: {version_path} not found") # noqa: T201
|
|
return 1
|
|
|
|
pyproject_version = get_pyproject_version(pyproject_path)
|
|
version_py_version = get_version_py_version(version_path)
|
|
|
|
if pyproject_version is None:
|
|
print("Error: Could not find version in pyproject.toml") # noqa: T201
|
|
return 1
|
|
|
|
if version_py_version is None:
|
|
print("Error: Could not find __version__ in langchain_perplexity/_version.py") # noqa: T201
|
|
return 1
|
|
|
|
if pyproject_version != version_py_version:
|
|
print("Error: Version mismatch detected!") # noqa: T201
|
|
print(f" pyproject.toml: {pyproject_version}") # noqa: T201
|
|
print(f" langchain_perplexity/_version.py: {version_py_version}") # noqa: T201
|
|
return 1
|
|
|
|
print(f"Version check passed: {pyproject_version}") # noqa: T201
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|