FAQ

另请参阅

Conan 背后有一个强大的社区,用户在 Cpplang Slack 中互相帮助。请加入我们的 #conan 频道!

问题排查

错误:缺少预编译包

当安装包时(使用 conan installconan create),您可能会收到如下错误

ERROR: Missing binary: zlib/1.2.11:b1d267f77ddd5d10d06d2ecf5a6bc433fbb7eeed

zlib/1.2.11: WARN: Can't find a 'zlib/1.2.11' package binary 'b1d267f77ddd5d10d06d2ecf5a6bc433fbb7eeed' for the configuration:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu11
compiler.libcxx=libc++
compiler.version=14
os=Macos
[options]
fPIC=True
shared=False

ERROR: Missing prebuilt package for 'zlib/1.2.11'. You can try:
    - List all available packages using 'conan list "{ref}:*" -r=remote'
    - Explain missing binaries: replace 'conan install ...' with 'conan graph explain ...'
    - Try to build locally from sources using the '--build=zlib/1.2.11' argument

More Info at 'https://docs.conan.org.cn/en/2/knowledge/faq.html#error-missing-prebuilt-package'

这意味着包配方 zlib/1.2.11 存在,但由于某些原因,没有适用于您当前设置或选项的预编译包。可能是包创建者根本没有构建和共享预编译包,而只上传了包配方,或者他们只为某些平台或编译器提供包。例如,包创建者从配方为 apple-clang 11 构建了包,但您正在使用 apple-clang 14。您可能还需要检查您的包 ID 模式,因为它可能会影响可用的包。

默认情况下,Conan 不从源代码构建包。有几种方法可以克服此错误

  • 您可以尝试从源代码为您的设置构建包,指示一些构建策略作为参数,例如 --build zlib*--build missing。如果包配方和源代码适用于您的设置,您将在本地构建好二进制文件并准备使用。

  • 如果从源代码构建失败,并且您正在使用 conancenter 远程仓库,您可以在 Conan Center Index 仓库 中打开一个 issue

错误:无效设置

有时可能会发生这种情况,当您指定的设置不在默认值中时,您会收到如下消息

$ conan install . -s compiler.version=4.19 ...

ERROR: Invalid setting '4.19' is not a valid 'settings.compiler.version' value.
Possible values are ['4.4', '4.5', '4.6', '4.7', '4.8', '4.9', '5.1', '5.2', '5.3', '5.4', '6.1', '6.2']

这并不意味着 Conan 不支持这样的编译器版本,只是它不存在于实际的默认设置中。您可以在用户主文件夹 ~/.conan2/settings.yml 中找到一个设置文件,您可以修改、编辑、添加任何设置或任何值,并在必要时进行任何嵌套。请参阅 settings.yml 以了解如何自定义设置,以随意建模您的二进制文件。

只要您的团队或用户具有相同的设置(settings.ymlsettings_user.yml 可以通过 conan config install 命令轻松共享),一切都将正常工作。settings.yml 文件只是一个机制,让用户就典型设置的通用拼写达成一致。此外,如果您认为某些设置对许多其他 conan 用户有用,请将其作为 issue 或 pull request 提交,以便将其包含在未来的版本中。

某些内置的 helper 或集成,如 CMakeCMakeToolchain 可能无法理解新添加的设置,不使用它们,甚至在您向现有设置添加一些新的意外值时失败。像 CMake 这样的 helper 是简单的实用程序,用于将 conan 设置转换为相应的构建系统语法和命令行参数,因此它们可以扩展或替换为您自己的 helper,以处理您自己的私有设置。

错误:AuthenticationException:

如果来自 conan 的 HTTP 请求中没有或错误的身份验证凭据,则可能会发生此错误。要获取更多信息,请尝试启用 HTTP 连接的调试级别

import http.client
http.client.HTTPConnection.debuglevel = 1

一个错误来源可能是 .netrc 文件,它被 requests 库 识别。

错误:在 Linux 和 Windows 中获取不同的修订版本

Git 将(默认情况下)在 Windows 系统中使用 CRLF 行尾检出文件,有效地生成与 Linux 中使用 LF 行尾的文件不同的文件。由于文件不同,Conan 配方修订版本将与在 Linux 等其他平台中计算的修订版本不同,从而导致在其他修订版本中缺少相应的二进制文件。

Conan 不会规范化或以任何方式更改源文件,这不是它的责任,并且存在破坏事物的风险。源代码控制是更改文件的应用程序,因此这是处理此问题的更正确的位置。有必要指示 Git 使用相同的行尾执行检出。这可以通过多种方式完成,例如,通过向项目仓库添加 .gitattributes 文件

[auto]
  crlf = false

另一种方法是更改 .gitconfig 以全局更改它。Windows 中的现代编辑器(甚至记事本)也可以完美地处理带有 LF 的文件,不再需要更改行尾。

在 conanfile.py 配方中为依赖项定义选项不起作用

Conan 深度优先扩展依赖关系图,这对于实现许多非常特殊的 C/C++ 传播逻辑(头文件、静态和共享库、应用程序、tool-requires、test-requires、冲突、覆盖等)非常重要。

这意味着当 conanfile.py 声明如下内容时

class MyPkg(ConanFile):
    name = "mypkg"
    version = "0.1"
    default_options = {"zlib/*:shared": True}
    # Or
    def requirements(self):
        self.requires("zlib/1.3", options={"shared": True})

它可能并非总是被遵守,并且 zlib 依赖项最终可能会具有不同的 shared=False 选项值。这种在配方中为依赖项定义的选项值仅在以下情况下有效

  • 图中没有其他包依赖于 zlib

  • 图中有其他包依赖于 zlib,但 mypkg/0.1 是第一个 require(依赖关系图中的第一个分支)被需要的。这意味着 requires = "mypkg/0.1", "zlib/1.3" 将起作用,并且 zlib 将被共享,但 requires = "zlib/1.3", "mypkg/0.1" 将首先扩展具有默认值 shared=Falsezlib,而当计算 mypkg/0.1 时,更改 zlibshared=True 将为时已晚。

如果某些配方在依赖项的某些选项下根本无法工作,建议在配方中定义一个 validate() 方法,以保证如果由于某种原因上游依赖项没有正确的选项值,它将引发错误。

Conan 可能会在 Conan 命令的输出中显示一些(不保证是详尽的)这些问题,请仔细阅读。

Options conflicts
    liba/0.1:myoption=1 (current value)
        libc/0.1->myoption=2
    It is recommended to define options values in profiles, not in recipes

一般来说,更推荐在 profile 文件中定义选项值,而不是在配方中。配方定义的选项始终优先于 profile 中定义的选项。

即使使用版本范围也遇到版本冲突

安装依赖项时,可能会出现版本冲突错误消息,例如

...
Version conflict: Conflict between math/1.0.1 and math/1.0 in the graph

这个关于版本冲突的教程 总结了同一个包依赖的不同版本如何在依赖关系图中冲突,以及如何解决这些冲突。

但是,在某些情况下,冲突并不那么明显,例如,当存在一些混合的版本范围和固定依赖项时,例如

def requirements(self):
  self.requires("libb/1.0")  # requires liba/[>=1.0 <2]
  self.requires("libc/1.0")  # requires liba/1.0

并且发生 libb/1.0liba/[>=1.0 <2] 有传递性需求,而 libc/1.0 需要 liba/1.0,并且存在 liba/1.1 或更高的包。在这种情况下,Conan 也可能抛出“版本冲突”错误。

根本原因是解决版本范围在图中定义的所有可能约束的联合兼容性是一个已知的 NP-hard 问题,称为 SAT 求解器。在 Conan 中评估此 NP-hard 问题中的每个假设都非常昂贵,因为它通常需要在所有定义的远程仓库中查找版本/修订版本,然后下载此类版本/修订版本的压缩文件,解压缩它们,加载并 Python 解析和评估它们,最后执行所有图形计算处理,这涉及在已扩展的图形中完全向下传播,以传播可能产生冲突的 C/C++ 需求特征。这将使问题在实践中变得棘手,这将需要等待数小时才能完成。

因此,Conan 没有这样做,而是使用了一种“贪婪”算法,该算法不需要回溯,但仍会尝试在可能的情况下协调版本范围和固定版本。关于这一点,最重要的是要知道 Conan 实现了“深度优先”图形扩展,按照声明的顺序评估 requires。了解这一点可以帮助解决此冲突。在上面的例子中,错误发生是因为首先扩展 libb/1.0,它找到对 liba/[>=1.0 <2] 的需求,并且由于之前没有找到对 liba 的其他约束,因此它自由地解析为最新的 liba/1.1。当稍后扩展 libc/1.0 时,它找到对 liba/1.0 的需求,但为时已晚,因为它将与之前的 liba/1.1 冲突。回到之前的假设是“回溯”部分,它将问题转换为 NP-hard 问题,因此算法在那里停止并引发冲突。

这可以通过交换 requires 的顺序来解决

def requirements(self):
  self.requires("libc/1.0")  # requires liba/1.0
  self.requires("libb/1.0")  # requires liba/[>=1.0 <2]

如果首先扩展 libc/1.0,它将解析为 liba/1.0。当稍后扩展 libb/1.0 时,其传递性需求 liba/[>=1.0 <2] 可以通过之前的 libb/1.0 成功满足,因此它可以成功解析图形。

一般的最佳实践是

  • 对于同一个依赖项,尝试在所有地方使用相同的方法:对该特定依赖项在所有地方使用版本范围,或在所有地方使用固定版本。

  • 保持版本对齐。如果使用版本范围,请尝试在所有地方使用相同的版本范围。

  • 首先声明使用固定版本的依赖项,而不是版本范围

  • 使用 conan graph info ... --format=html > graph.html 图形交互式输出,以理解和导航冲突。