环境¶

Environment 是一个通用类，用于定义对环境变量的修改。该类被其他工具使用，例如 conan.tools.gnu 中的 Autotools 助手以及 VirtualBuildEnv 和 VirtualRunEnv 生成器。需要强调的是，这是一个通用类，要使用它，需要从它那里获得一个针对当前上下文（shell 脚本、bat 文件、路径分隔符等）的特化版本，即一个 EnvVars 对象。

变量声明¶

from conan.tools.env import Environment

def generate(self):
    env = Environment()
    env.define("MYVAR1", "MyValue1")  # Overwrite previously existing MYVAR1 with new value
    env.append("MYVAR2", "MyValue2")  # Append to existing MYVAR2 the new value
    env.prepend("MYVAR3", "MyValue3") # Prepend to existing MYVAR3 the new value
    env.remove("MYVAR3", "MyValue3")  # Remove the MyValue3 from MYVAR3
    env.unset("MYVAR4")               # Remove MYVAR4 definition from environment

    # And the equivalent with paths
    env.define_path("MYPATH1", "path/one")  # Overwrite previously existing MYPATH1 with new value
    env.append_path("MYPATH2", "path/two")  # Append to existing MYPATH2 the new value
    env.prepend_path("MYPATH3", "path/three") # Prepend to existing MYPATH3 the new value

“普通”变量（使用 define、append 和 prepend 声明的变量）默认会用一个空格附加，但可以提供 separator 参数来定义一个自定义的分隔符。

“路径”变量（使用 define_path、append_path 和 prepend_path 声明的变量）将使用默认的系统路径分隔符附加，可以是 : 或 ;，但它也允许定义使用哪个分隔符。

生成环境变量文件¶

环境变量脚本文件（如 envfile.bat|.sh|.ps1|.env）的生成可以通过 EnvVars 类间接完成，该类可以通过以下方式获得：

from conan.tools.env import Environment

env1 = Environment()
...
envvars = env1.vars(self)  # An EnvVars object
# Generate a .bat|.sh|.ps1|.env file depending on current
# settings and Conan configuration
envars.save_script("mybuild")
# or decide to be explicit and generate some of the files:
envvars.save_dotenv("myenv.env")

这些文件也可以被后续的 self.run() 调用自动使用。有关更多信息，请参阅 EnvVars 类文档。

组合¶

环境可以组合

from conan.tools.env import Environment

env1 = Environment()
env1.define(...)
env2 = Environment()
env2.append(...)

env1.compose_env(env2) # env1 has priority, and its modifications will prevail

获取环境变量¶

您可以通过 vars() 方法获取一个 EnvVars 对象，如下所示：

from conan.tools.env import Environment

def generate(self):
    env = Environment()
    env.define("MYVAR1", "MyValue1")
    envvars = env.vars(self, scope="build")
    # use the envvars object

默认的 scope 等于 "build"，这意味着如果这个 envvars 生成一个激活变量的脚本，该脚本将自动添加到 conanbuild.sh|bat 文件中，以方便用户和配方。Conan 生成器使用 build 和 run 作用域，但也有可能管理其他作用域。

环境定义¶

还有一些其他地方可以定义和使用 Environment：

在配方的 package_info() 方法中，新的 self.buildenv_info 和 self.runenv_info，这些环境将通过 VirtualBuildEnv 和 VirtualRunEnv 分别传播给依赖于此配方的包。
在 AutootoolsDeps、AutotoolsToolchain 等生成器中，它们需要为当前配方定义环境。
在配置文件的 [buildenv] 部分。
在配置文件的 [runenv] 部分。

在 package_info() 中的定义如下，考虑到 self.buildenv_info 和 self.runenv_info 都是 Environment() 类的对象。

from conan import ConanFile

class App(ConanFile):
    name = "mypkg"
    version = "1.0"
    settings = "os", "arch", "compiler", "build_type"

    def package_info(self):
        # This is information needed by consumers to build using this package
        self.buildenv_info.append("MYVAR", "MyValue")
        self.buildenv_info.prepend_path("MYPATH", "some/path/folder")

        # This is information needed by consumers to run apps that depends on this package
        # at runtime
        self.runenv_info.define("MYPKG_DATA_DIR", os.path.join(self.package_folder,
                                                               "datadir"))

参考¶

class Environment¶

用于定义环境变量修改的通用类。

dumps()¶

返回:: 包含配置文件的原始定义格式的字符串，而非完整的环境变量值。

define(name, value, separator=' ')¶

使用 value 定义 name 环境变量。

参数:

name – 变量的名称
value – 环境变量将采用的值
separator – 用于分隔附加或前置值的字符

unset(name)¶

清除变量，相当于 unset 或 set XXX=。

参数:: name – 要取消设置的变量的名称

append(name, value, separator=None)¶

将 value 附加到环境变量 name。

参数:

name – 要附加新值的变量的名称
value – 新值
separator – 用于将附加值与先前值分隔的字符。默认情况下，它将使用空格。

append_path(name, value)¶

类似于“append”方法，但表明该变量是文件系统路径。它将根据操作系统自动处理路径分隔符。

参数:

name – 要附加新值的变量的名称
value – 新值

prepend(name, value, separator=None)¶

将 value 添加到环境变量 name 的前面。

参数:

name – 要前置新值的变量的名称
value – 新值
separator – 用于将前置值与先前值分隔的字符

prepend_path(name, value)¶

类似于“prepend”方法，但表明该变量是文件系统路径。它将根据操作系统自动处理路径分隔符。

参数:

name – 要前置新值的变量的名称
value – 新值

remove(name, value)¶

从变量 name 中移除 value。

参数:

name – 变量的名称
value – 要移除的值。

compose_env(other)¶

将一个 Environment 对象与另一个组合。 self 具有优先权，如果可能且不冲突，则“other”将被添加/附加，但 self 规定了操作方式。如果 self 中存在没有占位符的 define()，那么它将保持不变。

参数:: other (class:Environment) – “另一个” Environment 对象

vars(conanfile, scope='build')¶

参数:

conanfile – conanfile 的实例，通常在配方中是 self。
scope – 确定已声明变量的作用域。

返回:

来自当前 Environment 对象的 EnvVars 对象。

deploy_base_folder(package_folder, deploy_folder)¶: 使路径相对于 deploy_folder。