VirtualRunEnv¶

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

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

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

此外，还会从包的 self.cpp_info 定义中自动推断出 PATH。

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

它可以在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 已被弃用，不应再使用。

注意

要创建 .env dotenv 文件，请使用 **实验性**（Conan 2.21 新增）tools.env:dotenv 配置。这些文件不打算作为脚本激活，而是由 IDE 等工具加载。将生成特定于配置的文件，例如 conanrunenv-Release.env，因为 Release 和 Debug 配置的环境可能不同。目前，由于某些 VScode 限制，这些文件不使用变量插值，会打印警告指向 https://github.com/microsoft/vscode-cpptools/issues/13781 以跟踪进度。请在 Github 上提交工单以报告有关此功能的任何反馈。

注意

可以通过将 --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 – 要使用的范围。