finalize()

警告

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

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

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

此方法的主要用例包括

• 在运行时会被修改的不同包（例如作为执行一部分生成 pycache 文件的 Python 工具）

• 修改要在本地机器中使用的包（例如创建一个 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)

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

在需要访问原始包的情况下，immutable_package_folder 属性在同一个配方的 self.immutable_package_folder 和依赖配方的 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 钩子的替代品。该钩子在包创建后运行，以便在计算 package_id 之前有机会修改它，但它并非用于修改包以适应特定运行机器。