conan lock add

$ conan lock add -h
Migration: Successfully updated settings.yml
usage: conan lock add [-h] [--out-file OUT_FILE] [-v [V]] [-cc CORE_CONF]
                      [--requires REQUIRES] [--build-requires BUILD_REQUIRES]
                      [--python-requires PYTHON_REQUIRES]
                      [--config-requires CONFIG_REQUIRES]
                      [--lockfile-out LOCKFILE_OUT] [--lockfile LOCKFILE]

Add requires, build-requires or python-requires to an existing or new
lockfile. The resulting lockfile will be ordered, newer versions/revisions
first. References can be supplied with and without revisions like "--
requires=pkg/version", but they must be package references, including at least
the version, and they cannot contain a version range.

options:
  -h, --help            show this help message and exit
  --out-file OUT_FILE   Write the output of the command to the specified file
                        instead of stdout.
  -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
  --requires REQUIRES   Add references to lockfile.
  --build-requires BUILD_REQUIRES
                        Add build-requires to lockfile
  --python-requires PYTHON_REQUIRES
                        Add python-requires to lockfile
  --config-requires CONFIG_REQUIRES
                        Add config-requires to lockfile
  --lockfile-out LOCKFILE_OUT
                        Filename of the created lockfile
  --lockfile LOCKFILE   Filename of the input lockfile

conan lock add 命令能够向现有或新的 lockfile 中的 requires, build_requires, python_requiresconfig_requires 添加包版本。

例如,以下命令能够创建一个 lockfile (默认名称为 conan.lock)

$ conan lock add --requires=pkg/1.1 --build-requires=tool/2.2 --python-requires=mypytool/3.3
Generated lockfile: ...conan.lock

$cat conan.lock
{
    "version": "0.5",
    "requires": [
        "pkg/1.1"
    ],
    "build_requires": [
        "tool/2.2"
    ],
    "python_requires": [
        "mypytool/3.3"
    ]
}

conan lock add 命令也允许提供现有 lockfile 作为输入,它将把参数添加到现有 lockfile 中,同时保持包版本的排序

$ conan lock add --build-requires=tool/2.3 --lockfile=conan.lock
Using lockfile: '.../conan.lock'
Generated lockfile: .../conan.lock

$ cat conan.lock
{
    "version": "0.5",
    "requires": [
        "pkg/1.1"
    ],
    "build_requires": [
        "tool/2.3",
        "tool/2.2"
    ],
    "python_requires": [
        "mypytool/3.3"
    ]
}

conan lock add 命令不对 lockfile、包、包是否存在、包版本是否存在或这些包是否存在于给定依赖关系图中的进行任何检查,它只是对 json 信息进行基本操作。当应用该 lockfile 来解析依赖关系图时,可能添加的版本不存在,或者与 conanfile.py 配方中定义的版本范围不兼容。

此外,版本列表仍然是排序的。如果在配方中包含版本范围 tool/[>=2.0 <3],将像 tool/2.1 这样的旧版本添加到先前的 lockfile 中不会自动使用该版本,因为 tool/2.2 版本已列出,范围将解析到它,而不是旧的 tool/2.1

请注意,使用 conan lock add 创建的 lockfile 可能不完整,不包含完整依赖关系图所需的所有锁定版本。对于这些情况,请记住可以应用 --lockfile-partial 参数。另请注意,如果当前文件夹中存在 conan.lock 文件,conan install 等 Conan 命令将自动使用它。请参阅lockfiles 教程

如果明确添加修订版本,请记住修订版本是按时间戳排序的。如果 lockfile 中存在多个修订版本,则必须提供这些修订版本的时间戳,以便排序有意义,这可以通过以下方式完成:

$ conan lock add --requires=pkg/1.1#revision%timestamp

警告

  • 禁止手动操作 Conan lockfile,更改引用的严格排序,这可能导致任何任意的未定义行为。

  • 请记住,不可能 conan lock add 版本范围。版本可能不完全完整(例如未提供修订版本),但它必须是确切的版本。

注意

最佳实践

在许多情况下,此命令并非必需。现有的 conan install, conan create, conan lock, conan export, conan graph 命令可以直接更新或生成包含它们正在创建的包新信息的 lockfile,并且这些新的或更新的 lockfile 可以用于继续处理。