源代码

本笔记本介绍了如何使用一种特殊的语言解析方法来加载源代码文件：代码中的每个顶层函数和类都会被加载到独立的文档中。任何未被加载的函数和类之外的剩余顶层代码，也将被加载到一个单独的文档中。

这种方法有可能提高问答模型在源代码上的准确性。

代码解析支持的语言包括：

C (*)
C++ (*)
C# (*)
COBOL
Elixir
Go (*)
Java (*)
JavaScript（需要包 esprima）
Kotlin (*)
Lua (*)
Perl (*)
Python
Ruby（*）
Rust (*)
Scala (*)
TypeScript (*)

标有 (*) 的项目需要 tree_sitter 和 tree_sitter_languages 包。使用 tree_sitter 添加对其他语言的支持很简单，尽管目前这需要修改 LangChain。

可以配置用于解析的语言，以及激活基于语法拆分所需的最小行数。

如果未明确指定语言，LanguageParser 将从文件名扩展名（如果存在）中推断一种语言。

%pip install -qU esprima esprima tree_sitter tree_sitter_languages

import warnings

warnings.filterwarnings("ignore")
from pprint import pprint

from langchain_community.document_loaders.generic import GenericLoader
from langchain_community.document_loaders.parsers import LanguageParser
from langchain_text_splitters import Language

API 参考：GenericLoader | LanguageParser | 语言

loader = GenericLoader.from_filesystem(
    "./example_data/source_code",
    glob="*",
    suffixes=[".py", ".js"],
    parser=LanguageParser(),
)
docs = loader.load()

len(docs)

for document in docs:
    pprint(document.metadata)

{'content_type': 'functions_classes',
 'language': <Language.PYTHON: 'python'>,
 'source': 'example_data/source_code/example.py'}
{'content_type': 'functions_classes',
 'language': <Language.PYTHON: 'python'>,
 'source': 'example_data/source_code/example.py'}
{'content_type': 'simplified_code',
 'language': <Language.PYTHON: 'python'>,
 'source': 'example_data/source_code/example.py'}
{'content_type': 'functions_classes',
 'language': <Language.JS: 'js'>,
 'source': 'example_data/source_code/example.js'}
{'content_type': 'functions_classes',
 'language': <Language.JS: 'js'>,
 'source': 'example_data/source_code/example.js'}
{'content_type': 'simplified_code',
 'language': <Language.JS: 'js'>,
 'source': 'example_data/source_code/example.js'}

print("\n\n--8<--\n\n".join([document.page_content for document in docs]))

class MyClass:
    def __init__(self, name):
        self.name = name

    def greet(self):
        print(f"Hello, {self.name}!")

--8<--

def main():
    name = input("Enter your name: ")
    obj = MyClass(name)
    obj.greet()

--8<--

# Code for: class MyClass:


# Code for: def main():


if __name__ == "__main__":
    main()

--8<--

class MyClass {
  constructor(name) {
    this.name = name;
  }

  greet() {
    console.log(`Hello, ${this.name}!`);
  }
}

--8<--

function main() {
  const name = prompt("Enter your name:");
  const obj = new MyClass(name);
  obj.greet();
}

--8<--

// Code for: class MyClass {

// Code for: function main() {

main();

对于小型文件，可以禁用解析器。

参数 parser_threshold 表示源代码文件必须具有的最小行数，才能使用解析器进行分段。

loader = GenericLoader.from_filesystem(
    "./example_data/source_code",
    glob="*",
    suffixes=[".py"],
    parser=LanguageParser(language=Language.PYTHON, parser_threshold=1000),
)
docs = loader.load()

len(docs)

print(docs[0].page_content)

class MyClass:
    def __init__(self, name):
        self.name = name

    def greet(self):
        print(f"Hello, {self.name}!")


def main():
    name = input("Enter your name: ")
    obj = MyClass(name)
    obj.greet()


if __name__ == "__main__":
    main()

拆分

对于那些过大的函数、类或脚本，可能需要进行额外的拆分。

loader = GenericLoader.from_filesystem(
    "./example_data/source_code",
    glob="*",
    suffixes=[".js"],
    parser=LanguageParser(language=Language.JS),
)
docs = loader.load()

from langchain_text_splitters import (
    Language,
    RecursiveCharacterTextSplitter,
)

API 参考：语言 |RecursiveCharacterTextSplitter

js_splitter = RecursiveCharacterTextSplitter.from_language(
    language=Language.JS, chunk_size=60, chunk_overlap=0
)

result = js_splitter.split_documents(docs)

len(result)

print("\n\n--8<--\n\n".join([document.page_content for document in result]))

class MyClass {
  constructor(name) {
    this.name = name;

--8<--

}

--8<--

greet() {
    console.log(`Hello, ${this.name}!`);
  }
}

--8<--

function main() {
  const name = prompt("Enter your name:");

--8<--

const obj = new MyClass(name);
  obj.greet();
}

--8<--

// Code for: class MyClass {

// Code for: function main() {

--8<--

main();

使用 Tree-sitter 模板添加语言

使用 Tree-Sitter 模板扩展语言支持涉及几个关键步骤：

创建新的语言文件:
- 首先在指定目录（langchain/libs/community/langchain_community/document_loaders/parsers/language）中创建一个新文件。
- 根据现有语言文件（如 cpp.py）的结构和解析逻辑来建模此文件。
- 您还需要在 langchain 目录中创建一个文件（langchain/libs/langchain/langchain/document_loaders/parsers/language）。
解析语言特定细节:
- 模仿 cpp.py 文件中使用的结构，并根据您所使用的语言进行调整。
- 主要的改动在于调整块查询数组，以适配您正在解析的语言的语法和结构。
测试语言解析器:
- 为了进行彻底的验证，请生成一个针对新语言的测试文件。在指定目录 (langchain/libs/community/tests/unit_tests/document_loaders/parsers/language) 中创建 test_language.py。
- 遵循 test_cpp.py 设立的示例，为新语言中解析的元素建立基础测试。
集成到解析器和文本分割器中:
- 在 language_parser.py 文件中集成您的新语言。请确保更新 LANGUAGE_EXTENSIONS 和 LANGUAGE_SEGMENTERS，以及 LanguageParser 的文档字符串，以便识别和处理所添加的语言。
- 此外，请确认您的语言已包含在 Language 类的 text_splitter.py 中，以便正确解析。

通过遵循这些步骤并确保全面的测试与集成，您将能够成功利用 Tree-Sitter 模板扩展语言支持。

祝你好运！

文档加载器概念指南
文档加载器操操作指南

拆分​

使用 Tree-sitter 模板添加语言​

相关​

拆分

使用 Tree-sitter 模板添加语言

相关