batch_iterate() — langchain Function Reference

Architecture documentation for the batch_iterate() function in iter.py from the langchain codebase.

Function python CoreAbstractions RunnableInterface

Entity Profile

CoreAbstractions→ RunnableInterface→ batch_iterate() — langchain Function Reference

Dependency Diagram

graph TD
  1bb2bcdd_ec2a_b9ca_6dc4_8870bc8c329b["batch_iterate()"]
  b289db43_7cd8_e404_08a4_ad932b851c13["iter.py"]
  1bb2bcdd_ec2a_b9ca_6dc4_8870bc8c329b -->|defined in| b289db43_7cd8_e404_08a4_ad932b851c13
  style 1bb2bcdd_ec2a_b9ca_6dc4_8870bc8c329b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/utils/iter.py lines 206–223

def batch_iterate(size: int | None, iterable: Iterable[T]) -> Iterator[list[T]]:
    """Utility batching function.

    Args:
        size: The size of the batch.

            If `None`, returns a single batch.
        iterable: The iterable to batch.

    Yields:
        The batches of the iterable.
    """
    it = iter(iterable)
    while True:
        chunk = list(islice(it, size))
        if not chunk:
            return
        yield chunk