conan.tools.layout

预定义布局

Conan 提供了一些预定义的常用布局，可以直接在食谱中使用。

• cmake_layout(): 典型的 CMake 项目布局

• vs_layout(): 典型的 Visual Studio 项目布局

• basic_layout(): 通用项目的非常基础的布局

预定义布局会使用典型值来定义 Conanfile 的 .folders 和 .cpp 属性。要查看这些预定义布局设置了哪些值，请查阅 layout() 方法的参考资料。例如，在 cmake_layout() 中，源文件夹设置为 "."，这意味着 Conan 将期望源文件与 conanfile 位于同一目录中（很可能是项目根目录，通常会找到 CMakeLists.txt 文件）。如果您有另一个存放 CMakeLists.txt 的文件夹，您可以使用 src_folder 参数。

from conan.tools.cmake import cmake_layout

def layout(self):
    cmake_layout(self, src_folder="mysrcfolder")

即使这些预定义布局不适合您的特定项目布局，查看它们如何实现其逻辑也能展示您如何实现自己的逻辑（如果您打算在多个包中使用它，则很可能将其放在一个公共的 python_require 中）。

要了解有关布局以及如何在开发包时使用它们的更多信息，请查阅 Conan 包布局教程。

basic_layout

用法

from conan.tools.layout import basic_layout

def layout(self):
    basic_layout(self)

当前的布局实现非常简单，基本上为不同的 build_types 设置了不同的构建文件夹，并将生成器输出文件夹设置在构建文件夹内。这样，我们在本地工作时可以避免项目混乱。如果您愿意，可以定义 build_folder 来控制目标文件夹，这样临时构建文件就不会污染源代码树。

def basic_layout(conanfile, src_folder=".", build_folder=None):
    subproject = conanfile.folders.subproject

    conanfile.folders.source = src_folder if not subproject else os.path.join(subproject, src_folder)
    if build_folder:
        conanfile.folders.build = build_folder if not subproject else os.path.join(subproject, build_folder)
    else:
        conanfile.folders.build = "build" if not subproject else os.path.join(subproject, "build")
        if conanfile.settings.get_safe("build_type"):
            conanfile.folders.build += "-{}".format(str(conanfile.settings.build_type).lower())
    conanfile.folders.generators = os.path.join(conanfile.folders.build, "conan")
    conanfile.cpp.build.bindirs = ["."]
    conanfile.cpp.build.libdirs = ["."]