可编辑模式下的包¶

使用 Conan 包的常规方法是运行 conan create 或 conan export-pkg 将其存储在本地缓存中，以便使用者使用缓存中存储的包。在某些情况下，当您在开发包时想要使用这些包时，每次对包进行更改后都运行 conan create 可能很繁琐。对于这些情况，您可以将您的包置于可编辑模式，使用者将能够在您的本地工作目录中找到头文件和工件，从而无需打包。

让我们看看如何将包置于可编辑模式并从本地工作目录中使用它。

首先，请克隆源代码以重新创建此项目。您可以在 GitHub 上的 examples2 仓库中找到它们。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/developing_packages/editable_packages

此项目中有 2 个文件夹

.
├── hello
│   ├── CMakeLists.txt
│   ├── conanfile.py
│   └── src
│       └── hello.cpp
└── say
    ├── CMakeLists.txt
    ├── conanfile.py
    ├── include
    │   └── say.h
    └── src
        └── say.cpp

一个“say”文件夹，包含一个完整的包，以及它的 conanfile.py 和源代码。
一个“hello”文件夹，包含一个简单的使用者项目，以及它的 conanfile.py 和源代码，它依赖于 say/1.0 需求。

我们将 say/1.0 置于可编辑模式，并展示 hello 使用者如何在本地工作目录中找到 say/1.0 的头文件和二进制文件。

将 say/1.0 包置于可编辑模式¶

为了避免每次更改都创建 say/1.0 包到缓存中，我们将该包置于可编辑模式，**从缓存中的引用到本地工作目录创建一个链接**。

$ conan editable add say
$ conan editable list
say/1.0
    Path: /Users/.../examples2/tutorial/developing_packages/editable_packages/say/conanfile.py

从现在开始，任何其他 Conan 包或项目对 say/1.0 的任何使用都将重定向到 /Users/.../examples2/tutorial/developing_packages/editable_packages/say/conanfile.py 用户文件夹，而不是使用 Conan 缓存中的包。

请注意，可编辑包的关键是正确定义包的 layout()。阅读包布局() 部分以了解更多关于此方法的信息。

在此示例中，say 的 conanfile.py 正在使用预定义的 cmake_layout()，它定义了典型的 CMake 项目布局，该布局可能因使用的平台和生成器而异。

现在 say/1.0 包处于可编辑模式，让我们在本地构建它。

注意

我们在此示例中使用 CMake 预设。这需要 CMake >= 3.23，因为从 CMakeUserPresets.json 到 CMakePresets.json 的“include”仅在该版本之后才受支持。如果您不想使用预设，可以使用类似的方法

cmake <path> -G <CMake generator> -DCMAKE_TOOLCHAIN_FILE=<path to
conan_toolchain.cmake> -DCMAKE_BUILD_TYPE=Release

每次运行 conan install 时，Conan 都会显示确切的 CMake 命令，以防您无法使用预设功能。

$ cd say

# Windows: we will build 2 configurations to show multi-config
$ conan install . -s build_type=Release
$ conan install . -s build_type=Debug
$ cmake --preset conan-default
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug

# Linux, MacOS: we will only build 1 configuration
$ conan install .
$ cmake --preset conan-release
$ cmake --build --preset conan-release

使用可编辑模式下的 say/1.0 包¶

从使用者的角度来看，使用可编辑模式下的包是透明的。在这种情况下，我们可以像往常一样构建 hello 应用程序。

$ cd ../hello

# Windows: we will build 2 configurations to show multi-config
$ conan install . -s build_type=Release
$ conan install . -s build_type=Debug
$ cmake --preset conan-default
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug
$ build\Release\hello.exe
say/1.0: Hello World Release!
...
$ build\Debug\hello.exe
say/1.0: Hello World Debug!
...

# Linux, MacOS: we will only build 1 configuration
$ conan install .
$ cmake --preset conan-release
$ cmake --build --preset conan-release
$ ./build/Release/hello
say/1.0: Hello World Release!

如您所见，hello 可以成功找到 say/1.0 的头文件和库文件。

使用可编辑包¶

完成上述步骤后，您可以使用您的构建系统或 IDE 而无需涉及 Conan，并对可编辑包进行更改。使用者将直接使用这些更改。让我们看看通过在 say 源代码中进行更改是如何工作的。

$ cd ../say
# Edit src/say.cpp and change the error message from "Hello" to "Bye"

# Windows: we will build 2 configurations to show multi-config
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug

# Linux, MacOS: we will only build 1 configuration
$ cmake --build --preset conan-release

并构建和运行“hello”项目。

$ cd ../hello

# Windows
$ cd build
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug
$ Release\hello.exe
say/1.0: Bye World Release!
$ Debug\hello.exe
say/1.0: Bye World Debug!

# Linux, MacOS
$ cmake --build --preset conan-release
$ ./hello
say/1.0: Bye World Release!

通过这种方式，您可以同时开发 say 库和 hello 应用程序，而无需在两者之间执行任何 Conan 命令。如果两者都在您的 IDE 中打开，您可以简单地一个接一个地构建它们。

构建可编辑依赖项¶

如果存在许多可编辑依赖项，逐个构建它们并确保正确的顺序可能很麻烦。可以使用 --build 参数对可编辑依赖项进行有序构建。

让我们清理之前的本地可执行文件。

$ git clean -xdf

并且在 hello/conanfile.py 的配方中使用我们到目前为止还没有真正使用过的 build() 方法（因为我们一直通过直接调用 cmake 来构建，而不是通过调用 conan build 命令），我们可以使用以下命令进行构建：

$ conan build hello

请注意，要完成此项目的完整构建，我们只需要执行这两个命令。从不同文件夹的起点开始。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/developing_packages/editable_packages
$ conan editable add say
$ conan build hello --build=editable

请注意，如果我们没有将 --build=editable 传递给 conan build hello，则处于可编辑模式的 say/0.1 的二进制文件将不可用，并且构建将会失败。使用 --build=editable，首先会在本地和增量地构建 say 的二进制文件，然后会增量构建 hello。所有操作都将在本地进行，不会在缓存中构建任何包。如果有多个 editable 依赖项，以及嵌套的传递依赖项，Conan 将以正确的顺序构建它们。

如果可编辑包在 Conan 缓存中具有依赖项，则可以通过使用 --build=editable --build=cascade 强制从缓存依赖项的源代码重新构建。一般情况下应避免这种情况，如果需要重新构建这些依赖项，建议也将其置于可编辑模式。

请注意，可以使用其自己的 test_package 文件夹来构建和测试可编辑的包。如果将包置于 editable 模式，并且如果它包含 test_package 文件夹，则 conan create 命令仍将对当前包进行本地构建。

恢复可编辑模式¶

要恢复可编辑模式，只需使用以下命令删除链接：

$ conan editable remove --refs=say/1.0

它将删除链接（本地目录不会受到影响），并且所有使用此需求的包都将再次从缓存中获取它。

警告

在使用上游的可编辑包构建的包可能会生成与可编辑包的发布版本不兼容的二进制文件和包。避免上传这些包，除非使用所有库的缓存版本重新创建它们。