管理包元数据文件¶

警告

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

Conan 包通常由多个 C 和 C++ 工件、头文件、编译好的库和可执行文件组成。但也有其他文件可能对于正常使用此类包并非必需，但由于合规性、技术或业务原因可能非常重要，例如

完整的构建日志
测试可执行文件
运行测试套件的测试结果
调试工件，例如大型 .pdb 文件
覆盖率、 sanitizers 或其他源或二进制分析工具的结果
关于构建、具体机器、环境、作者、CI 数据的上下文和元数据
其他合规性和安全相关文件

存储和跟踪这些文件有几个重要原因，例如法规、合规性、安全性、可重现性和可追溯性。这些文件的问题在于它们可能很大/很重，如果我们将它们存储在包内（仅在 package() 方法中复制工件），这将使包体积大得多，并会影响包的下载、解压和整体使用速度。这种情况通常会发生很多次，无论是在开发人员机器上还是在 CI 中，并且可能影响开发人员体验和基础设施成本。此外，包是不可变的，也就是说，一旦创建了包，就不应该修改它。如果我们在创建包之后，甚至在上传包之后，想要添加额外的元数据文件，这可能会成为一个问题。

元数据文件功能允许以集成和统一的方式创建、上传、追加和存储与包相关的元数据，同时避免影响开发人员和 CI 的速度和成本，因为默认情况下，在使用包时不会下载和解压元数据文件。

重要的是要强调元数据有两种类型

Recipe 元数据，与 conanfile.py recipe 相关联，元数据应该对于从该 recipe 创建的所有二进制文件（包名称、版本和 recipe revision）都是通用的。这种元数据可能不太常见，但例如对源代码进行某些扫描的结果（对于所有配置和构建都是通用的）可以作为 recipe 元数据。
包二进制元数据，与特定配置的包二进制文件相关联，由 package_id 表示。特定于二进制配置的构建日志、测试报告等将是包元数据。

在 Recipes 中创建元数据¶

Recipes 可以直接在其方法中定义元数据。一个常见的用例是存储日志。使用 self.recipe_metadata_folder 和 self.package_metadata_folder，recipe 可以在这些位置存储文件。

import os
from conan import ConanFile
from conan.tools.files import save, copy

class Pkg(ConanFile):
   name = "pkg"
   version = "0.1"

   def layout(self):
      # Or something else, like the "cmake_layout(self)" built-in layout
      self.folders.build = "mybuild"
      self.folders.generators = "mybuild/generators"

   def export(self):
      # logs that might be generated in the recipe folder at "export" time.
      # these would be associated with the recipe repo and original source of the recipe repo
      copy(self, "*.log", src=self.recipe_folder,
           dst=os.path.join(self.recipe_metadata_folder, "logs"))

   def source(self):
      # logs originated in the source() step, for example downloading files, patches or other stuff
      save(self, os.path.join(self.recipe_metadata_folder, "logs", "src.log"), "srclog!!")

   def build(self):
      # logs originated at build() step, the most common ones
      save(self, "mylogs.txt", "some logs!!!")
      copy(self, "mylogs.txt", src=self.build_folder,
           dst=os.path.join(self.package_metadata_folder, "logs"))

注意，“recipe” 方法（对于所有二进制文件通用的方法，例如 export() 和 source()）应该使用 self.recipe_metadata_folder，而“包”特定方法（build(), package()）应该使用 self.package_metadata_folder。

对这个 recipe 执行 conan create 将在 Conan cache 中创建“metadata”文件夹。我们可以使用以下命令查看这些文件夹

$ conan create .
$ conan cache path pkg/0.1 --folder=metadata
# folder containing the recipe metadata
$ conan cache path pkg/0.1:package_id --folder=metadata
# folder containing the specific "package_id" binary metadata

也可以使用“本地流程”命令并获取本地“metadata”文件夹。如果想这样做，强烈建议使用像上面那样的 layout() 方法，以避免弄乱当前文件夹。然后本地命令将允许测试和调试该功能

$ conan source .
# check local metadata/logs/src.log file
$ conan build .
# check local mybuild/metadata/logs/mylogs.txt file

注意：请注意，在执行 conan export-pkg 命令期间，本地创建的元数据不会导出到 Conan cache 中。一些元数据，例如在 export() 方法中生成的元数据，可以在 cache 中生成，因为 conan export-pkg 命令会调用该方法，但“build”文件夹内的元数据不会被导出。如果想将该元数据添加到导出的包中，可以在 conan export-pkg 之后，使用 conan cache path 报告的路径复制它，如下面“使用命令添加元数据”部分所述。

使用 Hooks 创建元数据¶

如果不同 recipes 之间有一些共同的元数据，可以使用 hooks 在不修改 recipes 的情况下捕获它。假设我们有一个更简单的 recipe

import os
from conan import ConanFile
from conan.tools.files import save, copy

class Pkg(ConanFile):
   name = "pkg"
   version = "0.1"
   no_copy_source = True

   def layout(self):
      self.folders.build = "mybuild"
      self.folders.generators = "mybuild/generators"

   def source(self):
      save(self, "logs/src.log", "srclog!!")

   def build(self):
      save(self, "logs/mylogs.txt", "some logs!!!")

如我们所见，这根本没有使用元数据文件夹。现在让我们定义以下 hooks

import os
from conan.tools.files import copy

def post_export(conanfile):
      conanfile.output.info("post_export")
      copy(conanfile, "*.log", src=conanfile.recipe_folder,
         dst=os.path.join(conanfile.recipe_metadata_folder, "logs"))

def post_source(conanfile):
      conanfile.output.info("post_source")
      copy(conanfile, "*", src=os.path.join(conanfile.source_folder, "logs"),
         dst=os.path.join(conanfile.recipe_metadata_folder, "logs"))

def post_build(conanfile):
      conanfile.output.info("post_build")
      copy(conanfile, "*", src=os.path.join(conanfile.build_folder, "logs"),
         dst=os.path.join(conanfile.package_metadata_folder, "logs"))

使用这些 hooks 将产生与 recipe 内方法非常相似的效果：执行 conan create 时，元数据文件将在 cache 中创建，同时也会为 conan source 和 conan build 本地流程创建本地元数据文件。

使用命令添加元数据¶

在创建包之后，可以添加或修改元数据文件。为此，使用 conan cache path 命令将返回执行此操作的文件夹，因此在该位置复制、创建或修改文件即可实现。

$ conan create . --name=pkg --version=0.1
$ conan cache path pkg/0.1 --folder=metadata
# folder to put the metadata, initially empty if we didn't use hooks
# and the recipe didn't store any metadata. We can copy and put files
# in the folder
$ conan cache path pkg/0.1:package_id --folder=metadata
# same as above, for the package metadata, we can copy and put files in
# the returned folder

此元数据是本地添加的，存储在 Conan cache 中。如果想更新服务器元数据，需要从 cache 上传它。

上传元数据¶

到目前为止，元数据已在本地创建并存储在 Conan cache 中。将元数据上传到服务器已与现有的 conan upload 命令集成

$ conan upload "*" -c -r=default
# Uploads recipes, packages and metadata to the "default" remote
...
pkg/0.1: Recipe metadata: 1 files
pkg/0.1:da39a3ee5e6b4b0d3255bfef95601890afd80709: Package metadata: 1 files

默认情况下，当 recipe 或包上传到服务器时，conan upload 将上传 recipe 和包的元数据。但在某些情况下，如果 Conan 检测到 revisions 在服务器上已存在，它将完全避免此上传，不会上传 recipes 或包。如果元数据已在本地修改或添加了新文件，我们可以使用以下命令强制显式上传

# We added some metadata to the packages in the cache
# But those packages already exist in the server
$ conan upload "*" -c -r=default --metadata="*"
...
pkg/0.1: Recipe metadata: 1 files
pkg/0.1:da39a3ee5e6b4b0d3255bfef95601890afd80709: Package metadata: 1 files

参数 --metadata 允许指定要上传的元数据文件。如果我们将它们组织在文件夹中，可以指定 --metadata="logs*" 来仅上传日志元数据，而不上传其他可能的元数据，例如 test 元数据。

# Upload only the logs metadata of the zlib/1.2.13 binaries
# This will upload the logs even if zlib/1.2.13 is already in the server
$ conan upload "zlib/1.2.13:*" -r=remote -c --metadata="logs/*"
# Multiple patterns are allowed:
$ conan upload "*" -r=remote -c --metadata="logs/*" --metadata="tests/*"

有时，即使元数据 cache 文件夹包含文件，也可能需要上传包而不上传元数据。要忽略上传元数据，请使用空参数作为元数据模式

# Upload only the packages, not the metadata
$ conan upload "*" -r=remote -c --metadata=""

不允许混合使用 --metadata="" 和 --metadata="*"，这将引发错误。

# Invalid command, it will raise an error
$ conan upload "*" -r=remote -c --metadata="" --metadata="logs/*"
ERROR: Empty string and patterns can not be mixed for metadata.

下载元数据¶

如上所述，元数据默认不会下载。当使用 conan install 或 conan create 从服务器获取依赖项下载包时，不会下载这些服务器的元数据。

从服务器恢复元数据的方法是使用 conan download 命令显式指定

# Get the metadata of the "pkg/0.1" package
$ conan download pkg/0.1 -r=default --metadata="*"
...
$ conan cache path pkg/0.1 --folder=metadata
# Inspect the recipe metadata in the returned folder
$ conan cache path pkg/0.1:package_id --folder=metadata
# Inspect the package metadata for binary "package_id"

元数据的检索是按包通过 download 完成的。如果想下载整个依赖图的元数据，需要使用“package-lists”

$ conan install . --format=json -r=remote > graph.json
$ conan list --graph=graph.json --format=json > pkglist.json
# the list will contain the "remote" origin of downloaded packages
$ conan download --list=pkglist.json --metadata="*" -r=remote

注意，“package-list”只包含与“remote”源相关的已下载包。如果它们之前已存在于 cache 中，则不会列在“remote”源下，也不会下载元数据。如果想收集依赖项元数据，请记住在从服务器安装包时下载它。还有其他可能性，例如可以自动从服务器收集和下载依赖项元数据的自定义命令。

删除元数据¶

目前无法使用 Conan 从服务器端删除元数据，因为元数据是“附加的”，可以添加新数据，但不能删除（否则，在不先下载所有之前的元数据的情况下将无法添加新元数据，这会非常低效且更容易出错，尤其对可能的竞态条件很敏感）。

建议从服务器端删除元数据的方法是使用服务器可能提供的工具、Web 界面或 API。

注意

最佳实践

使用包时元数据不应是必需的。应该可以在不下载元数据的情况下使用 recipes 和包。如果元数据对于使用包是强制性的，那么它就不是元数据，应该打包为头文件和二进制文件。
读取元数据的操作不应频繁发生，也不应是开发人员必须执行的操作。读取元数据是为了应对特殊情况，例如需要恢复某些构建日志以满足合规性要求，或者需要某些测试可执行文件来调试或重新检查崩溃。
Conan 不会对元数据文件进行任何压缩或解压缩。如果元数据文件很多，请考虑自行压缩，否则上传大量文件可能需要很长时间。如果需要处理不同类型的元数据（日志、测试、报告），最好按类别压缩文件，以便能够使用 --metadata=xxx 参数进行过滤。

将 test_package 作为元数据¶

这是一个说明性的元数据使用示例，将整个 test_package 文件夹存储为元数据，以便以后恢复和执行它。请注意，这不一定适用于生产环境。

让我们从一个 hook 开始，它自动将 test_package 文件夹存储为 recipe 元数据

import os
from conan.tools.files import copy

def post_export(conanfile):
   conanfile.output.info("Storing test_package")
   folder = os.path.join(conanfile.recipe_folder, "test_package")
   copy(conanfile, "*", src=folder,
         dst=os.path.join(conanfile.recipe_metadata_folder, "test_package"))

请注意，此 hook 没有考虑 test_package 可能充满大量临时构建对象而很脏（在添加到元数据之前应该清理），并且它没有检查 test_package 是否可能完全不存在而导致崩溃。

创建并上传包时，它会将包含 test_package 的 recipe 元数据上传到服务器

$ conan create ...
$ conan upload "*" -c -r=default  # uploads metadata
...
pkg/0.1: Recipe metadata: 1 files

让我们删除本地副本，并假设包已安装，但元数据未安装

$ conan remove "*" -c  # lets remove the local packages
$ conan install --requires=pkg/0.1 -r=default  # this will not download metadata

如果在此阶段安装的包在我们的应用程序中失败，我们可以恢复 test_package，将其下载，然后复制到当前文件夹

$ conan download pkg/0.1 -r=default --metadata="test_package*"
$ conan cache path pkg/0.1 --folder=metadata
# copy the test_package folder from the cache, to the current folder
# like `cp -R ...`

# Execute the test_package
$ conan test metadata/test_package pkg/0.1
pkg/0.1 (test package): Running test()

另请参阅

TODO：使用一些自定义部署器或命令收集完整依赖图元数据的示例

这是一项实验性功能。我们期待听到您的反馈、使用案例和需求，以便不断改进此功能。请在 Github issues 中报告。