设置
本指南介绍了如何在本地运行仓库并提交您的首个代码。有关开发容器，请参阅.devcontainer 文件夹。
依赖管理：uv 和其他 env/依赖管理器
本项目使用 uv v0.5+ 作为依赖管理器。
安装 uv：关于如何安装的文档。
不同的包
此仓库包含多个包
langchain-core：关键抽象的基础接口以及在链中组合它们的逻辑（LangChain 表达式语言）。langchain-community：各种组件的第三方集成。langchain：构成您的应用程序认知架构的链、代理和检索逻辑。langchain-experimental：实验性的组件和链，要么是因为技术是新颖且仍在测试中，要么是因为它们需要比大多数生产系统可能提供的更多 LLM 访问权限。- 合作伙伴集成：
libs/partners中的合作伙伴包，它们是独立版本控制的。
这些包中的每一个都有自己的开发环境。文档从顶层 makefile 运行，但开发分为单独的测试和发布流程。
对于本快速入门，请从 langchain-community 开始
cd libs/community
本地开发依赖项
安装 langchain-community 开发要求（用于运行 langchain、运行示例、linting、格式化、测试和覆盖率）
uv sync
然后验证依赖项安装
make test
测试
注意： 在 langchain、langchain-community 和 langchain-experimental 中，一些测试依赖项是可选的。请参阅以下关于可选依赖项的部分。
单元测试涵盖不需要调用外部 API 的模块化逻辑。如果您添加新逻辑，请添加单元测试。
要运行单元测试
make test
要在 Docker 中运行单元测试
make docker_tests
还有 集成测试和代码覆盖率 可用。
仅开发 langchain_core 或 langchain_community
如果您仅开发 langchain_core 或 langchain_community，则只需安装相应项目的依赖项并运行测试即可
cd libs/core
make test
或者
cd libs/community
make test
格式化和 Linting
在提交 PR 之前在本地运行这些；CI 系统也会进行检查。
代码格式化
此项目的格式化通过 ruff 完成。
要为文档、cookbook 和模板运行格式化
make format
要为库运行格式化，请从相关的库目录运行相同的命令
cd libs/{LIBRARY}
make format
此外，您可以仅对当前分支中与 master 分支相比已修改的文件运行格式化程序，方法是使用 format_diff 命令
make format_diff
当您仅对项目的一个子集进行了更改并希望确保您的更改格式正确而不影响代码库的其余部分时，这尤其有用。
Linting
此项目的 Linting 通过 ruff 和 mypy 的组合完成。
要为文档、cookbook 和模板运行 linting
make lint
要为库运行 linting，请从相关的库目录运行相同的命令
cd libs/{LIBRARY}
make lint
此外，您可以仅对当前分支中与 master 分支相比已修改的文件运行 linter，方法是使用 lint_diff 命令
make lint_diff
当您仅对项目的某些部分进行了更改，并希望确保您的更改符合 linting 标准，而无需检查整个代码库时，这可能非常有用。
我们认识到 linting 可能会很烦人 - 如果您不想这样做，请联系项目维护者，他们可以帮助您。我们不希望这成为贡献优秀代码的障碍。
拼写检查
此项目的拼写检查通过 codespell 完成。请注意，codespell 查找常见的拼写错误，因此它可能具有误报（拼写正确但很少使用）和漏报（未找到拼写错误）的单词。
要检查此项目的拼写
make spell_check
要就地修复拼写
make spell_fix
如果 codespell 错误地标记了一个单词，您可以通过将其添加到 pyproject.toml 文件中的 codespell 配置来跳过该单词的拼写检查。
[tool.codespell]
...
# Add here:
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 并添加依赖项
- 添加一个单元测试，至少尝试导入新代码。理想情况下，单元测试使用轻量级 fixtures 来测试代码的逻辑。
- 对于任何需要依赖项的单元测试，请使用
@pytest.mark.requires(package_name)装饰器。
添加 Jupyter Notebook
如果您要添加 Jupyter Notebook 示例，您将需要使用 test 依赖项运行
uv run --group test jupyter notebook
当您运行 uv sync 时，langchain 包作为可编辑包安装在 virtualenv 中，因此您的新逻辑可以导入到 notebook 中。