Conan 笔记

起因

根据conan官方的教程,在执行时

conan create . demo/testing

产生了疑问,好像并没有说明’conan create’是干什么的.
于是上网查阅得知:
conan Export命令是构建之后通过export 命令导出模块到本地仓库，可以在本地为其他项目提供依赖.
也就是官方教程中的这两句:
Copies (“export” in Conan terms) the conanfile.py from the user folder into the local cache. Installs the package, forcing it to be built from the sources.
然后我们可以在本地查看到,Hello文件夹已经出现在了本地缓存中
执行,

$ conan search
Existing package recipes:

Hello/[e-mail]/testing

可以看到Hello已经加入了本地仓库

打包项目

感谢https://blog.csdn.net/lyu00002/article/details/86699175
其实这个官方的教程展现了一个打包的基本过程,那么我们来回顾一下打包项目的过程和原理:
每个包装配方包含本地缓存中的五个重要文件夹：

• export：存储包装配方的文件夹。
• export_source：exports_sources存储使用recipe 属性复制的代码的文件夹。
• source：存储源代码构建源代码的文件夹。
• build：完成源的实际编译的文件夹。每个不同的二进制配置通常会有一个子文件夹
• package：存储最终包工件的文件夹。每个不同的二进制配置将有一个子文件夹。

该源和建立文件夹，只有当包已经从源代码构建的存在。

通过conan export命令或更典型地使用conan create命令“导出”包时，该过程开始。该字段指定的conanfile.py和文件 exports_sources将从用户空间复制到本地缓存。

将export和export_source文件复制到源文件夹，然后source() 执行该方法（如果存在）。请注意，所有二进制包只有一个源文件夹。如果在生成代码时，有不同配置的源代码，则无法使用该source()方法生成，而是需要使用该build()方法生成 。

然后，对于每个不同的设置和选项配置，将为此配置以SHA-1哈希的形式计算包ID。源将被复制到build / hashXXX文件夹，并将build()触发该方法。

之后，package()将调用该方法将构件/ hashXXX 文件夹中的工件复制到package / hashXXX文件夹。

最后，package_info()所有依赖的方法将被调用，聚集这样你就可以产生对消费者构建系统文件，作为conanbuildinfo.cmake的cmake 编译器。此imports功能还会将本地缓存中的工件复制到用户空间（如果已指定）。

简单打包方法

让我们为包装配方创建一个文件夹，并使用conan new命令为我们创建一个模版：

$ mkdir mypkg && cd mypkg
$ conan new Hello/0.1 -t

会给我们生成以下文件

conanfile.py
test_package
  CMakeLists.txt
  conanfile.py
  example.cpp

conanfile.py 中定义了如何打包如何导入源文件。以及项目具体信息。具体conanfile.py里面方法参考：https://docs.conan.io/en/latest/reference/conanfile.html#conanfile-reference

conanfile.py文件内容：

from conans import ConanFile, CMake, tools

class HelloConan(ConanFile):
    name = "Hello"
    version = "0.1"
    license = "<Put the package license here>"
    url = "<Package recipe repository url here, for issues about the package>"
    description = "<Description of Hello here>"
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False]}
    default_options = {"shared": False}
    generators = "cmake"

    def source(self):
        self.run("git clone https://github.com/memsharded/hello.git")
        self.run("cd hello && git checkout static_shared")
        # This small hack might be useful to guarantee proper /MT /MD linkage
        # in MSVC if the packaged project doesn't have variables to set it
        # properly
        tools.replace_in_file("hello/CMakeLists.txt", "PROJECT(MyHello)",
                              '''PROJECT(MyHello)
include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
conan_basic_setup()''')

    def build(self):
        cmake = CMake(self)
        cmake.configure(source_folder="hello")
        cmake.build()

        # Explicit way:
        # self.run('cmake %s/hello %s'
        #          % (self.source_folder, cmake.command_line))
        # self.run("cmake --build . %s" % cmake.build_config)

    def package(self):
        self.copy("*.h", dst="include", src="hello")
        self.copy("*hello.lib", dst="lib", keep_path=False)
        self.copy("*.dll", dst="bin", keep_path=False)
        self.copy("*.so", dst="lib", keep_path=False)
        self.copy("*.dylib", dst="lib", keep_path=False)
        self.copy("*.a", dst="lib", keep_path=False)

    def package_info(self):
        self.cpp_info.libs = ["hello"]

build 是你要具体如何编译项目

source source方法表示导入源文件。但是是为git方式来使用的。例子中会去git上下载源文件导入到conan的缓存中

package 打包你的项目。注意python文件中的 copy 函数，里面的dst是拷贝到conan的package下面。并不能随意的指定路径。

test_package 文件夹里面是“包”测试，你可以在example.cpp中写测试，并验证包是否正确创建，你可以在里面写一些测试case测试你的包是否好使。

test_package 具体参考：https://docs.conan.io/en/latest/creating_packages/getting_started.html#creating-the-package-recipe

执行conan create . demo/testing 创建并打包你的包

conan create . demo/testing

在柯南创建命令执行以下操作：

• 将conanfile.py从用户文件夹复制（以conan术语“导出”）到conan的本地缓存中。
• 安装包，强制从源构建它。
• 移动到test_package文件夹并创建临时构建文件夹。
• 执行conan install …，以安装test_package / conanfile.py的要求 。请注意，它将从源构建“Hello”。
• 构建并启动示例消费应用程序，分别调用test_package / conanfile.py build()和test()方法。
  使用Conan命令，conan create命令将等效于：

$ conan export . demo/testing
$ conan install Hello/[e-mail]/testing --build=Hello
# package is created now, use test to test it
$ conan test test_package Hello/[e-mail]/testing

打包项目(扩展)

有些项目并不是第三方开发。是自己开发的。这种就不能通过source导入你的项目。可以通过exports_sources 方法将你的源代码导入到conan的缓存中。

以下是conanfile.py的示例。删除掉source方法。增加exports_sources 表示你的源代码路径。conan在执行conanfile.py时将你的源代码导入到conan的缓存 export_source路径下面。

from conans import ConanFile, CMake

class HelloConan(ConanFile):
    name = "Hello"
    version = "0.1"
    license = "<Put the package license here>"
    url = "<Package recipe repository url here, for issues about the package>"
    description = "<Description of Hello here>"
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False]}
    default_options = {"shared": False}
    generators = "cmake"
    exports_sources = "src/*"

    def build(self):
        cmake = CMake(self)
        cmake.configure(source_folder="src")
        cmake.build()
        cmake.install()

        # Explicit way:
        # self.run('cmake "%s/src" %s' % (self.source_folder, cmake.command_line))
        # self.run("cmake --build . %s" % cmake.build_config)

    def package(self):
        pass

    def package_info(self):
        self.cpp_info.libs = ["hello"]

• 添加了该exports_sources字段，指示柯南将本地src 文件夹中的所有文件复制到包装配方中。

• 删除了该source()方法，因为不再需要检索外部源。同时你需要注意你的CMakeList文件是否引用了相关依赖库，如果引用你需要加入conanbuildinfo.cmake到你的CMakeList文件。
  include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
  conan_basic_setup()

  打包项目-直接打包编译好的项目
  直接打包项目。不从源代码开始进行编译。
  – 创建一个带有conanfile.py的文件
  conan new gdal/[e-mail]/testing
  – 直接打包文件到conan package文件夹下 --force 如果已经有了直接覆盖
  conan export-pkg . gdal/[e-mail]/testing -pf=/opt/gpsql --force