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。

参考¶

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，否则它是要构建的目标列表