export_sources()¶
等效于 exports_sources
属性,但以方法形式存在。此方法将在 export
时刻被调用,这发生在 conan export
、conan export-pkg
和 conan create
命令中,其目的是允许将文件从用户文件夹复制到 Conan 缓存文件夹,这些文件将成为 recipe 源代码的一部分。这些源代码将与 recipe 一起上传到服务器,但通常不会被下载,除非软件包正在从源代码构建。
当前工作目录将是 self.recipe_folder
,并且可以使用 self.export_sources_folder
作为目标文件夹,以使用 copy()
或您的自定义复制。
from conan import ConanFile
from conan.tools.files import copy
class Pkg(ConanFile):
def export_sources(self):
# This LICENSE.md is a source file intended to be part of the final package
# it is not the license of the current recipe
copy(self, "LICENSE.md", self.recipe_folder, self.export_sources_folder)
该方法可能能够读取 recipe 文件夹中的文件并对其进行一些处理
import os
from conan import ConanFile
from conan.tools.files import load, save
class Pkg(ConanFile):
def export_sources(self):
content = load(self, os.path.join(self.recipe_folder, "data.txt"))
save(self, os.path.join(self.export_sources_folder, "myfile.txt"), content)
export_conandata_patches()
是一个高级辅助函数,用于导出在 conandata.yml
文件中定义的补丁,这些补丁稍后可以在 source()
方法中使用 apply_conandata_patches()
应用。
from conan.tools.files import export_conandata_patches
class Pkg(ConanFile):
def export_sources(self):
export_conandata_patches(self)
注意
最佳实践
recipe 源代码必须是配置独立的。这些源代码对于所有配置都是通用的,因此不可能对不同的设置、选项或平台执行有条件的
export_sources()
。不要尝试进行任何类型的条件导出。如有必要,一次性导出所有配置所需的所有文件。export_sources()
方法不会从 profile 接收任何信息,甚至不包括conf
。只有global.conf
可用,并且在任何情况下都无法使用该conf
来定义条件。保持
export_source()
方法的简洁性。其目的是将文件从用户文件夹复制到缓存,以便将这些文件与 recipe 一起存储。