设置
本指南将指导你如何在本地运行仓库并提交你的第一段代码。 关于 开发容器，请参阅 .devcontainer 文件夹。
依赖管理：uv 及其他环境/依赖管理器
本项目使用 uv v0.5+ 作为依赖管理器。
安装 uv：安装指南。
不同包
此仓库包含多个包：
langchain-core：核心抽象的基类接口以及将它们组合成链（LangChain Expression Language）的逻辑。langchain：构成应用程序认知架构的链、代理和检索逻辑。- 合作伙伴集成：
libs/partners目录下的合作伙伴包，它们拥有独立的版本控制。
一些 LangChain 包位于单体仓库之外，例如可以查看 langchain-community 以了解各种 第三方集成，以及 langchain-experimental 以了解 是实验性抽象（意味着技术新颖且仍在测试中，或者需要给予 LLM 比大多数生产系统允许的更多的访问权限）。
每个包都有自己的开发环境。文档是从顶层 makefile 运行的，但开发 被分割到单独的测试和发布流程中。
对于此快速入门，请从 langchain 开始：
cd libs/langchain
本地开发依赖项
安装开发需求（用于运行 langchain、运行示例、代码检查、格式化、测试和覆盖率）：
uv sync
然后验证依赖项安装：
make test
测试
注意： 在 langchain、langchain-community 和 langchain-experimental 中，一些测试依赖项是可选的。请参阅关于可选依赖项的下一节。
单元测试涵盖不需要调用外部 API 的模块化逻辑。 如果你添加了新逻辑，请添加单元测试。
运行单元测试：
make test
在 Docker 中运行单元测试：
make docker_tests
还有 集成测试和代码覆盖率 可用。
开发 langchain_core
如果你只开发 langchain_core，可以简单地安装项目的依赖项并运行测试：
cd libs/core
make test
格式化和代码检查
在提交 PR 之前在本地运行这些命令；CI 系统也会进行检查。
代码格式化
此项目的格式化是通过 ruff 完成的。
运行文档、食谱和模板的格式化：
make format
要为库运行格式化，请从相关库目录运行相同的命令：
cd libs/{LIBRARY}
make format
此外，你可以使用 format_diff 命令仅针对当前分支与 master 分支相比已修改的文件运行格式化器：
make format_diff
当你只修改了项目的一部分并想确保你的更改已正确格式化而不会影响其余代码库时，这特别有用。
代码检查
此项目的代码检查是通过结合使用 ruff 和 mypy 来完成的。
运行文档、食谱和模板的代码检查：
make lint
要为库运行代码检查，请从相关库目录运行相同的命令：
cd libs/{LIBRARY}
make lint
此外，你可以使用 lint_diff 命令仅针对当前分支与 master 分支相比已修改的文件运行 linter：
make lint_diff
当你只修改了项目的部分内容并想确保你的更改符合代码检查标准，而无需检查整个代码库时，这会非常有帮助。
我们理解代码检查可能会很烦人 - 如果你不想做，请联系项目维护者，他们会帮助你完成。我们不希望这成为贡献优秀代码的障碍。
拼写检查
此项目的拼写检查是通过 codespell 完成的。
请注意，codespell 会查找常见的拼写错误，因此它可能存在误报（拼写正确但很少使用的词）和漏报（未找到拼写错误的词）。
检查项目拼写：
make spell_check
就地修复拼写：
make spell_fix
如果 codespell 错误地标记了一个词，你可以通过将其添加到 pyproject.toml 文件中的 codespell 配置来跳过该词的拼写检查。
[tool.codespell]
...
# 在此处添加：
ignore-words-list = 'momento,collison,ned,foor,reworkd,parth,whats,aapply,mysogyny,unsecure'
使用可选依赖项
langchain、langchain-community 和 langchain-experimental 依 赖于可选依赖项，以保持这些包的轻量级。
langchain-core 和合作伙伴包 不以 这种方式使用可选依赖项。
你会注意到当你添加可选依赖项时，pyproject.toml 和 uv.lock 不会 被修改。
如果你向 Langchain 添加新依赖项，请假定它将是一个可选依赖项， 并且大多数用户不会安装它。
未安装该依赖项的用户应该能够 导入 你的代码而不会产生任何副作用（没有警告、没有错误、没有异常）。
要将依赖项引入库，请执行以下操作：
- 打开
extended_testing_deps.txt并添加依赖项。 - 添加一个单元测试，至少尝试导入新代码。理想情况下，单元测试会使用轻量级的 fixture 来测试代码的逻辑。
- 请使用
@pytest.mark.requires(package_name)装饰器来标记任何需要该依赖项的单元测试。
添加 Jupyter Notebook
如果你要添加 Jupyter Notebook 示例，你需要使用 test 依赖项运行：
uv run --group test jupyter notebook
当你运行 uv sync 时，langchain 包将以可编辑模式安装在 virtualenv 中，因此你的新逻辑可以导入到 notebook 中。