conan.tools.layout

预定义布局

有一些预定义的常用布局，可以直接在配方中使用

• 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 设置不同的构建文件夹，并将生成器输出文件夹设置在构建文件夹内。这样可以避免在本地工作时弄乱项目。

def basic_layout(conanfile, src_folder="."):
    conanfile.folders.build = "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 = ["."]
    conanfile.folders.source = src_folder