langchain_community.document_loaders.git.GitLoader

class langchain_community.document_loaders.git.GitLoader(repo_path: str, clone_url: Optional[str] = None, branch: Optional[str] = 'main', file_filter: Optional[Callable[[str], bool]] = None)[source]

Load Git repository files.

The Repository can be local on disk available at repo_path, or remote at clone_url that will be cloned to repo_path. Currently, supports only text files.

Each document represents one file in the repository. The path points to the local Git repository, and the branch specifies the branch to load files from. By default, it loads from the main branch.

Parameters
  • repo_path (str) – The path to the Git repository.

  • clone_url (Optional[str]) – Optional. The URL to clone the repository from.

  • branch (Optional[str]) – Optional. The branch to load files from. Defaults to main.

  • file_filter (Optional[Callable[[str], bool]]) – Optional. A function that takes a file path and returns a boolean indicating whether to load the file. Defaults to None.

Methods

__init__(repo_path[, clone_url, branch, ...])

param repo_path

The path to the Git repository.

alazy_load()

A lazy loader for Documents.

aload()

Load data into Document objects.

lazy_load()

A lazy loader for Documents.

load()

Load data into Document objects.

load_and_split([text_splitter])

Load Documents and split into chunks.

__init__(repo_path: str, clone_url: Optional[str] = None, branch: Optional[str] = 'main', file_filter: Optional[Callable[[str], bool]] = None)[source]
Parameters
  • repo_path (str) – The path to the Git repository.

  • clone_url (Optional[str]) – Optional. The URL to clone the repository from.

  • branch (Optional[str]) – Optional. The branch to load files from. Defaults to main.

  • file_filter (Optional[Callable[[str], bool]]) – Optional. A function that takes a file path and returns a boolean indicating whether to load the file. Defaults to None.

async alazy_load() AsyncIterator[Document]

A lazy loader for Documents.

Return type

AsyncIterator[Document]

async aload() List[Document]

Load data into Document objects.

Return type

List[Document]

lazy_load() Iterator[Document][source]

A lazy loader for Documents.

Return type

Iterator[Document]

load() List[Document]

Load data into Document objects.

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document]

Load Documents and split into chunks. Chunks are returned as Documents.

Do not override this method. It should be considered to be deprecated!

Parameters

text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns

List of Documents.

Return type

List[Document]

Examples using GitLoader