EnvVars¶

EnvVars 是一个类，表示给定系统的环境变量实例。它从通用的 Environment 类中获取。

这个类被其他工具使用，例如 conan.tools.gnu 自动工具助手以及 VirtualBuildEnv 和 VirtualRunEnv 生成器。

创建环境文件¶

EnvVars 对象可以生成环境文件（shell、bat 或 powershell 脚本）

def generate(self):
    env1 = Environment()
    env1.define("foo", "var")
    envvars = env1.vars(self)
    envvars.save_script("my_env_file")

尽管它可能在其他方法中使用，但此功能旨在在 generate() 方法中工作。

它将自动为 Windows 系统生成 my_env_file.bat，否则生成 my_env_file.sh。

可以通过使用配置 tools.env.virtualenv:powershell 来选择生成 PowerShell .ps1 脚本而不是 .bat 脚本。此配置应设置为所需 PowerShell 可执行文件的相应值：对于 5.1 及以下版本为 powershell.exe，对于 PowerShell 7 及以上版本为 pwsh。请注意，自 Conan 2.11.0 起，将 tools.env.virtualenv:powershell 设置为 True 或 False 已被弃用。

您还可以在 tools.env.virtualenv:powershell 配置中包含额外的参数。例如，您可以通过将参数作为配置值的一部分来将其值设置为 powershell.exe -NoProfile 或 pwsh -NoProfile。执行生成的 .ps1 启动器时会考虑这些参数。

此外，默认情况下，Conan 会自动将该启动器文件路径附加到一个列表中，该列表将用于创建一个 conanbuild.bat|sh|ps1 文件，按顺序聚合所有启动器。conanbuild.sh|bat|ps1 启动器将在 generate() 方法执行后创建。

scope 参数（默认为 "build"）可用于定义不同范围的环境文件，以便单独聚合它们。例如，使用 scope="run"，就像 VirtualRunEnv 生成器那样，将聚合并创建 conanrun.bat|sh|ps1 脚本。

def generate(self):
    env1 = Environment()
    env1.define("foo", "var")
    envvars = env1.vars(self, scope="run")
    # Will append "my_env_file" to "conanrun.bat|sh|ps1"
    envvars.save_script("my_env_file")

您也可以使用 scope=None 参数来避免将脚本附加到聚合的 conanbuild.bat|sh|ps1 中。

env1 = Environment()
env1.define("foo", "var")
# Will not append "my_env_file" to "conanbuild.bat|sh|ps1"
envvars = env1.vars(self, scope=None)
envvars.save_script("my_env_file")

使用环境文件运行¶

conanbuild.bat|sh|ps1 启动器将在调用每个 self.run() 命令之前默认执行。这通常在 build() 方法中完成。

您可以使用 self.run() 的 env 参数更改默认启动器。

...
def build(self):
    # This will automatically wrap the "foo" command with the correct environment:
    # source my_env_file.sh && foo
    # my_env_file.bat && foo
    # powershell my_env_file.ps1 ; cmd c/ foo
    self.run("foo", env=["my_env_file"])

应用环境变量¶

作为运行命令的替代方法，可以在 Python 环境中应用环境变量。

from conan.tools.env import Environment

env1 = Environment()
env1.define("foo", "var")
envvars = env1.vars(self)
with envvars.apply():
   # Here os.getenv("foo") == "var"
   ...

遍历变量¶

您可以像这样遍历 EnvVars 对象的环境变量：

env1 = Environment()
env1.append("foo", "var")
env1.append("foo", "var2")
envvars = env1.vars(self)
for name, value in envvars.items():
    assert name == "foo":
    assert value == "var var2"

环境变量在系统中当前的值会替换返回的值。当变量被附加或前置时会发生这种情况。如果需要占位符而不是实际值，可以使用具有 Jinja 模板语法的 variable_reference 参数，这样将返回一个带有该解析模板的字符串。

env1 = Environment()
env1.append("foo", "var")
envvars = env1.vars(self)
for name, value in envvars.items(variable_reference="$penv{{{name}}}""):
    assert name == "foo":
    assert value == "$penv{{foo}} var"

警告

在 Windows 中，环境变量的大小有限制，整个环境总共 32K，但特别是 PATH 变量有 2048 个字符的限制。这意味着上述实用工具可能会达到这个限制，例如在大型依赖图中，所有包都贡献了 PATH 环境变量。

这可以通过以下方式缓解：

将 Conan 缓存移近 C:/ 以缩短路径
更好地定义哪些依赖项可以贡献 PATH 环境变量
对于像运行许多共享库依赖项（包含太多 .dll 文件）这样的情况，可以使用其他机制，例如 deployers

参考¶

class EnvVars(conanfile, values, scope)¶

表示给定系统的环境变量实例。它从通用 Environment 类中获取。

get(name, default=None, variable_reference=None)¶

获取环境变量的值

参数:

name – 环境变量的名称。
default – 如果变量不存在，返回的值，默认为 None。
variable_reference – 如果指定，使用变量引用而不是环境变量的预存值，其中 {name} 可用于指代变量的名称。

items(variable_reference=None)¶

返回 {str: str} (变量名: 值)

参数:: variable_reference – 如果指定，使用变量引用而不是环境变量的预存值，其中 {name} 可用于指代变量的名称。

apply()¶: 上下文管理器，用于将声明的变量应用到当前的 os.environ，并在上下文结束时恢复原始环境。

save_script(filename)¶

保存一个脚本文件（bat、sh、ps1），其中包含一个设置环境的启动器。如果配置 "tools.env.virtualenv:powershell" 不是空字符串，则在 Windows 系统中将生成 powershell 启动器。

参数:: filename – 要生成的文件名。如果提供了扩展名，它将为该扩展名生成启动器脚本；否则，将通过检查是否在 Windows（同时检查子系统）中运行来推断格式。