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_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 = ["."]