conan.tools.files 下载¶

conan.tools.files.get()¶

get(conanfile, url, md5=None, sha1=None, sha256=None, destination='.', filename='', keep_permissions=False, pattern=None, verify=True, retry=None, retry_wait=None, auth=None, headers=None, strip_root=False, extract_filter=None)¶

对 tgz、zip 或其他压缩格式文件进行高级下载和解压。它是 download、unzip 和解压后删除临时 zip 文件的高级封装。你可以传递哈希校验参数：md5、sha1、sha256。所有指定的算法都将被检查。如果其中任何一个不匹配，则会引发一个 ConanException。

参数:

conanfile – 当前的 recipe 对象。总是使用 self。
destination – （可选，默认为 .）目标文件夹
filename – （可选，默认为 ‘’）如果提供，保存的文件将具有指定的名称，否则从 URL 推导。
url – 转发给 tools.file.download()。
md5 – 转发给 tools.file.download()。
sha1 – 转发给 tools.file.download()。
sha256 – 转发给 tools.file.download()。
keep_permissions – 转发给 tools.file.unzip()。
pattern – 转发给 tools.file.unzip()。
verify – 转发给 tools.file.download()。
retry – 转发给 tools.file.download()。
retry_wait – 转发给 tools.file.download()。
auth – 转发给 tools.file.download()。
headers – 转发给 tools.file.download()。
strip_root – 转发给 tools.file.unzip()。
extract_filter – 转发给 tools.file.unzip()。

重要

get() 内部调用了 unzip()。请阅读 conan.tools.files.unzip() 中的注意事项，其中提到了 Python 3.14 的重大变更以及新的 tar 归档提取过滤器。

conan.tools.files.ftp_download()¶

ftp_download(conanfile, host, filename, login='', password='', secure=False)¶

从 FTP 服务器下载文件。从 FTP 服务器检索文件。

参数:

conanfile – 当前的 recipe 对象。总是使用 self。
host – FTP 服务器的 IP 或主机名。
filename – 要下载文件的路径。
login – 认证登录名。
password – 认证密码。
secure – 设置为 True 以使用 TLS/SSL (FTPS) 上的 FTP。默认为 False，使用普通 FTP。

用法

from conan.tools.files import ftp_download

def source(self):
    ftp_download(self, 'ftp.debian.org', "debian/README")
    self.output.info(load("README"))

conan.tools.files.download()¶

download(conanfile, url, filename, verify=True, retry=None, retry_wait=None, auth=None, headers=None, md5=None, sha1=None, sha256=None)¶

从给定的 URL 下载文件并保存为给定的文件名。它使用已知验证器列表中的证书进行 https 下载，但可以可选地禁用此功能。

你可以传递哈希校验参数：md5、sha1、sha256。所有指定的算法都将被检查。如果其中任何一个不匹配，下载的文件将被删除，并会引发一个 ConanException。

参数:

conanfile – 当前的 recipe 对象。总是使用 self。
url – 要下载的 URL。它可以是一个列表，只会下载列表中的第一个 URL，后续 URL 在下载出错时会作为镜像使用。本地文件系统中的文件可以通过以 file:/// 开头后跟文件绝对路径的 URL 来引用（其中第三个 / 表示 localhost）。
filename – 在本地存储中创建的文件名。
verify – 为 False 时，禁用 https 证书验证。
retry – 失败时的重试次数。默认值由“tools.files.download:retry”配置覆盖。
retry_wait – 两次下载尝试之间等待的秒数。默认值由“tools.files.download:retry_wait”配置覆盖。
auth – 用户和密码的元组，用于 HTTP Basic 认证。
headers – 包含附加请求头的字典。
md5 – 用于检查下载文件的 MD5 哈希码。
sha1 – 用于检查下载文件的 SHA-1 哈希码。
sha256 – 用于检查下载文件的 SHA-256 哈希码。

用法

download(self, "http://someurl/somefile.zip", "myfilename.zip")

# to disable verification:
download(self, "http://someurl/somefile.zip", "myfilename.zip", verify=False)

# to retry the download 2 times waiting 5 seconds between them
download(self, "http://someurl/somefile.zip", "myfilename.zip", retry=2, retry_wait=5)

# Use https basic authentication
download(self, "http://someurl/somefile.zip", "myfilename.zip", auth=("user", "password"))

# Pass some header
download(self, "http://someurl/somefile.zip", "myfilename.zip", headers={"Myheader": "My value"})

# Download and check file checksum
download(self, "http://someurl/somefile.zip", "myfilename.zip", md5="e5d695597e9fa520209d1b41edad2a27")

# to add mirrors
download(self, ["https://ftp.gnu.org/gnu/gcc/gcc-9.3.0/gcc-9.3.0.tar.gz",
                "http://mirror.linux-ia64.org/gnu/gcc/releases/gcc-9.3.0/gcc-9.3.0.tar.gz"],
                "gcc-9.3.0.tar.gz",
               sha256="5258a9b6afe9463c2e56b9e8355b1a4bee125ca828b8078f910303bc2ef91fa6")

配置¶

它使用这些配置条目

tools.files.download:retry: 发生错误时的重试次数。
tools.files.download:retry_wait: 两次重试之间等待的秒数。