core: deprecate problematic dict() method

Author: cbornet

libs/core/langchain_core/language_models/chat_models.py

@@ -322,7 +322,7 @@ class BaseChatModel(BaseLanguageModel[BaseMessage], ABC):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def raise_deprecation(cls, values: typing.Dict) -> Any:  # noqa: UP006
         """Raise deprecation warning if ``callback_manager`` is used.
 
         Args:
@@ -349,7 +349,7 @@ def raise_deprecation(cls, values: dict) -> Any:
     )
 
     @cached_property
-    def _serialized(self) -> dict[str, Any]:
+    def _serialized(self) -> typing.Dict[str, Any]:  # noqa: UP006
         return dumpd(self)
 
     # --- Runnable methods ---
@@ -643,7 +643,10 @@ async def astream(
 
     # --- Custom methods ---
 
-    def _combine_llm_outputs(self, llm_outputs: list[Optional[dict]]) -> dict:  # noqa: ARG002
+    def _combine_llm_outputs(
+        self,
+        llm_outputs: list[Optional[typing.Dict]],  # noqa: ARG002, UP006
+    ) -> typing.Dict:  # noqa: UP006
         return {}
 
     def _convert_cached_generations(self, cache_val: list) -> list[ChatGeneration]:
@@ -689,8 +692,8 @@ def _get_invocation_params(
         self,
         stop: Optional[list[str]] = None,
         **kwargs: Any,
-    ) -> dict:
-        params = self.dict()
+    ) -> typing.Dict:  # noqa: UP006
+        params = self.asdict()
         params["stop"] = stop
         return {**params, **kwargs}
 
@@ -753,7 +756,7 @@ def generate(
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
+        metadata: Optional[typing.Dict[str, Any]] = None,  # noqa: UP006
         run_name: Optional[str] = None,
         run_id: Optional[uuid.UUID] = None,
         **kwargs: Any,
@@ -868,7 +871,7 @@ async def agenerate(
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
+        metadata: Optional[typing.Dict[str, Any]] = None,  # noqa: UP006
         run_name: Optional[str] = None,
         run_id: Optional[uuid.UUID] = None,
         **kwargs: Any,
@@ -1369,8 +1372,12 @@ async def apredict_messages(
     def _llm_type(self) -> str:
         """Return type of chat model."""
 
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
     @override
-    def dict(self, **kwargs: Any) -> dict:
+    def dict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
+        return self.asdict()
+
+    def asdict(self) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return a dictionary of the LLM."""
         starter_dict = dict(self._identifying_params)
         starter_dict["_type"] = self._llm_type

libs/core/langchain_core/language_models/llms.py

@@ -7,6 +7,7 @@
 import inspect
 import json
 import logging
+import typing
 import warnings
 from abc import ABC, abstractmethod
 from collections.abc import AsyncIterator, Iterator, Sequence
@@ -304,7 +305,7 @@ class BaseLLM(BaseLanguageModel[str], ABC):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def raise_deprecation(cls, values: typing.Dict[str, Any]) -> Any:  # noqa: UP006
         """Raise deprecation warning if callback_manager is used."""
         if values.get("callback_manager") is not None:
             warnings.warn(
@@ -316,7 +317,7 @@ def raise_deprecation(cls, values: dict) -> Any:
         return values
 
     @functools.cached_property
-    def _serialized(self) -> dict[str, Any]:
+    def _serialized(self) -> typing.Dict[str, Any]:  # noqa: UP006
         return dumpd(self)
 
     # --- Runnable methods ---
@@ -530,7 +531,7 @@ def stream(
         else:
             prompt = self._convert_input(input).to_string()
             config = ensure_config(config)
-            params = self.dict()
+            params = self.asdict()
             params["stop"] = stop
             params = {**params, **kwargs}
             options = {"stop": stop}
@@ -600,7 +601,7 @@ async def astream(
 
         prompt = self._convert_input(input).to_string()
         config = ensure_config(config)
-        params = self.dict()
+        params = self.asdict()
         params["stop"] = stop
         params = {**params, **kwargs}
         options = {"stop": stop}
@@ -819,7 +820,9 @@ def generate(
         callbacks: Optional[Union[Callbacks, list[Callbacks]]] = None,
         *,
         tags: Optional[Union[list[str], list[list[str]]]] = None,
-        metadata: Optional[Union[dict[str, Any], list[dict[str, Any]]]] = None,
+        metadata: Optional[
+            Union[typing.Dict[str, Any], list[typing.Dict[str, Any]]]  # noqa: UP006
+        ] = None,
         run_name: Optional[Union[str, list[str]]] = None,
         run_id: Optional[Union[uuid.UUID, list[Optional[uuid.UUID]]]] = None,
         **kwargs: Any,
@@ -941,7 +944,7 @@ def generate(
             ] * len(prompts)
             run_name_list = [cast("Optional[str]", run_name)] * len(prompts)
         run_ids_list = self._get_run_ids_list(run_id, prompts)
-        params = self.dict()
+        params = self.asdict()
         params["stop"] = stop
         options = {"stop": stop}
         (
@@ -1079,7 +1082,9 @@ async def agenerate(
         callbacks: Optional[Union[Callbacks, list[Callbacks]]] = None,
         *,
         tags: Optional[Union[list[str], list[list[str]]]] = None,
-        metadata: Optional[Union[dict[str, Any], list[dict[str, Any]]]] = None,
+        metadata: Optional[
+            Union[typing.Dict[str, Any], list[typing.Dict[str, Any]]]  # noqa: UP006
+        ] = None,
         run_name: Optional[Union[str, list[str]]] = None,
         run_id: Optional[Union[uuid.UUID, list[Optional[uuid.UUID]]]] = None,
         **kwargs: Any,
@@ -1191,7 +1196,7 @@ async def agenerate(
             ] * len(prompts)
             run_name_list = [cast("Optional[str]", run_name)] * len(prompts)
         run_ids_list = self._get_run_ids_list(run_id, prompts)
-        params = self.dict()
+        params = self.asdict()
         params["stop"] = stop
         options = {"stop": stop}
         (
@@ -1280,7 +1285,7 @@ def __call__(
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
+        metadata: Optional[typing.Dict[str, Any]] = None,  # noqa: UP006
         **kwargs: Any,
     ) -> str:
         """Check Cache and run the LLM on the given prompt and input.
@@ -1329,7 +1334,7 @@ async def _call_async(
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
-        metadata: Optional[dict[str, Any]] = None,
+        metadata: Optional[typing.Dict[str, Any]] = None,  # noqa: UP006
         **kwargs: Any,
     ) -> str:
         """Check Cache and run the LLM on the given prompt and input."""
@@ -1397,8 +1402,12 @@ def __str__(self) -> str:
     def _llm_type(self) -> str:
         """Return type of llm."""
 
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
     @override
-    def dict(self, **kwargs: Any) -> dict:
+    def dict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
+        return self.asdict()
+
+    def asdict(self) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return a dictionary of the LLM."""
         starter_dict = dict(self._identifying_params)
         starter_dict["_type"] = self._llm_type
@@ -1427,7 +1436,7 @@ def save(self, file_path: Union[Path, str]) -> None:
         directory_path.mkdir(parents=True, exist_ok=True)
 
         # Fetch dictionary to save
-        prompt_dict = self.dict()
+        prompt_dict = self.asdict()
 
         if save_path.suffix == ".json":
             with save_path.open("w") as f:

libs/core/langchain_core/output_parsers/base.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import contextlib
+import typing
 from abc import ABC, abstractmethod
 from typing import (
     TYPE_CHECKING,
@@ -16,6 +17,7 @@
 
 from typing_extensions import override
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import LanguageModelOutput
 from langchain_core.messages import AnyMessage, BaseMessage
 from langchain_core.outputs import ChatGeneration, Generation
@@ -361,7 +363,12 @@ def _type(self) -> str:
         )
         raise NotImplementedError(msg)
 
-    def dict(self, **kwargs: Any) -> dict:
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
+    @override
+    def dict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
+        return self.asdict()
+
+    def asdict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return dictionary representation of output parser."""
         output_parser_dict = super().model_dump(**kwargs)
         with contextlib.suppress(NotImplementedError):

libs/core/langchain_core/prompts/base.py

@@ -23,6 +23,7 @@
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 from typing_extensions import Self, override
 
+from langchain_core._api import deprecated
 from langchain_core.exceptions import ErrorCode, create_message
 from langchain_core.load import dumpd
 from langchain_core.output_parsers.base import BaseOutputParser
@@ -118,7 +119,7 @@ def is_lc_serializable(cls) -> bool:
     )
 
     @cached_property
-    def _serialized(self) -> dict[str, Any]:
+    def _serialized(self) -> typing.Dict[str, Any]:  # noqa: UP006
         return dumpd(self)
 
     @property
@@ -151,7 +152,7 @@ def get_input_schema(
             field_definitions={**required_input_variables, **optional_input_variables},
         )
 
-    def _validate_input(self, inner_input: Any) -> dict:
+    def _validate_input(self, inner_input: Any) -> typing.Dict:  # noqa: UP006
         if not isinstance(inner_input, dict):
             if len(self.input_variables) == 1:
                 var_name = self.input_variables[0]
@@ -185,19 +186,26 @@ def _validate_input(self, inner_input: Any) -> dict:
             )
         return inner_input
 
-    def _format_prompt_with_error_handling(self, inner_input: dict) -> PromptValue:
+    def _format_prompt_with_error_handling(
+        self,
+        inner_input: typing.Dict,  # noqa: UP006
+    ) -> PromptValue:
         inner_input_ = self._validate_input(inner_input)
         return self.format_prompt(**inner_input_)
 
     async def _aformat_prompt_with_error_handling(
-        self, inner_input: dict
+        self,
+        inner_input: typing.Dict,  # noqa: UP006
     ) -> PromptValue:
         inner_input_ = self._validate_input(inner_input)
         return await self.aformat_prompt(**inner_input_)
 
     @override
     def invoke(
-        self, input: dict, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: typing.Dict,  # noqa: UP006
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> PromptValue:
         """Invoke the prompt.
 
@@ -223,7 +231,10 @@ def invoke(
 
     @override
     async def ainvoke(
-        self, input: dict, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: typing.Dict,  # noqa: UP006
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> PromptValue:
         """Async invoke the prompt.
 
@@ -285,7 +296,7 @@ def partial(self, **kwargs: Union[str, Callable[[], str]]) -> BasePromptTemplate
         prompt_dict["partial_variables"] = {**self.partial_variables, **kwargs}
         return type(self)(**prompt_dict)
 
-    def _merge_partial_and_user_variables(self, **kwargs: Any) -> dict[str, Any]:
+    def _merge_partial_and_user_variables(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
         # Get partial params:
         partial_kwargs = {
             k: v if not callable(v) else v() for k, v in self.partial_variables.items()
@@ -333,14 +344,19 @@ def _prompt_type(self) -> str:
         """Return the prompt type key."""
         raise NotImplementedError
 
-    def dict(self, **kwargs: Any) -> dict:
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
+    @override
+    def dict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
+        return self.asdict(**kwargs)
+
+    def asdict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return dictionary representation of prompt.
 
         Args:
-            kwargs: Any additional arguments to pass to the dictionary.
+            **kwargs: Any additional arguments to pass to the dictionary.
 
         Returns:
-            Dict: Dictionary representation of the prompt.
+            Dictionary representation of the prompt.
 
         Raises:
             NotImplementedError: If the prompt type is not implemented.
@@ -372,7 +388,7 @@ def save(self, file_path: Union[Path, str]) -> None:
             raise ValueError(msg)
 
         # Fetch dictionary to save
-        prompt_dict = self.dict()
+        prompt_dict = self.asdict()
         if "_type" not in prompt_dict:
             msg = f"Prompt {self} does not support saving."
             raise NotImplementedError(msg)