Qbs¶
Qbs 构建辅助工具是 Qbs 构建工具命令行调用的封装。它将 qbs resolve、qbs build 和 qbs install 等调用抽象为 Python 方法调用。
该辅助工具旨在用于 build() 和 package() 方法中,以便在 Conan 直接构建(create、install)包时自动调用 Qbs 命令。
from conan import ConanFile
from conan.tools.qbs import Qbs, QbsProfile, QbsDeps
class App(ConanFile):
settings = "os", "arch", "compiler", "build_type"
exports_sources = "*.h", "*.cpp", "*.qbs",
requires = "hello/0.1"
options = {"shared": [True, False], "fPIC": [True, False]}
default_options = {"shared": False, "fPIC": True}
def generate(self):
profile = QbsProfile(self)
profile.generate()
deps = QbsDeps(self)
deps.generate()
def build(self):
qbs = Qbs(self)
qbs.resolve()
qbs.build()
def package(self):
qbs = Qbs(self)
qbs.install()
参考¶
- class Qbs(conanfile, project_file=None)¶
Qbs 辅助工具,与 QbsDeps 功能一起使用。此类提供封装 Qbs 工具调用的辅助方法。
- 参数:
conanfile – 当前的配方对象。始终使用
self。project_file – 主项目文件的名称。如果未设置,Qbs 将尝试自动检测项目文件。
- add_configuration(name, values)¶
为多配置构建添加构建配置。此 Qbs 功能很少需要,因为每个 conan 包只能包含一种配置,但在创建同一产品的多个版本并应将它们放入同一个 Conan 包时可能有用。
- 参数:
name – 配置的名称。这对应于
qbs resolve、qbs build和qbs install命令的config参数。values – 包含 Qbs 属性及其在此配置下的值的字典。
- resolve(parallel=True)¶
封装
qbs resolve调用。如果使用 QbsDeps 生成器,它还将自动设置 Qbs “conan” 模块提供程序的必要属性,将依赖项添加到项目中。:param parallel: 是否使用多线程解析。默认为True。
- build(products=None)¶
封装
qbs build调用。- 参数:
products – 要构建的产品名称列表。如果未设置,则构建所有 builtByDefault 设置为 true 的产品。此参数对应于
qbs build命令的--products选项。
应在调用此方法之前调用 resolve() 方法。
- build_all()¶
封装
qbs build --all-products调用。此方法构建所有产品,即使它们的 builtByDefault 属性为 false。应在调用此方法之前调用 resolve() 方法。
- install()¶
封装
qbs install调用。执行 Qbs 项目中标记为可安装文件的安装。应在调用此方法之前调用 build() 或 build_all() 方法。