package()

package() 方法负责将文件从 source_folder 和临时 build_folder 复制到 package_folder,仅复制最终包中包含的文件和工件,例如头文件、编译器静态和共享库、可执行文件、许可证文件等。

package() 方法将为创建新包二进制文件的每个不同的配置调用一次,这发生在 conan install --build=pkg*conan createconan export-pkg 命令中。

package() 方法执行此类复制主要有两种方法。第一种是从原始 source_folderbuild_folderpackage folder 的显式 copy()

from conan import ConanFile
from conan.tools.files import copy

class Pkg(ConanFile):

    def package(self):
        # copying headers from source_folder
        copy(self, "*.h", join(self.source_folder, "include"), join(self.package_folder, "include"))
        # copying compiled .lib from build folder
        copy(self, "*.lib", self.build_folder, join(self.package_folder, "lib"), keep_path=False)

第二种方法是使用某些构建系统的 install 功能,前提是构建脚本实现了此功能。例如,如果包的 CMakeLists.txt 实现了正确的 CMake INSTALL 指令,则可以执行

def package(self):
    cmake = CMake(self)
    cmake.install()

此外,还可以组合这两种方法,执行 cmake.install() 并添加一些 copy() 调用,例如确保打包了一些 CMakeLists.txt 脚本未考虑到的“License.txt”文件。

也可以在 package() 方法中使用条件语句,因为不同的平台可能在不同位置具有不同的工件。

def package(self):
    if self.settings.os == "Windows":
        copy(self, "*.lib", src=os.path.join(self.build_folder, "libs"), ...)
        copy(self, "*.dll", ....)
    else:
        copy(self, "*.lib", src=os.path.join(self.build_folder, "build", "libs"), ...)

尽管在大多数情况下可能没有必要,因为基于模式的复制可能不会找到错误的工件,例如非 Windows 构建中的 *.dll

package() 方法也是使用 conan export-pkg 打包预编译二进制文件时调用的方法。在这种情况下,self.source_folderself.build_folder 指的是用户空间文件夹,由 layout() 方法定义,Conan 缓存中唯一的文件夹将是 self.package_folder

注意

最佳实践

cmake.install() 功能应在 package() 方法中调用,而不是在 build() 方法中调用。无需重用 CMake(self) 对象,不应在方法之间重用它。在每个方法中创建一个新实例是推荐的方法。

另请参阅

请参阅 :ref:`package() 方法教程<creating_packages_package_method>` 以获取更多信息。