conan cache

在本地缓存(配方和/或包)中执行文件操作。

conan cache path

$ conan cache path -h
usage: conan cache path [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]
                        [--folder {export_source,source,build,metadata}]
                        reference

Show the path to the Conan cache for a given reference.

positional arguments:
  reference             Recipe reference or Package reference

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  --folder {export_source,source,build,metadata}
                        Path to show. The 'build' requires a package
                        reference. If the argument is not passed, it shows
                        'exports' path for recipe references and 'package'
                        folder for package references.

conan cache path 返回给定引用在缓存中的路径。根据引用,它可能返回配方的路径,或包二进制文件的路径。

假设我们在当前缓存中创建了一个包,如下所示:

$ conan new cmake_lib -d name=pkg -d version=0.1
$ conan create .
...
Requirements
    pkg/0.1#cdc0d9d0e8f554d3df2388c535137d77 - Cache

Requirements
    pkg/0.1#cdc0d9d0e8f554d3df2388c535137d77:2401fa1d188d289bb25c37cfa3317e13e377a351 - Build

现在我们感兴趣的是获取 pkg/0.1 配方 conanfile.py 已导出到的路径

$ conan cache path pkg/0.1
<path to conan cache>/p/5cb229164ec1d245/e

$ ls <path to conan cache>/p/5cb229164ec1d245/e
conanfile.py  conanmanifest.txt

默认情况下,如果未指定配方版本,则表示缓存中的“最新”版本。这也可以通过字面量 #latest 明确表示,还可以明确定义任何配方版本,以下命令等同于上述命令

$ conan cache path pkg/0.1#latest
<path to conan cache>/p/5cb229164ec1d245/e

# The recipe revision might be different in your case.
# Check the "conan create" output to get yours
$ conan cache path pkg/0.1#cdc0d9d0e8f554d3df2388c535137d77
<path to conan cache>/p/5cb229164ec1d245/e

除了配方文件夹之外,还有两个其他文件夹是使用此配方生成的全部二进制文件共有的:“export_source”文件夹和“source”文件夹。两者都可以使用以下命令获取:

$ conan cache path pkg/0.1 --folder=export_source
<path to conan cache>/p/5cb229164ec1d245/es

$ ls <path to conan cache>/p/5cb229164ec1d245/es
CMakeLists.txt  include/  src/

$ conan cache path pkg/0.1 --folder=source
<path to conan cache>/p/5cb229164ec1d245/s

$ ls <path to conan cache>/p/5cb229164ec1d245/s
CMakeLists.txt  include/  src/

在这种情况下,“source”文件夹的内容与“export_source”文件夹的内容相同,因为配方没有实现任何 source() 方法,该方法可以检索代码或对代码执行任何其他操作,例如应用补丁。

配方版本默认将为 #latest,这遵循与上述相同的规则。

请注意,如果包不是从源代码构建的,例如从服务器检索预编译的二进制文件时,这两个文件夹将不存在。

也可以通过提供 package_id 获取二进制包的文件夹

# Your package_id might be different, it depends on the platform
# Check the "conan create" output to obtain yours
$ conan cache path pkg/0.1:2401fa1d188d289bb25c37cfa3317e13e377a351
<path to conan cache>/p/1cae77d6250c23b7/p

$ ls <path to conan cache>/p/1cae77d6250c23b7/p
conaninfo.txt  conanmanifest.txt  include/  lib/

如上所述,默认情况下,它将解析为“最新”配方版本和包版本。上述命令等同于明确定义 #latest 或确切的版本。以下所有命令都等同于上述命令

$ conan cache path pkg/0.1#latest:2401fa1d188d289bb25c37cfa3317e13e377a351
<path to conan cache>/p/1cae77d6250c23b7/p

$ conan cache path pkg/0.1#latest:2401fa1d188d289bb25c37cfa3317e13e377a351#latest
<path to conan cache>/p/1cae77d6250c23b7/p

$ conan cache path pkg/0.1#cdc0d9d0e8f554d3df2388c535137d77:2401fa1d188d289bb25c37cfa3317e13e377a351
<path to conan cache>/p/1cae77d6250c23b7/p

可以访问包含所有临时构建工件的“build”文件夹

$ conan cache path pkg/0.1:2401fa1d188d289bb25c37cfa3317e13e377a351 --folder=build
<path to conan cache>/p/1cae77d6250c23b7/b

ls -al <path to conan cache>/p/1cae77d6250c23b7/b
build/  CMakeLists.txt  CMakeUserPresets.json  conaninfo.txt  include/  src/

同样,“build”文件夹仅在包从源代码构建时才会存在。

注意

最佳实践

  • conan cache path 命令旨在用于缓存的最终检查,但必须将缓存包存储视为**只读**。不要修改、更改、删除或添加缓存中的文件。

  • 如果您正在使用此命令获取工件路径然后复制它们,请考虑改用 deployer。在一般情况下,不建议手动从缓存中提取工件。

  • 开发人员可以使用 conan list ... --format=compact 以紧凑的方式获取完整的引用,这些引用可以复制粘贴到 conan cache path 命令中

conan cache clean

$ conan cache clean -h
usage: conan cache clean [-h] [-v [V]] [-cc CORE_CONF] [-s] [-b] [-d] [-t]
                         [-bs] [-p PACKAGE_QUERY]
                         [pattern]

Remove non-critical folders from the cache, like source, build and/or download
(.tgz store) ones.

positional arguments:
  pattern               Selection pattern for references to clean

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  -s, --source          Clean source folders
  -b, --build           Clean build folders
  -d, --download        Clean download and metadata folders
  -t, --temp            Clean temporary folders
  -bs, --backup-sources
                        Clean backup sources
  -p PACKAGE_QUERY, --package-query PACKAGE_QUERY
                        Remove only the packages matching a specific query,
                        e.g., os=Windows AND (arch=x86 OR compiler=gcc)

此命令将删除所有临时文件夹,以及 Conan 在其执行过程中生成的源代码、构建和下载文件夹。它将对传递到 *pattern* 中的每个匹配引用执行此操作,除非提供了特定的标志,在这种情况下,只会删除指定的文件夹。

示例:

  • 删除所有非关键文件

    $ conan cache clean "*"
    
  • 删除所有临时文件

    $ conan cache clean "*" --temp
    
  • 删除 zlib 配方的下载文件夹

    $ conan cache clean "zlib/*" --download
    
  • 除了 zlib 配方的下载文件夹之外,删除所有内容

    $ conan cache clean "zlib/*" --source --build --temp
    

conan cache check-integrity

$ conan cache check-integrity -h
usage: conan cache check-integrity [-h] [-v [V]] [-cc CORE_CONF]
                                   [-p PACKAGE_QUERY]
                                   pattern

Check the integrity of the local cache for the given references

positional arguments:
  pattern               Selection pattern for references to check integrity
                        for

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  -p PACKAGE_QUERY, --package-query PACKAGE_QUERY
                        Only the packages matching a specific query, e.g.,
                        os=Windows AND (arch=x86 OR compiler=gcc)

conan cache check-integrity 命令检查本地缓存中 Conan 包的完整性。这意味着如果 conanmanifest.txt 中包含的任何文件丢失或与该文件中声明的校验和不匹配,它将抛出错误。

例如,要验证整个 Conan 本地缓存的完整性,请执行以下操作:

$ conan cache check-integrity "*"
mypkg/1.0: Integrity checked: ok
mypkg/1.0:454923cd42d0da27b9b1294ebc3e4ecc84020747: Integrity checked: ok
mypkg/1.0:454923cd42d0da27b9b1294ebc3e4ecc84020747: Integrity checked: ok
zlib/1.2.11: Integrity checked: ok
zlib/1.2.11:6fe7fa69f760aee504e0be85c12b2327c716f9e7: Integrity checked: ok

conan cache backup-upload

$ conan cache backup-upload -h
usage: conan cache backup-upload [-h] [-v [V]] [-cc CORE_CONF]

Upload all the source backups present in the cache

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True

conan cache backup-upload 将把本地缓存中存在的所有源备份上传到备份服务器(不包括从 core.sources:exclude_urls conf 中列出的排除 URL 中获取的备份),无论它们属于哪个包(如果有)。

conan cache save

$ conan cache save -h
usage: conan cache save [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF] [-l LIST]
                        [--file FILE]
                        [pattern]

Get the artifacts from a package list and archive them

positional arguments:
  pattern               A pattern in the form
                        'pkg/version#revision:package_id#revision', e.g:
                        zlib/1.2.13:* means all binaries for zlib/1.2.13. If
                        revision is not specified, it is assumed latest one.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  -l LIST, --list LIST  Package list of packages to save
  --file FILE           Save to this tgz file

从缓存保存和恢复包 中了解更多信息。

conan cache restore

$ conan cache restore -h
usage: conan cache restore [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF] file

Put the artifacts from an archive into the cache

positional arguments:
  file                  Path to archive to restore

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True

从缓存保存和恢复包 中了解更多信息。