VirtualBuildEnv

VirtualBuildEnv 是一种生成器，它生成一个包含构建时上下文环境变量的 conanbuildenv .bat、.ps1 或 .sh 脚本

• 来自“构建”上下文中直接 tool_requires 的 self.buildenv_info。

• 来自这些 tool_requires 的传递依赖项的 self.runenv_info。

它可以在 conanfile 中按名称使用

conanfile.py

class Pkg(ConanFile):
    generators = "VirtualBuildEnv"

conanfile.txt

[generators]
VirtualBuildEnv

它也可以在 conanfile 的 generate() 方法中完全实例化

conanfile.py

from conan import ConanFile
from conan.tools.env import VirtualBuildEnv

class Pkg(ConanFile):
    settings = "os", "compiler", "arch", "build_type"
    requires = "zlib/1.2.11", "bzip2/1.0.8"

    def generate(self):
        ms = VirtualBuildEnv(self)
        ms.generate()

生成的文件

此生成器（例如 conan install --tool-require=cmake/3.20.0@ -g VirtualBuildEnv 的调用）将创建以下文件

• conanbuildenv-release-x86_64.(bat|ps1|sh)：此文件包含环境变量（如 PATH、LD_LIBRARY_PATH 等）的实际定义，以及依赖项 buildenv_info 中定义的任何其他变量，这些变量对应于 build 上下文和当前已安装的配置。如果使用其他设置重复调用，则会创建不同的文件。执行或调用此文件后，将生成一个新的停用脚本，捕获当前环境，以便在需要时恢复环境。该文件也将根据当前活动配置命名，例如 deactivate_conanbuildenv-release-x86_64.bat。

• conanbuild.(bat|ps1|sh)：累积对一个或多个其他脚本的调用，如果生成过程中有多个工具创建文件，则提供一个方便的文件供所有工具使用。这仅调用最新的特定配置，也就是说，如果首先为 Release 构建类型调用 conan install，然后为 Debug 调用，则 conanbuild.(bat|ps1|sh) 脚本将调用 Debug 脚本。

• deactivate_conanbuild.(bat|ps1|sh)：累积上述 conanbuild.(bat|ps1|sh) 中定义的停用调用。此文件应仅在累积的激活调用首先被调用后调用。

注意

要创建 PowerShell 所需的 .ps1 文件，必须将以下 conf 设置为 True：tools.env.virtualenv:powershell。

注意

可以通过向 conan install 命令传递 --env-generation=false 来禁用为使用者自动生成这些文件。**此功能处于实验阶段，可能会发生变化**，禁用此文件可能导致意外的构建错误，例如如果使用了 tool_requires。如果禁用了生成，请确保不需要它们。

参考

class VirtualBuildEnv(conanfile, auto_generate=False)

计算构建时上下文的环境变量并生成 conanbuildenv .bat 或 .sh 脚本

environment()

返回一个包含构建上下文环境变量的 Environment 对象。

返回值：

一个包含获取的变量的 Environment 对象实例。

vars(scope='build')

参数：

scope – 要使用的范围。

返回值：

一个包含计算出的环境变量的 EnvVars 实例。

generate(scope='build')

生成启动脚本，激活构建上下文的变量。

参数：

scope – 要使用的范围。