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