finalize()

警告

此功能是实验性的，可能会有重大更改。 有关更多信息，请参见 Conan 稳定性 部分。

包的不可变性是 Conan 中的一个重要概念。 它确保包在构建和打包后不会被修改，以便包 ID 是一致的，并且可以在不同的机器上重用该包。

此方法旨在自定义运行机器上的包，允许修改包，以供包的使用者使用，但不会修改 Conan 缓存中的原始包。 此方法在包已安装在本地缓存中之后调用，并且修改不会上传到任何远程服务器，它们仅是本地的。

此方法的主要用例包括

• 拥有不同的包，这些包在运行时会被修改（例如，python 工具，这些工具会在执行过程中生成 pycache 文件）

• 修改包以在本地机器中使用（例如，创建一个 conf 文件，其中包含包在本地机器中使用的必需环境变量）

这些更改对于包的使用者是透明的，他们将使用自定义的包，就像他们处理原始包一样，因此在此方法中所做的更改应该有效。

finalize() 用法示例

此方法最常见的用例是避免破坏包的不可变性。

例如，如果一个包在其执行过程中生成一些文件，例如生成 pycache 文件的 python 包，则可以使用此方法在本地机器上生成这些文件，而不会影响原始包。 Meson 等工具就是这种情况。

from conan import ConanFile, conan_version
from conan.tools.files import copy


class MesonPackage(ConanFile):
    ...

    def package(self):
        copy(self, "*", src=self.source_folder, dst=os.path.join(self.package_folder, "bin"))
        ...

    def finalize(self):
        copy(self, "*", src=self.immutable_package_folder, dst=self.package_folder)

在这里，我们将文件从不可变的包文件夹复制到最终确定的包文件夹，最终确定方法（以及此后的任何地方）内部将是新的包文件夹，以便包所做的任何修改都在本地最终确定的文件夹中完成，而不会影响原始包。

对于需要访问原始包的情况，immutable_package_folder 属性在同一 recipe 的 self.immutable_package_folder 和通过依赖项 recipe 中的 self.dependencies[<package_name>].immutable_package_folder 属性都可用。此信息也会作为图形信息的一部分序列化在 conan graph info 等中。

由于此方法必须与生成的包 ID 具有一对一的对应关系，因此禁止在 finalize() 方法内访问 self.settings、self.options 和 self.cpp_info，并且必须通过 self.info 属性完成。

注意

如果不使用这种方法，该包将在包文件夹中生成 pycache 文件，因此需要设置 PYTHONDONTWRITEBYTECODE 以避免改变该包，但这会影响性能，并且通过 conan cache check-integrity 执行缓存完整性检查，或者作为 conan upload ... --check 中的上传过程的一部分，如果曾经检查过修改后的包，则会引发错误。

警告

这不是 post_package hook 的替代品。 该 hook 在创建包后运行，有机会在计算 package_id 之前对其进行修改，但它并不用于修改特定运行机器的包。