export()¶
等同于 exports
属性,但以方法的形式存在。此方法将在 export
时被调用,这发生在 conan export
、conan export-pkg
和 conan create
命令中,它的目的是允许将文件从用户文件夹复制到 Conan 缓存文件夹,从而使这些文件成为配方的一部分。这些源文件将与配方一起上传到服务器,并且始终与配方一起下载。
当前工作目录将是 self.recipe_folder
,并且可以使用 self.export_folder
作为目标文件夹来使用 copy()
或自定义复制。
from conan import ConanFile
from conan.tools.files import copy
class Pkg(ConanFile):
def export(self):
# This LICENSE file is intended to be the license of the current conanfile.py recipe
# and go with it. It is not intended to be the license of the final package (for that
# purpose export_sources() would be recommended)
copy(self, "LICENSE.md", self.recipe_folder, self.export_folder)
有 2 个文件会被自动导出到缓存,而无需在配方中明确定义:conanfile.py
配方,以及 conandata.yml
文件(如果存在)。每当加载 conanfile.py
时,就会自动加载 conandata.yml
文件,成为 self.conan_data
属性,因此它是配方的内在部分,是“导出”配方文件的一部分,而不是“导出”源文件的一部分。
注意
最佳实践
配方文件必须与配置无关。这些文件对所有配置都是通用的,因此不可能针对不同的设置、选项或平台进行条件性的
export()
。请勿尝试进行任何形式的条件导出。如有必要,一次性导出所有配置所需的文件。export()
方法不接收来自配置文件的任何信息,甚至不接收conf
。只有global.conf
可用,无论如何,都不可能使用该conf
来定义条件。保持
export()
方法简单。其目的是将文件从用户文件夹复制到缓存,以便将这些文件与配方一起存储。导出的文件必须很小。将大文件与配方一起导出将大大减慢依赖项的解析速度。
只有对评估
conanfile.py
配方所需的文件才必须使用此方法导出。从源代码构建所需的文件应使用exports_sources
属性或 export_source() 方法导出。