ayield_keys() — langchain Function Reference

Architecture documentation for the ayield_keys() function in stores.py from the langchain codebase.

Function python LangChainCore ApiManagement calls 1 called by 1

Entity Profile

LangChainCore→ ApiManagement→ ayield_keys() — langchain Function Reference

Dependency Diagram

graph TD
  209b297b_10f4_b869_0579_6cd920be0ca0["ayield_keys()"]
  0ebcc119_721f_59ac_fdad_f204128f9add["BaseStore"]
  209b297b_10f4_b869_0579_6cd920be0ca0 -->|defined in| 0ebcc119_721f_59ac_fdad_f204128f9add
  0650196e_b1ee_10b8_d438_0d53e4909224["ayield_keys()"]
  0650196e_b1ee_10b8_d438_0d53e4909224 -->|calls| 209b297b_10f4_b869_0579_6cd920be0ca0
  0650196e_b1ee_10b8_d438_0d53e4909224["ayield_keys()"]
  209b297b_10f4_b869_0579_6cd920be0ca0 -->|calls| 0650196e_b1ee_10b8_d438_0d53e4909224
  style 209b297b_10f4_b869_0579_6cd920be0ca0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/stores.py lines 150–170

    async def ayield_keys(
        self, *, prefix: str | None = None
    ) -> AsyncIterator[K] | AsyncIterator[str]:
        """Async get an iterator over keys that match the given prefix.

        Args:
            prefix: The prefix to match.

        Yields:
            The keys that match the given prefix.

                This method is allowed to return an iterator over either K or str
                depending on what makes more sense for the given store.
        """
        iterator = await run_in_executor(None, self.yield_keys, prefix=prefix)
        done = object()
        while True:
            item = await run_in_executor(None, lambda it: next(it, done), iterator)
            if item is done:
                break
            yield item  # type: ignore[misc]