langchain 0.3.26__py3-none-any.whl → 0.4.0.dev0__py3-none-any.whl

langchain/callbacks/streaming_aiter.py

@@ -6,6 +6,8 @@ from typing import Any, Literal, Union, cast
 
 from langchain_core.callbacks import AsyncCallbackHandler
 from langchain_core.outputs import LLMResult
+from langchain_core.v1.messages import AIMessage
+from typing_extensions import override
 
 # TODO If used by two LLM runs in parallel this won't work as expected
 
@@ -19,31 +21,43 @@ class AsyncIteratorCallbackHandler(AsyncCallbackHandler):
 
     @property
     def always_verbose(self) -> bool:
+        """Always verbose."""
         return True
 
     def __init__(self) -> None:
+        """Instantiate AsyncIteratorCallbackHandler."""
         self.queue = asyncio.Queue()
         self.done = asyncio.Event()
 
+    @override
     async def on_llm_start(
-        self, serialized: dict[str, Any], prompts: list[str], **kwargs: Any
+        self,
+        serialized: dict[str, Any],
+        prompts: list[str],
+        **kwargs: Any,
     ) -> None:
         # If two calls are made in a row, this resets the state
         self.done.clear()
 
+    @override
     async def on_llm_new_token(self, token: str, **kwargs: Any) -> None:
         if token is not None and token != "":
             self.queue.put_nowait(token)
 
-    async def on_llm_end(self, response: LLMResult, **kwargs: Any) -> None:
+    @override
+    async def on_llm_end(
+        self, response: Union[LLMResult, AIMessage], **kwargs: Any
+    ) -> None:
         self.done.set()
 
+    @override
     async def on_llm_error(self, error: BaseException, **kwargs: Any) -> None:
         self.done.set()
 
     # TODO implement the other methods
 
     async def aiter(self) -> AsyncIterator[str]:
+        """Asynchronous iterator that yields tokens."""
         while not self.queue.empty() or not self.done.is_set():
             # Wait for the next token in the queue,
             # but stop waiting if the done event is set
@@ -62,7 +76,7 @@ class AsyncIteratorCallbackHandler(AsyncCallbackHandler):
                 other.pop().cancel()
 
             # Extract the value of the first completed task
-            token_or_done = cast(Union[str, Literal[True]], done.pop().result())
+            token_or_done = cast("Union[str, Literal[True]]", done.pop().result())
 
             # If the extracted value is the boolean True, the done event was set
             if token_or_done is True:

langchain/callbacks/streaming_aiter_final_only.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from langchain_core.outputs import LLMResult
+from langchain_core.v1.messages import AIMessage
+from typing_extensions import override
 
 from langchain.callbacks.streaming_aiter import AsyncIteratorCallbackHandler
 
@@ -15,6 +17,7 @@ class AsyncFinalIteratorCallbackHandler(AsyncIteratorCallbackHandler):
     """
 
     def append_to_last_tokens(self, token: str) -> None:
+        """Append token to the last tokens."""
         self.last_tokens.append(token)
         self.last_tokens_stripped.append(token.strip())
         if len(self.last_tokens) > len(self.answer_prefix_tokens):
@@ -22,10 +25,10 @@ class AsyncFinalIteratorCallbackHandler(AsyncIteratorCallbackHandler):
             self.last_tokens_stripped.pop(0)
 
     def check_if_answer_reached(self) -> bool:
+        """Check if the answer has been reached."""
         if self.strip_tokens:
             return self.last_tokens_stripped == self.answer_prefix_tokens_stripped
-        else:
-            return self.last_tokens == self.answer_prefix_tokens
+        return self.last_tokens == self.answer_prefix_tokens
 
     def __init__(
         self,
@@ -61,17 +64,25 @@ class AsyncFinalIteratorCallbackHandler(AsyncIteratorCallbackHandler):
         self.stream_prefix = stream_prefix
         self.answer_reached = False
 
+    @override
     async def on_llm_start(
-        self, serialized: dict[str, Any], prompts: list[str], **kwargs: Any
+        self,
+        serialized: dict[str, Any],
+        prompts: list[str],
+        **kwargs: Any,
     ) -> None:
         # If two calls are made in a row, this resets the state
         self.done.clear()
         self.answer_reached = False
 
-    async def on_llm_end(self, response: LLMResult, **kwargs: Any) -> None:
+    @override
+    async def on_llm_end(
+        self, response: Union[LLMResult, AIMessage], **kwargs: Any
+    ) -> None:
         if self.answer_reached:
             self.done.set()
 
+    @override
     async def on_llm_new_token(self, token: str, **kwargs: Any) -> None:
         # Remember the last n tokens, where n = len(answer_prefix_tokens)
         self.append_to_last_tokens(token)

langchain/callbacks/streaming_stdout_final_only.py

@@ -4,6 +4,7 @@ import sys
 from typing import Any, Optional
 
 from langchain_core.callbacks import StreamingStdOutCallbackHandler
+from typing_extensions import override
 
 DEFAULT_ANSWER_PREFIX_TOKENS = ["Final", "Answer", ":"]
 
@@ -16,6 +17,7 @@ class FinalStreamingStdOutCallbackHandler(StreamingStdOutCallbackHandler):
     """
 
     def append_to_last_tokens(self, token: str) -> None:
+        """Append token to the last tokens."""
         self.last_tokens.append(token)
         self.last_tokens_stripped.append(token.strip())
         if len(self.last_tokens) > len(self.answer_prefix_tokens):
@@ -23,10 +25,10 @@ class FinalStreamingStdOutCallbackHandler(StreamingStdOutCallbackHandler):
             self.last_tokens_stripped.pop(0)
 
     def check_if_answer_reached(self) -> bool:
+        """Check if the answer has been reached."""
         if self.strip_tokens:
             return self.last_tokens_stripped == self.answer_prefix_tokens_stripped
-        else:
-            return self.last_tokens == self.answer_prefix_tokens
+        return self.last_tokens == self.answer_prefix_tokens
 
     def __init__(
         self,
@@ -62,12 +64,17 @@ class FinalStreamingStdOutCallbackHandler(StreamingStdOutCallbackHandler):
         self.stream_prefix = stream_prefix
         self.answer_reached = False
 
+    @override
     def on_llm_start(
-        self, serialized: dict[str, Any], prompts: list[str], **kwargs: Any
+        self,
+        serialized: dict[str, Any],
+        prompts: list[str],
+        **kwargs: Any,
     ) -> None:
         """Run when LLM starts running."""
         self.answer_reached = False
 
+    @override
     def on_llm_new_token(self, token: str, **kwargs: Any) -> None:
         """Run on new LLM token. Only available when streaming is enabled."""
 

langchain/callbacks/streamlit/__init__.py

@@ -70,11 +70,12 @@ def StreamlitCallbackHandler(
             from langchain_community.callbacks.streamlit.streamlit_callback_handler import (  # noqa: E501
                 StreamlitCallbackHandler as _InternalStreamlitCallbackHandler,
             )
-        except ImportError:
-            raise ImportError(
+        except ImportError as e:
+            msg = (
                 "To use the StreamlitCallbackHandler, please install "
                 "langchain-community with `pip install langchain-community`."
             )
+            raise ImportError(msg) from e
 
         return _InternalStreamlitCallbackHandler(
             parent_container,

langchain/callbacks/streamlit/mutable_expander.py

@@ -27,7 +27,7 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "ChildType",
     "ChildRecord",
+    "ChildType",
     "MutableExpander",
 ]

langchain/callbacks/streamlit/streamlit_callback_handler.py

@@ -41,9 +41,9 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "LLMThoughtState",
-    "ToolRecord",
-    "LLMThoughtLabeler",
     "LLMThought",
+    "LLMThoughtLabeler",
+    "LLMThoughtState",
     "StreamlitCallbackHandler",
+    "ToolRecord",
 ]

langchain/callbacks/tracers/__init__.py

@@ -31,8 +31,8 @@ def __getattr__(name: str) -> Any:
 __all__ = [
     "ConsoleCallbackHandler",
     "FunctionCallbackHandler",
-    "LoggingCallbackHandler",
     "LangChainTracer",
     "LangChainTracerV1",
+    "LoggingCallbackHandler",
     "WandbTracer",
 ]

langchain/callbacks/tracers/comet.py

@@ -25,6 +25,6 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "import_comet_llm_api",
     "CometTracer",
+    "import_comet_llm_api",
 ]

langchain/callbacks/tracers/evaluation.py

@@ -5,4 +5,4 @@ from langchain_core.tracers.evaluation import (
     wait_for_all_evaluators,
 )
 
-__all__ = ["wait_for_all_evaluators", "EvaluatorCallbackHandler"]
+__all__ = ["EvaluatorCallbackHandler", "wait_for_all_evaluators"]

langchain/callbacks/tracers/log_stream.py

@@ -6,4 +6,4 @@ from langchain_core.tracers.log_stream import (
     RunState,
 )
 
-__all__ = ["LogEntry", "RunState", "RunLog", "RunLogPatch", "LogStreamCallbackHandler"]
+__all__ = ["LogEntry", "LogStreamCallbackHandler", "RunLog", "RunLogPatch", "RunState"]

langchain/callbacks/tracers/logging.py

@@ -7,6 +7,7 @@ from uuid import UUID
 from langchain_core.exceptions import TracerException
 from langchain_core.tracers.stdout import FunctionCallbackHandler
 from langchain_core.utils.input import get_bolded_text, get_colored_text
+from typing_extensions import override
 
 
 class LoggingCallbackHandler(FunctionCallbackHandler):
@@ -21,6 +22,15 @@ class LoggingCallbackHandler(FunctionCallbackHandler):
         extra: Optional[dict] = None,
         **kwargs: Any,
     ) -> None:
+        """
+        Initialize the LoggingCallbackHandler.
+
+        Args:
+            logger: the logger to use for logging
+            log_level: the logging level (default: logging.INFO)
+            extra: the extra context to log (default: None)
+            **kwargs:
+        """
         log_method = getattr(logger, logging.getLevelName(level=log_level).lower())
 
         def callback(text: str) -> None:
@@ -28,6 +38,7 @@ class LoggingCallbackHandler(FunctionCallbackHandler):
 
         super().__init__(function=callback, **kwargs)
 
+    @override
     def on_text(
         self,
         text: str,
@@ -42,5 +53,5 @@ class LoggingCallbackHandler(FunctionCallbackHandler):
             crumbs_str = ""
         self.function_callback(
             f"{get_colored_text('[text]', color='blue')}"
-            f" {get_bolded_text(f'{crumbs_str}New text:')}\n{text}"
+            f" {get_bolded_text(f'{crumbs_str}New text:')}\n{text}",
         )

langchain/callbacks/tracers/stdout.py

@@ -3,4 +3,4 @@ from langchain_core.tracers.stdout import (
     FunctionCallbackHandler,
 )
 
-__all__ = ["FunctionCallbackHandler", "ConsoleCallbackHandler"]
+__all__ = ["ConsoleCallbackHandler", "FunctionCallbackHandler"]

langchain/callbacks/trubrics_callback.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
 # Used to consolidate logic for raising deprecation warnings and
 # handling optional imports.
 DEPRECATED_LOOKUP = {
-    "TrubricsCallbackHandler": "langchain_community.callbacks.trubrics_callback"
+    "TrubricsCallbackHandler": "langchain_community.callbacks.trubrics_callback",
 }
 
 _import_attribute = create_importer(__file__, deprecated_lookups=DEPRECATED_LOOKUP)

langchain/callbacks/utils.py

@@ -37,12 +37,12 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "import_spacy",
-    "import_pandas",
-    "import_textstat",
+    "BaseMetadataCallbackHandler",
     "_flatten_dict",
     "flatten_dict",
     "hash_string",
+    "import_pandas",
+    "import_spacy",
+    "import_textstat",
     "load_json",
-    "BaseMetadataCallbackHandler",
 ]

langchain/callbacks/wandb_callback.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
 # Used to consolidate logic for raising deprecation warnings and
 # handling optional imports.
 DEPRECATED_LOOKUP = {
-    "WandbCallbackHandler": "langchain_community.callbacks.wandb_callback"
+    "WandbCallbackHandler": "langchain_community.callbacks.wandb_callback",
 }
 
 _import_attribute = create_importer(__file__, deprecated_lookups=DEPRECATED_LOOKUP)

langchain/callbacks/whylabs_callback.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
 # Used to consolidate logic for raising deprecation warnings and
 # handling optional imports.
 DEPRECATED_LOOKUP = {
-    "WhyLabsCallbackHandler": "langchain_community.callbacks.whylabs_callback"
+    "WhyLabsCallbackHandler": "langchain_community.callbacks.whylabs_callback",
 }
 
 _import_attribute = create_importer(__file__, deprecated_lookups=DEPRECATED_LOOKUP)

langchain/chains/api/base.py

@@ -47,8 +47,8 @@ def _check_in_allowed_domain(url: str, limit_to_domains: Sequence[str]) -> bool:
     scheme, domain = _extract_scheme_and_domain(url)
 
     for allowed_domain in limit_to_domains:
-        allowed_scheme, allowed_domain = _extract_scheme_and_domain(allowed_domain)
-        if scheme == allowed_scheme and domain == allowed_domain:
+        allowed_scheme, allowed_domain_ = _extract_scheme_and_domain(allowed_domain)
+        if scheme == allowed_scheme and domain == allowed_domain_:
             return True
     return False
 
@@ -61,7 +61,7 @@ try:
         message=(
             "This class is deprecated and will be removed in langchain 1.0. "
             "See API reference for replacement: "
-            "https://api.python.langchain.com/en/latest/chains/langchain.chains.api.base.APIChain.html"  # noqa: E501
+            "https://api.python.langchain.com/en/latest/chains/langchain.chains.api.base.APIChain.html"
         ),
         removal="1.0",
     )
@@ -191,6 +191,7 @@ try:
             )
             async for event in events:
                 event["messages"][-1].pretty_print()
+
         """  # noqa: E501
 
         api_request_chain: LLMChain
@@ -201,10 +202,10 @@ try:
         output_key: str = "output"  #: :meta private:
         limit_to_domains: Optional[Sequence[str]] = Field(default_factory=list)  # type: ignore[arg-type]
         """Use to limit the domains that can be accessed by the API chain.
-        
+
         * For example, to limit to just the domain `https://www.example.com`, set
             `limit_to_domains=["https://www.example.com"]`.
-            
+
         * The default value is an empty tuple, which means that no domains are
           allowed by default. By design this will raise an error on instantiation.
         * Use a None if you want to allow all domains by default -- this is not
@@ -235,9 +236,8 @@ try:
             input_vars = self.api_request_chain.prompt.input_variables
             expected_vars = {"question", "api_docs"}
             if set(input_vars) != expected_vars:
-                raise ValueError(
-                    f"Input variables should be {expected_vars}, got {input_vars}"
-                )
+                msg = f"Input variables should be {expected_vars}, got {input_vars}"
+                raise ValueError(msg)
             return self
 
         @model_validator(mode="before")
@@ -247,18 +247,20 @@ try:
             # This check must be a pre=True check, so that a default of None
             # won't be set to limit_to_domains if it's not provided.
             if "limit_to_domains" not in values:
-                raise ValueError(
+                msg = (
                     "You must specify a list of domains to limit access using "
                     "`limit_to_domains`"
                 )
+                raise ValueError(msg)
             if (
                 not values["limit_to_domains"]
                 and values["limit_to_domains"] is not None
             ):
-                raise ValueError(
+                msg = (
                     "Please provide a list of domains to limit access using "
                     "`limit_to_domains`."
                 )
+                raise ValueError(msg)
             return values
 
         @model_validator(mode="after")
@@ -267,9 +269,8 @@ try:
             input_vars = self.api_answer_chain.prompt.input_variables
             expected_vars = {"question", "api_docs", "api_url", "api_response"}
             if set(input_vars) != expected_vars:
-                raise ValueError(
-                    f"Input variables should be {expected_vars}, got {input_vars}"
-                )
+                msg = f"Input variables should be {expected_vars}, got {input_vars}"
+                raise ValueError(msg)
             return self
 
         def _call(
@@ -287,14 +288,19 @@ try:
             _run_manager.on_text(api_url, color="green", end="\n", verbose=self.verbose)
             api_url = api_url.strip()
             if self.limit_to_domains and not _check_in_allowed_domain(
-                api_url, self.limit_to_domains
+                api_url,
+                self.limit_to_domains,
             ):
-                raise ValueError(
+                msg = (
                     f"{api_url} is not in the allowed domains: {self.limit_to_domains}"
                 )
+                raise ValueError(msg)
             api_response = self.requests_wrapper.get(api_url)
             _run_manager.on_text(
-                str(api_response), color="yellow", end="\n", verbose=self.verbose
+                str(api_response),
+                color="yellow",
+                end="\n",
+                verbose=self.verbose,
             )
             answer = self.api_answer_chain.predict(
                 question=question,
@@ -320,18 +326,26 @@ try:
                 callbacks=_run_manager.get_child(),
             )
             await _run_manager.on_text(
-                api_url, color="green", end="\n", verbose=self.verbose
+                api_url,
+                color="green",
+                end="\n",
+                verbose=self.verbose,
             )
             api_url = api_url.strip()
             if self.limit_to_domains and not _check_in_allowed_domain(
-                api_url, self.limit_to_domains
+                api_url,
+                self.limit_to_domains,
             ):
-                raise ValueError(
+                msg = (
                     f"{api_url} is not in the allowed domains: {self.limit_to_domains}"
                 )
+                raise ValueError(msg)
             api_response = await self.requests_wrapper.aget(api_url)
             await _run_manager.on_text(
-                str(api_response), color="yellow", end="\n", verbose=self.verbose
+                str(api_response),
+                color="yellow",
+                end="\n",
+                verbose=self.verbose,
             )
             answer = await self.api_answer_chain.apredict(
                 question=question,
@@ -350,7 +364,7 @@ try:
             headers: Optional[dict] = None,
             api_url_prompt: BasePromptTemplate = API_URL_PROMPT,
             api_response_prompt: BasePromptTemplate = API_RESPONSE_PROMPT,
-            limit_to_domains: Optional[Sequence[str]] = tuple(),
+            limit_to_domains: Optional[Sequence[str]] = (),
             **kwargs: Any,
         ) -> APIChain:
             """Load chain from just an LLM and the api docs."""
@@ -373,8 +387,12 @@ try:
 except ImportError:
 
     class APIChain:  # type: ignore[no-redef]
-        def __init__(self, *args: Any, **kwargs: Any) -> None:
-            raise ImportError(
+        """Raise an ImportError if APIChain is used without langchain_community."""
+
+        def __init__(self, *_: Any, **__: Any) -> None:
+            """Raise an ImportError if APIChain is used without langchain_community."""
+            msg = (
                 "To use the APIChain, you must install the langchain_community package."
                 "pip install langchain_community"
             )
+            raise ImportError(msg)

langchain/chains/api/news_docs.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 NEWS_DOCS = """API documentation:
 Endpoint: https://newsapi.org
 Top headlines /v2/top-headlines
@@ -29,4 +28,4 @@ Response object
     content | string | The unformatted content of the article, where available. This is truncated to 200 chars.
 
 Use page size: 2
-"""
+"""  # noqa: E501

langchain/chains/api/open_meteo_docs.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 OPEN_METEO_DOCS = """BASE URL: https://api.open-meteo.com/
 
 API Documentation
@@ -30,4 +29,4 @@ showers	Preceding hour sum	mm (inch)	Showers from convective precipitation in mi
 weathercode	Instant	WMO code	Weather condition as a numeric code. Follow WMO weather interpretation codes. See table below for details.
 snow_depth	Instant	meters	Snow depth on the ground
 freezinglevel_height	Instant	meters	Altitude above sea level of the 0°C level
-visibility	Instant	meters	Viewing distance in meters. Influenced by low clouds, humidity and aerosols. Maximum visibility is approximately 24 km."""
+visibility	Instant	meters	Viewing distance in meters. Influenced by low clouds, humidity and aerosols. Maximum visibility is approximately 24 km."""  # noqa: E501

langchain/chains/api/openapi/requests_chain.py

@@ -26,4 +26,4 @@ def __getattr__(name: str) -> Any:
     return _import_attribute(name)
 
 
-__all__ = ["APIRequesterChain", "APIRequesterOutputParser", "REQUEST_TEMPLATE"]
+__all__ = ["REQUEST_TEMPLATE", "APIRequesterChain", "APIRequesterOutputParser"]

langchain/chains/api/openapi/response_chain.py

@@ -26,4 +26,4 @@ def __getattr__(name: str) -> Any:
     return _import_attribute(name)
 
 
-__all__ = ["APIResponderChain", "APIResponderOutputParser", "RESPONSE_TEMPLATE"]
+__all__ = ["RESPONSE_TEMPLATE", "APIResponderChain", "APIResponderOutputParser"]

langchain/chains/api/podcast_docs.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 PODCAST_DOCS = """API documentation:
 Endpoint: https://listen-api.listennotes.com/api/v2
 GET /search
@@ -25,4 +24,4 @@ id | integer | optional
 title_highlighted | string | optional
 
 Use page_size: 3
-"""
+"""  # noqa: E501

langchain/chains/api/prompt.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 from langchain_core.prompts.prompt import PromptTemplate
 
 API_URL_PROMPT_TEMPLATE = """You are given the below API Documentation:
@@ -7,7 +6,7 @@ Using this documentation, generate the full API url to call for answering the us
 You should build the API url in order to get a response that is as short as possible, while still getting the necessary information to answer the question. Pay attention to deliberately exclude any unnecessary pieces of data in the API call.
 
 Question:{question}
-API url:"""
+API url:"""  # noqa: E501
 
 API_URL_PROMPT = PromptTemplate(
     input_variables=[

langchain/chains/api/tmdb_docs.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 TMDB_DOCS = """API documentation:
 Endpoint: https://api.themoviedb.org/3
 GET /search/movie
@@ -34,4 +33,4 @@ backdrop_path | string or null | optional
 popularity | number | optional
 vote_count | integer | optional
 video | boolean | optional
-vote_average | number | optional"""
+vote_average | number | optional"""  # noqa: E501