全部产品
Search
文档中心

对象存储 OSS:Python下载进度条

更新时间:Dec 27, 2023

进度条用于指示上传或下载的进度。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见初始化

示例代码

下面的代码以bucket.get_object_to_file方法为例,介绍如何使用进度条。

# -*- coding: utf-8 -*-
from __future__ import print_function
import os, sys
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# 填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
# yourBucketName填写存储空间名称。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'yourBucketName')
# 当HTTP响应头部没有Content-Length时,total_bytes的值为None。
# consumed_bytes表示已下载文件的大小,单位为字节。
# total_bytes表示下载文件的总大小,单位为字节。
def percentage(consumed_bytes, total_bytes):
    if total_bytes:
        rate = int(100 * (float(consumed_bytes) / float(total_bytes)))
        # rate表示下载进度。
        print('\r{0}% '.format(rate), end='')

        sys.stdout.flush()

# progress_callback是可选参数,用于实现进度条功能。
bucket.get_object_to_file('yourObjectName', 'yourLocalFile', progress_callback=percentage)

相关文档

关于下载文件的进度条使用方法的完整示例代码,请参见GitHub示例