VirtualRunEnv¶

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

该启动器包含运行时环境信息，以及在环境中实际运行已编译的可执行文件和应用程序所需的一切。信息来源于：

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

也自动从包的 self.cpp_info 定义中推断，以定义 PATH。

如果设置了 os 设置，则在非 Windows 主机上类似地推断 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.3.1", "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 已弃用，不应再使用。

注意

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

参考¶

类 VirtualRunEnv(conanfile, auto_generate=False)¶

计算运行时环境的环境变量，并生成一个 conanrunenv .bat 或 .sh 脚本

参数:: conanfile – 当前的配方对象。始终使用 self。

environment()¶

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

返回:: 一个 Environment 对象实例，其中包含获取到的变量。

vars(scope='run')¶

参数:: scope – 要使用的作用域。
返回:: 一个 EnvVars 实例，其中包含计算出的环境变量。

generate(scope='run')¶

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

参数:: scope – 要使用的作用域。