package()¶
package()
方法负责将文件从 source_folder
和临时 build_folder
复制到 package_folder
,仅复制将成为最终包一部分的文件和制品,例如头文件、编译器静态库和共享库、可执行文件、许可文件等。
package()
方法对于创建新包二进制文件的每种不同配置,会被调用一次,这发生在 conan install --build=pkg*
、conan create
和 conan export-pkg
命令中。
package()
方法主要有两种方式可以执行此复制。第一种是显式的 copy()
调用,从原始的 source_folder
和 build_folder
复制到 package folder
。
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()
调用,例如,确保将 “License.txt” 文件打包进去,即使 CMakeLists.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_folder
和 self.build_folder
指的是用户空间的文件夹,由 layout()
方法定义,并且 Conan 缓存中唯一的文件夹将是 self.package_folder
。
注意
最佳实践
cmake.install()
功能应在 package()
方法中调用,而不是在 build()
方法中。没有必要复用 CMake(self)
对象,不应在方法之间复用。在每个方法中创建一个新的实例是推荐的方法。
另请参阅
有关更多信息,请参阅 package() 方法教程。