EnvVars¶

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

其他工具会使用此类，例如 conan.tools.gnu 的 autotools 助手以及 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() 方法。

它将自动生成 my_env_file.bat（用于 Windows 系统）或 my_env_file.sh（用于其他系统）。

可以通过配置 tools.env.virtualenv:powershell 来选择生成 PowerShell .ps1 脚本而不是 .bat 脚本。此配置应设置为对应的 PowerShell 可执行文件的值：对于 5.1 及更早版本，使用 powershell.exe；对于从 7 开始的 PowerShell 版本，使用 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 文件，该文件将聚合所有启动器。在 generate() 方法执行后，将创建 conanbuild.sh|bat|ps1 启动器。

可以使用 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")

使用环境变量文件运行¶

默认情况下，将在调用每个 self.run() 命令之前执行 conanbuild.bat|sh|ps1 启动器。这通常在 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) 来设置环境变量。如果 conf “tools.env.virtualenv:powershell” 不是空字符串，它将在 Windows 上生成 powershell 启动器。

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