MSBuild¶
MSBuild
构建辅助工具是对 MSBuild 命令行调用的封装。它将诸如 msbuild "MyProject.sln" /p:Configuration=<conf> /p:Platform=<platform>
之类的调用抽象为 Python 方法。
此辅助工具可以像这样使用
from conan import ConanFile
from conan.tools.microsoft import MSBuild
class App(ConanFile):
settings = "os", "arch", "compiler", "build_type"
def build(self):
msbuild = MSBuild(self)
msbuild.build("MyProject.sln")
MSBuild.build()
方法在内部实现对 msbuild
的调用,如下所示:
$ <vcvars-cmd> && msbuild "MyProject.sln" /p:Configuration=<configuration> /p:Platform=<platform>
其中
<vcvars-cmd>
调用与当前配方settings
匹配的 Visual Studio 提示符。configuration
,通常为 Release、Debug,将从settings.build_type
中获取,但可以使用build_type
属性进行自定义。<platform>
是架构,从settings.arch
到常见的 ‘x86’、‘x64’、‘ARM’、‘ARM64’ 的映射。可以使用platform
属性进行自定义。
自定义¶
属性¶
如果需要更改以下属性,可以自定义它们:
build_type(默认
settings.build_type
):/p:Configuration
的值。platform(默认基于
settings.arch
选择以下值之一:('x86', 'x64', 'ARM', 'ARM64'
):/p:Platform
的值。
示例
from conan import ConanFile
from conan.tools.microsoft import MSBuild
class App(ConanFile):
settings = "os", "arch", "compiler", "build_type"
def build(self):
msbuild = MSBuild(self)
msbuild.build_type = "MyRelease"
msbuild.platform = "MyPlatform"
msbuild.build("MyProject.sln")
conf¶
MSBuild
受以下 [conf]
变量的影响:
tools.build:verbosity
接受quiet
或verbose
之一,作为msbuild .... /verbosity:{Quiet,Detailed}
传递给MSBuild.build()
调用。tools.microsoft.msbuild:max_cpu_count
传递给MSBuild.build()
调用的最大 CPU 数量,作为msbuild .... /m:N
。如果max_cpu_count=0
,则它将使用不带参数的/m
,这意味着使用所有可用的 CPU。
参考¶
- class MSBuild(conanfile)¶
MSBuild 构建辅助类
- 参数:
conanfile –
< ConanFile object >
当前配方对象。始终使用self
。
- command(sln, targets=None)¶
获取
msbuild
命令行。例如,msbuild "MyProject.sln" /p:Configuration=<conf> /p:Platform=<platform>。- 参数:
sln –
str
Visual Studio*.sln
文件的名称targets –
targets
是一个可选参数,默认为None
,否则它是要构建的目标列表
- 返回:
str
msbuild 命令行。
- build(sln, targets=None)¶
运行从
self.command(sln)
获取的msbuild
命令行。- 参数:
sln –
str
Visual Studio*.sln
文件的名称targets –
targets
是一个可选参数,默认为None
,否则它是要构建的目标列表