yield_keys() — langchain Function Reference

Architecture documentation for the yield_keys() function in file_system.py from the langchain codebase.

Function python LangChainCore ApiManagement calls 1

Entity Profile

LangChainCore→ ApiManagement→ yield_keys() — langchain Function Reference

Dependency Diagram

graph TD
  967e8c30_eae3_c5ff_bf36_9f8ef2e82c28["yield_keys()"]
  26189a3b_3a87_0b57_a7a3_341b06895b61["LocalFileStore"]
  967e8c30_eae3_c5ff_bf36_9f8ef2e82c28 -->|defined in| 26189a3b_3a87_0b57_a7a3_341b06895b61
  60db82b3_b672_7a32_40bd_32b87d30a271["_get_full_path()"]
  967e8c30_eae3_c5ff_bf36_9f8ef2e82c28 -->|calls| 60db82b3_b672_7a32_40bd_32b87d30a271
  style 967e8c30_eae3_c5ff_bf36_9f8ef2e82c28 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain/langchain_classic/storage/file_system.py lines 151–164

    def yield_keys(self, *, prefix: str | None = None) -> Iterator[str]:
        """Get an iterator over keys that match the given prefix.

        Args:
            prefix: The prefix to match.

        Yields:
            Keys that match the given prefix.
        """
        prefix_path = self._get_full_path(prefix) if prefix else self.root_path
        for file in prefix_path.rglob("*"):
            if file.is_file():
                relative_path = file.relative_to(self.root_path)
                yield str(relative_path)