conan.tools.files 基本操作

conan.tools.files.copy()

copy(conanfile, pattern, src, dst, keep_path=True, excludes=None, ignore_case=True, overwrite_equal=False)

将与模式 (fnmatch) 匹配的文件从 src 文件夹复制到 dst 文件夹。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • pattern – (必需) 要复制的文件所匹配的 fnmatch 文件模式。它不能以 .. 相对路径开头，否则会引发异常。

  • src – (必需) 搜索这些文件的源文件夹。此文件夹将从 dst 参数中去除。例如，lib/Debug/x86。

  • dst – (必需) 目标本地文件夹。它必须与 src 值不同，否则会引发异常。

  • keep_path – (可选，默认为 True) 表示在将文件从 src 文件夹复制到 dst 文件夹时，是否保留相对路径。

  • excludes – (可选，默认为 None) 要从复制中排除的 fnmatch 模式的元组/列表，甚至可以是单个模式。

  • ignore_case – (可选，默认为 True) 如果启用，将进行不区分大小写的模式匹配。当为 True 时将进行不区分大小写的模式匹配。

  • overwrite_equal – (可选，默认为 False)。如果目标文件夹中已存在要复制的文件，则只有当文件看起来不同（大小不同，修改时间不同）时才真正复制它。

返回:

复制的文件列表

用法

def package(self):
    copy(self, "*.h", self.source_folder, os.path.join(self.package_folder, "include"))
    copy(self, "*.lib", self.build_folder, os.path.join(self.package_folder, "lib"))

注意

指向文件的符号链接或指向文件夹的符号链接将像任何其他文件一样处理，因此只有当指定模式与文件匹配时，它们才会被复制。

在目标文件夹中，将创建指向完全相同文件或文件夹（绝对或相对）的符号链接，用户有责任操作符号链接，例如，在复制之前将符号链接转换为相对路径，使其指向目标文件夹。

请在此处查看管理符号链接的工具参考。

conan.tools.files.load()

load(conanfile, path, encoding='utf-8')

一行代码加载文件的实用函数。它将管理文件的打开和关闭，并加载二进制编码。返回文件内容。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • path – 要读取的文件路径

  • encoding – (可选，默认为 utf-8): 指定输入文件的文本编码。

返回:

文件内容

用法

from conan.tools.files import load

content = load(self, "myfile.txt")

conan.tools.files.save()

save(conanfile, path, content, append=False, encoding='utf-8')

一行代码保存文件的实用函数。它将管理文件的打开和关闭，并在必要时创建目录。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • path – 要创建的文件路径。

  • content – 要写入文件的内容（字符串或字节）。

  • append – (可选，默认为 False): 如果为 True，内容将追加到现有内容之后。

  • encoding – (可选，默认为 utf-8): 指定输出文件的文本编码。

用法

from conan.tools.files import save

save(self, "path/to/otherfile.txt", "contents of the file")

conan.tools.files.rename()

rename(conanfile, src, dst)

用于重命名文件或文件夹 src 到 dst 的实用函数，支持重试。os.rename() 在 Windows 上经常引发“拒绝访问”异常。此函数使用 robocopy 重命名文件或文件夹以避免 Windows 上的异常。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • src – 要重命名的路径。

  • dst – 重命名后的路径。

用法

from conan.tools.files import rename

def source(self):
    rename(self, "lib-sources-abe2h9fe", "sources")  # renaming a folder

conan.tools.files.replace_in_file()

replace_in_file(conanfile, file_path, search, replace, strict=True, encoding='utf-8')

将文件 file_path 内容中的字符串 search 替换为字符串 replace。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • file_path – 要执行替换操作的文件路径。

  • search – 要被替换的字符串。

  • replace – 替换搜索字符串的字符串。

  • strict – (可选，默认为 True) 如果为 True，则如果未找到搜索字符串，则会引发错误，因此实际上不会进行任何替换。

  • encoding – (可选，默认为 utf-8): 指定输入和输出文件的文本编码。

返回:

如果找到模式则为 True，否则（如果 strict 为 False）为 False。

用法

from conan.tools.files import replace_in_file

replace_in_file(self, os.path.join(self.source_folder, "folder", "file.txt"), "foo", "bar")

conan.tools.files.chmod()

chmod(conanfile, path: str, read: bool | None = None, write: bool | None = None, execute: bool | None = None, recursive: bool = False)

跨平台更改文件或目录权限。

2.15 版新增。

此函数是 chmod Unix 命令的简单包装器，但它支持跨平台。建议使用它而不是 os.stat + os.chmod，因为它只更改目录或文件所有者的权限，并避免 umask 问题。在 Windows 上，它仅限于更改写入权限。

参数

conanfile对象

当前的配方对象。始终使用 self。

path字符串

要更改权限的文件或目录的路径。

read布尔值，可选

如果为 True，则文件或目录将赋予所有者用户的读取权限。如果为 False，则移除读取权限。如果为 None，则读取权限保持不变。默认为 None。

write布尔值，可选

如果为 True，则文件或目录将赋予所有者用户的写入权限。如果为 False，则移除写入权限。如果为 None，则文件或目录不会被更改。默认为 None。

execute布尔值，可选

如果为 True，则文件或目录将赋予所有者用户的执行权限。如果为 False，则移除执行权限。如果为 None，则文件或目录不会被更改。默认为 None。

recursive布尔值

如果为 True，权限将递归应用于指定目录中的所有文件和目录。如果为 False，则只更改指定的文件或目录。默认为 False。

返回

无

示例

为打包的 bash 脚本添加执行权限
from conan.tools.files import chmod
chmod(self, os.path.join(self.package_folder, "bin", "script.sh"), execute=True)

conan.tools.files.rm()

此函数从文件系统中删除文件。它可用于删除单个文件或基于 fnmatch 的模式。建议使用它而不是 os.remove，因为它支持跨平台并可能避免权限问题。

递归删除 build_folder 中所有以 .tmp 结尾的文件
from conan.tools.files import rm

rm(self, "*.tmp", self.build_folder, recursive=True)
删除 bin_folder 中的所有文件，但以 .dll 结尾的文件除外
from conan.tools.files import rm

rm(self, "*", self.bin_folder, recursive=False, excludes="*.dll")
rm(conanfile, pattern, folder, recursive=False, excludes=None)

用于删除 folder 中与 pattern 匹配的文件的实用函数。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • pattern – 要删除的文件必须匹配的模式 (fnmatch)。

  • folder – 搜索/删除文件的文件夹。

  • recursive – 如果指定了 recursive，它将在子文件夹中搜索。

  • excludes – (可选，默认为 None) 要从删除模式中排除的 fnmatch 模式的元组/列表，甚至可以是单个模式。

conan.tools.files.mkdir()

mkdir(conanfile, path)

创建目录的实用函数。它会检查指定目录是否存在，因此如果目录已存在，mkdir() 将不执行任何操作。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • path – 要创建的文件夹路径。

用法

from conan.tools.files import mkdir

mkdir(self, "mydir") # Creates mydir if it does not already exist
mkdir(self, "mydir") # Does nothing

conan.tools.files.rmdir()

rmdir(conanfile, path)

用法

from conan.tools.files import rmdir

rmdir(self, "mydir") # Remove mydir if it exist
rmdir(self, "mydir") # Does nothing

conan.tools.files.chdir()

chdir(conanfile, newdir)

这是一个上下文管理器，允许在 conanfile 中临时更改当前目录

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • newdir – 要更改当前目录的目录路径名。

用法

from conan.tools.files import chdir

def build(self):
    with chdir(self, "./subdir"):
        do_something()

conan.tools.files.unzip()

此函数将不同的压缩格式（.tar、.tar.gz、.tgz、.tar.bz2、.tbz2、.tar.xz、.txz 和 .zip）解压到指定的目标文件夹中。

它还接受扩展名为 .gz（与上述任何一种不匹配）的 gzipped 文件，并将其解压为同名但无扩展名的文件，或解压为由 destination 参数定义的文件名。

from conan.tools.files import unzip

unzip(self, "myfile.zip")
# or to extract in "myfolder" sub-folder
unzip(self, "myfile.zip", "myfolder")

您可以使用 keep_permissions=True 参数保留文件的权限。

from conan.tools.files import unzip

unzip(self, "myfile.zip", "myfolder", keep_permissions=True)

如果您想从归档中过滤并解压特定文件和路径，请使用 pattern 参数。

from conan.tools.files import unzip

# Extract only files inside relative folder "small"
unzip(self, "bigfile.zip", pattern="small/*")
# Extract only txt files
unzip(self, "bigfile.zip", pattern="*.txt")

重要

在 Conan 2.8 中，unzip() 提供了一个新的 extract_filter=None 参数，并且添加了一个新的 tools.files.unzip:filter 配置，以应对未来 Python 3.14 中 tar 归档提取的 data 过滤器将成为默认设置的重大更改。建议尽快开始使用 data 过滤器（该配置可以在 global.conf 中定义，或者在配方的 unzip() 和 get() 辅助函数中明确添加为参数），因为这是当前从互联网下载源代码时的安全建议。

unzip(conanfile, filename, destination='.', keep_permissions=False, pattern=None, strip_root=False, extract_filter=None)

解压不同压缩格式

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • filename – 压缩文件的路径。

  • destination – (可选，默认为 .) 目标文件夹（对于 .gz 文件，可以是文件）。

  • keep_permissions – (可选，默认为 False) 保留 zip 权限。警告：如果 zip 文件不是在 NIX 系统中创建的，则可能会有危险，位可能产生未定义的权限模式。仅当您确定 zip 文件已正确创建时才使用此选项。

  • pattern – (可选，默认为 None) 仅提取与模式匹配的路径。这应该是一个 Unix shell 风格的通配符，详情请参阅 fnmatch 文档。

  • strip_root – (可选，默认为 False) 如果为 True，并且所有解压内容都在一个单独的文件夹中，它将展平该文件夹，将所有内容移动到父文件夹。

  • extract_filter – (可选，默认为 None)。提取 tar 文件时，使用 Python 在 https://docs.pythonlang.cn/3/library/tarfile.html 中定义的 tar 提取过滤器。

conan.tools.files.update_conandata()

此函数读取 conan 缓存中导出文件夹内的 conandata.yml（如果存在）。如果 conandata.yml 不存在，它将创建它。然后，它使用提供的 data 字典更新 conandata 字典，此更新是递归的，优先使用 data 值，但保留其他现有值。最后，conandata.yml 被保存到相同位置。

此辅助函数只能在 export() 方法中使用，否则可能会引发错误。一个应用场景是在 conandata.yml 中捕获 scm 坐标（如 Git 远程 URL 和提交），以便稍后在 source() 方法中恢复它们，并拥有可重现的配方，无需实际将源代码存储在配方中即可从源代码构建。

update_conandata(conanfile, data)

用于在 conandata.yml 导出后修改它的工具。例如，它可用于

  • 添加额外数据，如 scm 的“commit”和“url”。

  • 修改内容，清理属于其他版本（与导出的不同）的数据，以避免在更改的数据不属于当前版本时更改配方修订版。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • data – (必需) 要更新的值的字典（可以是嵌套的）。

conan.tools.files.trim_conandata()

trim_conandata(conanfile, raise_if_missing=True)

用于在 conandata.yml 导出后修改它，仅限于当前版本的工具。

警告

函数 conan.tools.files.trim_conandata() 处于预览阶段。有关更多信息，请参阅Conan 稳定性部分。

此函数修改 conan 缓存中导出文件夹内的 conandata.yml（如果存在），并仅保留与当前构建版本相关的信息。

此辅助函数只能在 export() 方法或 post_export() hook 中使用，否则将来可能会引发错误。一个应用场景是确保 conandata.yml 文件中与某些版本相关的更改不会影响其他版本的生成的配方修订版。

用法

from conan import ConanFile
from conan.tools.files import trim_conandata

class Pkg(ConanFile):
    name = "pkg"

    def export(self):
        # any change to other versions in the conandata.yml
        # won't affect the revision of the version that is built
        trim_conandata(self)

conan.tools.files.collect_libs()

collect_libs(conanfile, folder=None)

从 conanfile.cpp_info.libdirs（默认）或相对于包文件夹的 folder 目录中找到的库（扩展名为 .so、.lib、.a 和 .dylib 的文件）中返回一个排序后的库名称列表。适用于收集非相互依赖的库或名称复杂的库，例如 libmylib-x86-debug-en.lib。

对于以 lib 开头的 UNIX 库，例如 libmath.a，此工具将收集库名称 math。

参数:

  • conanfile – 当前的配方对象。始终使用 self。

  • folder – (可选，默认为 None): 指示 conanfile.package_folder 中包含库文件的子文件夹名称的字符串。

返回:

包含库名称的列表

警告

此工具直接在包文件夹内搜索库并返回它们，不保证特定顺序。如果库之间相互依赖，则 package_info() 方法应对其进行排序以实现正确的链接顺序。

用法

from conan.tools.files import collect_libs

def package_info(self):
    self.cpp_info.libdirs = ["lib", "other_libdir"]  # Default value is 'lib'
    self.cpp_info.libs = collect_libs(self)

对于以 lib 开头的 UNIX 库，例如 libmath.a，此工具将收集库名称 math。关于符号链接，此工具将只保留解析后的真实文件和所有指向该真实文件的符号链接中“最通用”的文件。例如，在以下文件中，此工具将选择 libmath.dylib 文件，因此返回列表中只添加 math。

-rwxr-xr-x libmath.1.0.0.dylib lrwxr-xr-x libmath.1.dylib -> libmath.1.0.0.dylib
lrwxr-xr-x libmath.dylib -> libmath.1.dylib