VirtualRunEnv

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

该启动器包含运行时环境信息，即实际运行编译后的可执行文件和应用程序所需的环境信息。这些信息来自：

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

  • 以及从包的 self.cpp_info 定义中自动推导出的 PATH。

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

它可以在 conanfile 中通过名称使用

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 文件，您需要将 tools.env.virtualenv:powershell 配置设置为 PowerShell 可执行文件的值（例如，powershell.exe 或 pwsh）。请注意，从 Conan 2.11.0 开始，将其设置为 True 或 False 已弃用，不应再使用。

注意

通过将 --env-generation=false 参数传递给 conan install 命令，可以禁用为消费者自动生成这些文件。此功能是实验性的，可能会发生变化，禁用此文件可能导致意外的运行时错误。

参考

class VirtualRunEnv(conanfile, auto_generate=False)

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

参数：

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

environment()

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

返回：

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

vars(scope='run')
参数：

scope – 要使用的作用域。

返回：

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

generate(scope='run')

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

参数：

scope – 要使用的作用域。