VirtualRunEnv

VirtualRunEnv 是一个生成器，它生成一个启动器 conanrunenv .bat、.ps1 或 .sh 脚本，其中包含运行时环境的环境变量。

启动器包含运行时环境信息，即实际运行编译后的可执行文件和应用程序所需的任何内容。信息来源于

  • 对应于 host 上下文的依赖项的 self.runenv_info。

  • 还可以根据包的 self.cpp_info 定义自动推断以定义 PATH。

  • LD_LIBRARY_PATH、DYLD_LIBRARY_PATH 和 DYLD_FRAMEWORK_PATH 在非 Windows 主机上类似地推断，如果设置了 os 设置。

它可以在 conanfiles 中按名称使用

conanfile.py
class Pkg(ConanFile):
    generators = "VirtualRunEnv"
conanfile.txt
[generators]
VirtualRunEnv

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

conanfile.py
from conan import ConanFile
from conan.tools.env import VirtualRunEnv

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

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

生成的文件

  • conanrunenv-release-x86_64.(bat|ps1|sh)：此文件包含环境变量（如 PATH、LD_LIBRARY_PATH 等）的实际定义，以及对应于 host 上下文和当前已安装配置的依赖项的 runenv_info。如果使用其他设置重复调用，则会创建不同的文件。

  • conanrun.(bat|ps1|sh)：累积对一个或多个其他脚本的调用，以提供一个方便的所有脚本。这仅调用最新的特定配置，也就是说，如果首先针对 Release 构建类型调用 conan install，然后针对 Debug 调用，则 conanrun.(bat|ps1|sh) 脚本将调用 Debug 脚本。

在执行其中一个文件后，将生成一个新的停用脚本，捕获当前环境，以便在需要时恢复环境。文件也根据当前活动配置命名，例如 deactivate_conanrunenv-release-x86_64.bat。

注意

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

注意

可以通过将 --env-generation=false 传递给 conan install 命令来禁用为使用者自动生成这些文件。**此功能处于实验阶段，可能会发生变化**，禁用此文件可能导致意外的运行时错误。

参考

class VirtualRunEnv(conanfile, auto_generate=False)

计算运行时上下文的环境变量并生成 conanrunenv .bat 或 .sh 脚本

参数：

conanfile – 当前配方对象。始终使用 self。

environment()

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

返回值：

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

vars(scope='run')
参数：

scope – 要使用的范围。

返回值：

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

generate(scope='run')

生成启动器脚本，激活运行上下文的变量。

参数：

scope – 要使用的范围。