langchain.document_loaders.blob_loaders.file_system.FileSystemBlobLoader

class langchain.document_loaders.blob_loaders.file_system.FileSystemBlobLoader(path: Union[str, Path], *, glob: str = '**/[!.]*', suffixes: Optional[Sequence[str]] = None, show_progress: bool = False)

Bases: BlobLoader

Blob loader for the local file system.

Example:

from langchain.document_loaders.blob_loaders import FileSystemBlobLoader
loader = FileSystemBlobLoader("/path/to/directory")
for blob in loader.yield_blobs():
    print(blob)

Initialize with path to directory and how to glob over it.

Parameters

• path – Path to directory to load from

• glob – Glob pattern relative to the specified path by default set to pick up all non-hidden files

• suffixes – Provide to keep only files with these suffixes Useful when wanting to keep files with different suffixes Suffixes must include the dot, e.g. “.txt”

• show_progress – If true, will show a progress bar as the files are loaded. This forces an iteration through all matching files to count them prior to loading them.

Examples:

… code-block:: python

# Recursively load all text files in a directory. loader = FileSystemBlobLoader(“/path/to/directory”, glob=”**/*.txt”)

# Recursively load all non-hidden files in a directory. loader = FileSystemBlobLoader(“/path/to/directory”, glob=”**/[!.]*”)

# Load all files in a directory without recursion. loader = FileSystemBlobLoader(“/path/to/directory”, glob=”*”)

Methods

__init__(path, *[, glob, suffixes, ...])	Initialize with path to directory and how to glob over it.
count_matching_files()	Count files that match the pattern without loading them.
yield_blobs()	Yield blobs that match the requested pattern.

count_matching_files() → int

Count files that match the pattern without loading them.

yield_blobs() → Iterable[Blob]

Yield blobs that match the requested pattern.