管理包元数据文件¶

警告

此功能为实验性功能，可能会有破坏性更改。更多信息请参阅Conan 稳定性部分。

Conan 包通常由几个 C 和 C++ 构件、头文件、编译后的库和可执行文件组成。但还有其他文件，这些文件对于正常使用此类包来说可能不是必需的，但出于合规、技术或业务原因可能非常重要，例如：

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

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

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

需要强调的是，有两种类型的元数据：

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

在配方中创建元数据¶

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

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"))

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

对该配方执行 conan create，将在 Conan 缓存中创建“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 缓存。一些元数据，例如在 export() 方法中生成的元数据，可以在缓存中生成，因为 conan export-pkg 命令会调用该方法，但“build”文件夹内的元数据将不会被导出。如果要将该元数据添加到导出的包中，可以在 conan export-pkg 之后，使用 conan cache path 报告的路径进行复制，如下面的“使用命令添加元数据”部分所述。

使用钩子创建元数据¶

如果跨配方有一些通用元数据，可以不用修改配方，而是使用钩子来捕获它。假设我们有一个更简单的配方：

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!!!")

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

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"))

这些钩子的使用效果与配方内方法非常相似：当 conan create 执行时，元数据文件将在缓存中创建，并且对于 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 缓存中本地添加的。如果要更新服务器元数据，需要从缓存上传。

上传元数据¶

到目前为止，元数据已在本地创建，并存储在 Conan 缓存中。将元数据上传到服务器与现有的 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

默认情况下，当将配方或包上传到服务器时，conan upload 将上传配方和包的元数据。但有些情况下，Conan 会完全避免此上传，如果它检测到修订版已存在于服务器上，它将不会上传配方或包。如果元数据已被本地修改或添加了新文件，我们可以通过以下方式强制显式上传：

# 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/*"

有时，即使元数据缓存文件夹包含文件，也可能希望在不上传元数据的情况下上传包。要忽略上传元数据，请使用空的元数据模式参数：

# 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”源相关的已下载包。如果它们先前已在缓存中，则它们不会在“remote”源下列出，也不会下载元数据。如果要收集依赖项的元数据，请记住在从服务器安装包时下载它。还有其他可能性，例如自定义命令可以自动从服务器收集和下载依赖项的元数据。

删除元数据¶

目前无法从服务器端使用 Conan 删除元数据，因为元数据是“可加的”，可以添加新数据，但不能删除它（否则，在不先下载所有先前元数据的情况下就无法添加新元数据，这可能非常低效且容易出错，特别是容易受到可能的竞争条件的影响）。

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

注意

最佳实践

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

test_package 作为元数据¶

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

让我们从一个钩子开始，该钩子自动将 test_package 文件夹存储为配方元数据。

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"))

请注意，此钩子没有考虑到 test_package 可能包含大量临时构建对象（在添加到元数据之前应该清理它），并且它不检查 test_package 可能根本不存在而导致崩溃。

当创建和上传包时，它会将包含 test_package 的配方元数据上传到服务器。

$ 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()

另请参阅

待办事项：有关如何使用自定义部署器或命令收集完整依赖图的元数据的示例

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