Lockfile API

警告

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

class LockfileAPI(conan_api)
static get_lockfile(lockfile=None, conanfile_path=None, cwd=None, partial=False, overrides=None) Lockfile

获取 lockfile,遵循以下逻辑

如果 lockfile 被显式定义,它将是绝对路径或相对于 cwd 的路径,并且 lockfile 文件必须存在。如果 lockfile=””(空字符串),即使存在,也不会自动使用默认的 “conan.lock” lockfile。

如果 lockfile 未定义,它仍然会查找默认的 conan.lock

  • 如果定义了 conanfile_path,它将位于其旁边

  • 如果未定义 conanfile_path,默认的 conan.lock 应该位于 cwd 中

  • 如果找不到默认的 conan.lock,则不是错误

参数:
  • partial – 如果获取的 lockfile 将允许部分解析

  • cwd – 当前工作目录,如果为 None,将使用 os.getcwd()

  • conanfile_path – 如果存在,则 conanfile 的完整路径

  • lockfile – lockfile 文件的名称

  • overrides – 重写字典 {overriden: [new_ref1, new_ref2]}