langchain-core 1.0.0a7__py3-none-any.whl → 1.0.0rc1__py3-none-any.whl

langchain_core/runnables/branch.py

@@ -149,7 +149,7 @@ class RunnableBranch(RunnableSerializable[Input, Output]):
         """Get the namespace of the langchain object.
 
         Returns:
-            ``["langchain", "schema", "runnable"]``
+            `["langchain", "schema", "runnable"]`
         """
         return ["langchain", "schema", "runnable"]
 
@@ -191,8 +191,8 @@ class RunnableBranch(RunnableSerializable[Input, Output]):
 
         Args:
             input: The input to the Runnable.
-            config: The configuration for the Runnable. Defaults to None.
-            kwargs: Additional keyword arguments to pass to the Runnable.
+            config: The configuration for the Runnable.
+            **kwargs: Additional keyword arguments to pass to the Runnable.
 
         Returns:
             The output of the branch that was run.
@@ -301,8 +301,8 @@ class RunnableBranch(RunnableSerializable[Input, Output]):
 
         Args:
             input: The input to the Runnable.
-            config: The configuration for the Runnable. Defaults to None.
-            kwargs: Additional keyword arguments to pass to the Runnable.
+            config: The configuration for the Runnable.
+            **kwargs: Additional keyword arguments to pass to the Runnable.
 
         Yields:
             The output of the branch that was run.
@@ -385,8 +385,8 @@ class RunnableBranch(RunnableSerializable[Input, Output]):
 
         Args:
             input: The input to the Runnable.
-            config: The configuration for the Runnable. Defaults to None.
-            kwargs: Additional keyword arguments to pass to the Runnable.
+            config: The configuration for the Runnable.
+            **kwargs: Additional keyword arguments to pass to the Runnable.
 
         Yields:
             The output of the branch that was run.

langchain_core/runnables/config.py

@@ -131,7 +131,7 @@ def _set_config_context(
     """Set the child Runnable config + tracing context.
 
     Args:
-        config (RunnableConfig): The config to set.
+        config: The config to set.
 
     Returns:
         The token to reset the config and the previous tracing context.
@@ -165,7 +165,7 @@ def set_config_context(config: RunnableConfig) -> Generator[Context, None, None]
     """Set the child Runnable config + tracing context.
 
     Args:
-        config (RunnableConfig): The config to set.
+        config: The config to set.
 
     Yields:
         The config context.
@@ -193,11 +193,10 @@ def ensure_config(config: RunnableConfig | None = None) -> RunnableConfig:
     """Ensure that a config is a dict with all keys present.
 
     Args:
-        config (Optional[RunnableConfig], optional): The config to ensure.
-          Defaults to None.
+        config: The config to ensure.
 
     Returns:
-        RunnableConfig: The ensured config.
+        The ensured config.
     """
     empty = RunnableConfig(
         tags=[],
@@ -251,12 +250,11 @@ def get_config_list(
      It is useful for subclasses overriding batch() or abatch().
 
     Args:
-        config (Optional[Union[RunnableConfig, list[RunnableConfig]]]):
-          The config or list of configs.
-        length (int): The length of the list.
+        config: The config or list of configs.
+        length: The length of the list.
 
     Returns:
-        list[RunnableConfig]: The list of configs.
+        The list of configs.
 
     Raises:
         ValueError: If the length of the list is not equal to the length of the inputs.
@@ -302,19 +300,15 @@ def patch_config(
     """Patch a config with new values.
 
     Args:
-        config (Optional[RunnableConfig]): The config to patch.
-        callbacks (Optional[BaseCallbackManager], optional): The callbacks to set.
-          Defaults to None.
-        recursion_limit (Optional[int], optional): The recursion limit to set.
-          Defaults to None.
-        max_concurrency (Optional[int], optional): The max concurrency to set.
-          Defaults to None.
-        run_name (Optional[str], optional): The run name to set. Defaults to None.
-        configurable (Optional[dict[str, Any]], optional): The configurable to set.
-          Defaults to None.
+        config: The config to patch.
+        callbacks: The callbacks to set.
+        recursion_limit: The recursion limit to set.
+        max_concurrency: The max concurrency to set.
+        run_name: The run name to set.
+        configurable: The configurable to set.
 
     Returns:
-        RunnableConfig: The patched config.
+        The patched config.
     """
     config = ensure_config(config)
     if callbacks is not None:
@@ -340,10 +334,10 @@ def merge_configs(*configs: RunnableConfig | None) -> RunnableConfig:
     """Merge multiple configs into one.
 
     Args:
-        *configs (Optional[RunnableConfig]): The configs to merge.
+        *configs: The configs to merge.
 
     Returns:
-        RunnableConfig: The merged config.
+        The merged config.
     """
     base: RunnableConfig = {}
     # Even though the keys aren't literals, this is correct
@@ -418,7 +412,7 @@ def call_func_with_variable_args(
         func: The function to call.
         input: The input to the function.
         config: The config to pass to the function.
-        run_manager: The run manager to pass to the function. Defaults to None.
+        run_manager: The run manager to pass to the function.
         **kwargs: The keyword arguments to pass to the function.
 
     Returns:
@@ -452,7 +446,7 @@ def acall_func_with_variable_args(
         func: The function to call.
         input: The input to the function.
         config: The config to pass to the function.
-        run_manager: The run manager to pass to the function. Defaults to None.
+        run_manager: The run manager to pass to the function.
         **kwargs: The keyword arguments to pass to the function.
 
     Returns:
@@ -472,10 +466,10 @@ def get_callback_manager_for_config(config: RunnableConfig) -> CallbackManager:
     """Get a callback manager for a config.
 
     Args:
-        config (RunnableConfig): The config.
+        config: The config.
 
     Returns:
-        CallbackManager: The callback manager.
+        The callback manager.
     """
     return CallbackManager.configure(
         inheritable_callbacks=config.get("callbacks"),
@@ -490,10 +484,10 @@ def get_async_callback_manager_for_config(
     """Get an async callback manager for a config.
 
     Args:
-        config (RunnableConfig): The config.
+        config: The config.
 
     Returns:
-        AsyncCallbackManager: The async callback manager.
+        The async callback manager.
     """
     return AsyncCallbackManager.configure(
         inheritable_callbacks=config.get("callbacks"),
@@ -518,12 +512,12 @@ class ContextThreadPoolExecutor(ThreadPoolExecutor):
         """Submit a function to the executor.
 
         Args:
-            func (Callable[..., T]): The function to submit.
-            *args (Any): The positional arguments to the function.
-            **kwargs (Any): The keyword arguments to the function.
+            func: The function to submit.
+            *args: The positional arguments to the function.
+            **kwargs: The keyword arguments to the function.
 
         Returns:
-            Future[T]: The future for the function.
+            The future for the function.
         """
         return super().submit(
             cast("Callable[..., T]", partial(copy_context().run, func, *args, **kwargs))
@@ -539,14 +533,13 @@ class ContextThreadPoolExecutor(ThreadPoolExecutor):
         """Map a function to multiple iterables.
 
         Args:
-            fn (Callable[..., T]): The function to map.
-            *iterables (Iterable[Any]): The iterables to map over.
-            timeout (float | None, optional): The timeout for the map.
-                Defaults to None.
-            chunksize (int, optional): The chunksize for the map. Defaults to 1.
+            fn: The function to map.
+            *iterables: The iterables to map over.
+            timeout: The timeout for the map.
+            chunksize: The chunksize for the map. Defaults to 1.
 
         Returns:
-            Iterator[T]: The iterator for the mapped function.
+            The iterator for the mapped function.
         """
         contexts = [copy_context() for _ in range(len(iterables[0]))]  # type: ignore[arg-type]
 
@@ -568,10 +561,10 @@ def get_executor_for_config(
     """Get an executor for a config.
 
     Args:
-        config (RunnableConfig): The config.
+        config: The config.
 
     Yields:
-        Generator[Executor, None, None]: The executor.
+        The executor.
     """
     config = config or {}
     with ContextThreadPoolExecutor(
@@ -590,12 +583,12 @@ async def run_in_executor(
 
     Args:
         executor_or_config: The executor or config to run in.
-        func (Callable[P, Output]): The function.
-        *args (Any): The positional arguments to the function.
-        **kwargs (Any): The keyword arguments to the function.
+        func: The function.
+        *args: The positional arguments to the function.
+        **kwargs: The keyword arguments to the function.
 
     Returns:
-        Output: The output of the function.
+        The output of the function.
     """
 
     def wrapper() -> T:

langchain_core/runnables/configurable.py

@@ -49,8 +49,8 @@ if TYPE_CHECKING:
 class DynamicRunnable(RunnableSerializable[Input, Output]):
     """Serializable Runnable that can be dynamically configured.
 
-    A DynamicRunnable should be initiated using the ``configurable_fields`` or
-    ``configurable_alternatives`` method of a Runnable.
+    A DynamicRunnable should be initiated using the `configurable_fields` or
+    `configurable_alternatives` method of a Runnable.
     """
 
     default: RunnableSerializable[Input, Output]
@@ -75,7 +75,7 @@ class DynamicRunnable(RunnableSerializable[Input, Output]):
         """Get the namespace of the langchain object.
 
         Returns:
-            ``["langchain", "schema", "runnable"]``
+            `["langchain", "schema", "runnable"]`
         """
         return ["langchain", "schema", "runnable"]
 
@@ -123,11 +123,10 @@ class DynamicRunnable(RunnableSerializable[Input, Output]):
         """Prepare the Runnable for invocation.
 
         Args:
-            config: The configuration to use. Defaults to None.
+            config: The configuration to use.
 
         Returns:
-            tuple[Runnable[Input, Output], RunnableConfig]: The prepared Runnable and
-            configuration.
+            The prepared Runnable and configuration.
         """
         runnable: Runnable[Input, Output] = self
         while isinstance(runnable, DynamicRunnable):
@@ -384,7 +383,7 @@ class RunnableConfigurableFields(DynamicRunnable[Input, Output]):
         """Get the configuration specs for the RunnableConfigurableFields.
 
         Returns:
-            list[ConfigurableFieldSpec]: The configuration specs.
+            The configuration specs.
         """
         config_specs = []
 
@@ -541,7 +540,7 @@ class RunnableConfigurableAlternatives(DynamicRunnable[Input, Output]):
     """The alternatives to choose from."""
 
     default_key: str = "default"
-    """The enum value to use for the default option. Defaults to ``'default'``."""
+    """The enum value to use for the default option. Defaults to `'default'`."""
 
     prefix_keys: bool
     """Whether to prefix configurable fields of each alternative with a namespace
@@ -656,7 +655,7 @@ def prefix_config_spec(
         prefix: The prefix to add.
 
     Returns:
-        ConfigurableFieldSpec: The prefixed ConfigurableFieldSpec.
+        The prefixed ConfigurableFieldSpec.
     """
     return (
         ConfigurableFieldSpec(

langchain_core/runnables/fallbacks.py

@@ -47,8 +47,8 @@ class RunnableWithFallbacks(RunnableSerializable[Input, Output]):
     of a chain of Runnables. Fallbacks are tried in order until one succeeds or
     all fail.
 
-    While you can instantiate a ``RunnableWithFallbacks`` directly, it is usually
-    more convenient to use the ``with_fallbacks`` method on a Runnable.
+    While you can instantiate a `RunnableWithFallbacks` directly, it is usually
+    more convenient to use the `with_fallbacks` method on a Runnable.
 
     Example:
         ```python
@@ -97,7 +97,7 @@ class RunnableWithFallbacks(RunnableSerializable[Input, Output]):
     """
     exception_key: str | None = None
     """If string is specified then handled exceptions will be passed to fallbacks as
-        part of the input under the specified key. If None, exceptions
+        part of the input under the specified key. If `None`, exceptions
         will not be passed to fallbacks. If used, the base Runnable and its fallbacks
         must accept a dictionary as input."""
 
@@ -146,7 +146,7 @@ class RunnableWithFallbacks(RunnableSerializable[Input, Output]):
         """Get the namespace of the langchain object.
 
         Returns:
-            ``["langchain", "schema", "runnable"]``
+            `["langchain", "schema", "runnable"]`
         """
         return ["langchain", "schema", "runnable"]
 
@@ -594,7 +594,7 @@ class RunnableWithFallbacks(RunnableSerializable[Input, Output]):
         Returns:
             If the attribute is anything other than a method that outputs a Runnable,
             returns getattr(self.runnable, name). If the attribute is a method that
-            does return a new Runnable (e.g. llm.bind_tools([...]) outputs a new
+            does return a new Runnable (e.g. model.bind_tools([...]) outputs a new
             RunnableBinding) then self.runnable and each of the runnables in
             self.fallbacks is replaced with getattr(x, name).
 
@@ -605,15 +605,15 @@ class RunnableWithFallbacks(RunnableSerializable[Input, Output]):
 
             gpt_4o = ChatOpenAI(model="gpt-4o")
             claude_3_sonnet = ChatAnthropic(model="claude-3-7-sonnet-20250219")
-            llm = gpt_4o.with_fallbacks([claude_3_sonnet])
+            model = gpt_4o.with_fallbacks([claude_3_sonnet])
 
-            llm.model_name
+            model.model_name
             # -> "gpt-4o"
 
             # .bind_tools() is called on both ChatOpenAI and ChatAnthropic
             # Equivalent to:
             # gpt_4o.bind_tools([...]).with_fallbacks([claude_3_sonnet.bind_tools([...])])
-            llm.bind_tools([...])
+            model.bind_tools([...])
             # -> RunnableWithFallbacks(
                 runnable=RunnableBinding(bound=ChatOpenAI(...), kwargs={"tools": [...]}),
                 fallbacks=[RunnableBinding(bound=ChatAnthropic(...), kwargs={"tools": [...]})],

langchain_core/runnables/graph.py

@@ -52,7 +52,7 @@ def is_uuid(value: str) -> bool:
         value: The string to check.
 
     Returns:
-        True if the string is a valid UUID, False otherwise.
+        `True` if the string is a valid UUID, `False` otherwise.
     """
     try:
         UUID(value)
@@ -69,16 +69,16 @@ class Edge(NamedTuple):
     target: str
     """The target node id."""
     data: Stringifiable | None = None
-    """Optional data associated with the edge. Defaults to None."""
+    """Optional data associated with the edge. """
     conditional: bool = False
-    """Whether the edge is conditional. Defaults to False."""
+    """Whether the edge is conditional. Defaults to `False`."""
 
     def copy(self, *, source: str | None = None, target: str | None = None) -> Edge:
         """Return a copy of the edge with optional new source and target nodes.
 
         Args:
-            source: The new source node id. Defaults to None.
-            target: The new target node id. Defaults to None.
+            source: The new source node id.
+            target: The new target node id.
 
         Returns:
             A copy of the edge with the new source and target nodes.
@@ -101,7 +101,7 @@ class Node(NamedTuple):
     data: type[BaseModel] | RunnableType | None
     """The data of the node."""
     metadata: dict[str, Any] | None
-    """Optional metadata for the node. Defaults to None."""
+    """Optional metadata for the node. """
 
     def copy(
         self,
@@ -112,8 +112,8 @@ class Node(NamedTuple):
         """Return a copy of the node with optional new id and name.
 
         Args:
-            id: The new node id. Defaults to None.
-            name: The new node name. Defaults to None.
+            id: The new node id.
+            name: The new node name.
 
         Returns:
             A copy of the node with the new id and name.
@@ -132,7 +132,7 @@ class Branch(NamedTuple):
     condition: Callable[..., str]
     """A callable that returns a string representation of the condition."""
     ends: dict[str, str] | None
-    """Optional dictionary of end node ids for the branches. Defaults to None."""
+    """Optional dictionary of end node ids for the branches. """
 
 
 class CurveStyle(Enum):
@@ -203,7 +203,7 @@ def node_data_json(
     Args:
         node: The node to convert.
         with_schemas: Whether to include the schema of the data if
-            it is a Pydantic model. Defaults to False.
+            it is a Pydantic model. Defaults to `False`.
 
     Returns:
         A dictionary with the type of the data and the data itself.
@@ -267,7 +267,7 @@ class Graph:
 
         Args:
             with_schemas: Whether to include the schemas of the nodes if they are
-                Pydantic models. Defaults to False.
+                Pydantic models. Defaults to `False`.
 
         Returns:
             A dictionary with the nodes and edges of the graph.
@@ -321,8 +321,8 @@ class Graph:
 
         Args:
             data: The data of the node.
-            id: The id of the node. Defaults to None.
-            metadata: Optional metadata for the node. Defaults to None.
+            id: The id of the node.
+            metadata: Optional metadata for the node.
 
         Returns:
             The node that was added to the graph.
@@ -361,8 +361,8 @@ class Graph:
         Args:
             source: The source node of the edge.
             target: The target node of the edge.
-            data: Optional data associated with the edge. Defaults to None.
-            conditional: Whether the edge is conditional. Defaults to False.
+            data: Optional data associated with the edge.
+            conditional: Whether the edge is conditional. Defaults to `False`.
 
         Returns:
             The edge that was added to the graph.
@@ -548,10 +548,11 @@ class Graph:
         """Draw the graph as a PNG image.
 
         Args:
-            output_file_path: The path to save the image to. If None, the image
-                is not saved. Defaults to None.
-            fontname: The name of the font to use. Defaults to None.
-            labels: Optional labels for nodes and edges in the graph. Defaults to None.
+            output_file_path: The path to save the image to. If `None`, the image
+                is not saved.
+            fontname: The name of the font to use.
+            labels: Optional labels for nodes and edges in the graph. Defaults to
+                `None`.
 
         Returns:
             The PNG image as bytes if output_file_path is None, None otherwise.
@@ -584,14 +585,14 @@ class Graph:
         """Draw the graph as a Mermaid syntax string.
 
         Args:
-            with_styles: Whether to include styles in the syntax. Defaults to True.
+            with_styles: Whether to include styles in the syntax. Defaults to `True`.
             curve_style: The style of the edges. Defaults to CurveStyle.LINEAR.
             node_colors: The colors of the nodes. Defaults to NodeStyles().
             wrap_label_n_words: The number of words to wrap the node labels at.
                 Defaults to 9.
-            frontmatter_config (dict[str, Any], optional): Mermaid frontmatter config.
+            frontmatter_config: Mermaid frontmatter config.
                 Can be used to customize theme and styles. Will be converted to YAML and
-                added to the beginning of the mermaid graph. Defaults to None.
+                added to the beginning of the mermaid graph.
 
                 See more here: https://mermaid.js.org/config/configuration.html.
 
@@ -650,8 +651,8 @@ class Graph:
             node_colors: The colors of the nodes. Defaults to NodeStyles().
             wrap_label_n_words: The number of words to wrap the node labels at.
                 Defaults to 9.
-            output_file_path: The path to save the image to. If None, the image
-                is not saved. Defaults to None.
+            output_file_path: The path to save the image to. If `None`, the image
+                is not saved.
             draw_method: The method to use to draw the graph.
                 Defaults to MermaidDrawMethod.API.
             background_color: The color of the background. Defaults to "white".
@@ -660,9 +661,9 @@ class Graph:
                 Defaults to 1.
             retry_delay: The delay between retries (MermaidDrawMethod.API).
                 Defaults to 1.0.
-            frontmatter_config (dict[str, Any], optional): Mermaid frontmatter config.
+            frontmatter_config: Mermaid frontmatter config.
                 Can be used to customize theme and styles. Will be converted to YAML and
-                added to the beginning of the mermaid graph. Defaults to None.
+                added to the beginning of the mermaid graph.
 
                 See more here: https://mermaid.js.org/config/configuration.html.
 
@@ -678,7 +679,7 @@ class Graph:
                 }
                 ```
             base_url: The base URL of the Mermaid server for rendering via API.
-                Defaults to None.
+
 
         Returns:
             The PNG image as bytes.

langchain_core/runnables/graph_ascii.py

@@ -62,8 +62,8 @@ class AsciiCanvas:
         """Create an ASCII canvas.
 
         Args:
-            cols: number of columns in the canvas. Should be ``> 1``.
-            lines: number of lines in the canvas. Should be ``> 1``.
+            cols: number of columns in the canvas. Should be `> 1`.
+            lines: number of lines in the canvas. Should be `> 1`.
 
         Raises:
             ValueError: if canvas dimensions are invalid.
@@ -90,9 +90,9 @@ class AsciiCanvas:
         """Create a point on ASCII canvas.
 
         Args:
-            x: x coordinate. Should be ``>= 0`` and ``<`` number of columns in
+            x: x coordinate. Should be `>= 0` and `<` number of columns in
                 the canvas.
-            y: y coordinate. Should be ``>= 0`` an ``<`` number of lines in the
+            y: y coordinate. Should be `>= 0` an `<` number of lines in the
                 canvas.
             char: character to place in the specified point on the
                 canvas.
@@ -117,11 +117,11 @@ class AsciiCanvas:
         """Create a line on ASCII canvas.
 
         Args:
-            x0 (int): x coordinate where the line should start.
-            y0 (int): y coordinate where the line should start.
-            x1 (int): x coordinate where the line should end.
-            y1 (int): y coordinate where the line should end.
-            char (str): character to draw the line with.
+            x0: x coordinate where the line should start.
+            y0: y coordinate where the line should start.
+            x1: x coordinate where the line should end.
+            y1: y coordinate where the line should end.
+            char: character to draw the line with.
         """
         if x0 > x1:
             x1, x0 = x0, x1
@@ -149,9 +149,9 @@ class AsciiCanvas:
         """Print a text on ASCII canvas.
 
         Args:
-            x (int): x coordinate where the text should start.
-            y (int): y coordinate where the text should start.
-            text (str): string that should be printed.
+            x: x coordinate where the text should start.
+            y: y coordinate where the text should start.
+            text: string that should be printed.
         """
         for i, char in enumerate(text):
             self.point(x + i, y, char)
@@ -160,10 +160,10 @@ class AsciiCanvas:
         """Create a box on ASCII canvas.
 
         Args:
-            x0 (int): x coordinate of the box corner.
-            y0 (int): y coordinate of the box corner.
-            width (int): box width.
-            height (int): box height.
+            x0: x coordinate of the box corner.
+            y0: y coordinate of the box corner.
+            width: box width.
+            height: box height.
         """
         if width <= 1 or height <= 1:
             msg = "Box dimensions should be > 1"
@@ -267,7 +267,8 @@ def draw_ascii(vertices: Mapping[str, str], edges: Sequence[LangEdge]) -> str:
 
         print(draw_ascii(vertices, edges))
         ```
-        .. code-block::
+
+        ```txt
 
                  +---+
                  | 1 |
@@ -284,7 +285,7 @@ def draw_ascii(vertices: Mapping[str, str], edges: Sequence[LangEdge]) -> str:
             +---+     +---+
             | 3 |     | 4 |
             +---+     +---+
-
+        ```
     """
     # NOTE: coordinates might me negative, so we need to shift
     # everything to the positive plane before we actually draw it.