oss2 package

优质

小牛编辑

122浏览

2023-12-01

Submodules

oss2.api module

文件上传方法中的data参数。

诸如

基类：oss2.api._Base

用于Bucket和Object操作的类，诸如创建、删除Bucket，上传、下载Object等。

用法（假设Bucket属于杭州区域）:

>>> import oss2
>>> auth = oss2.Auth('your-access-key-id', 'your-access-key-secret')
>>> bucket = oss2.Bucket(auth, 'http://oss-cn-hangzhou.aliyuncs.com', 'your-bucket')
>>> bucket.put_object('readme.txt', 'content of the object')
<oss2.models.PutObjectResult object at 0x029B9930>

参数:	auth (oss2.Auth) – 包含了用户认证信息的Auth对象 endpoint (str) – 访问域名或者CNAME bucket_name (str) – Bucket is_cname (bool) – 如果endpoint是CNAME则设为True；反之，则为False。 session (oss2.Session) – 会话。如果是None表示新开会话，非None则复用传入的会话。 connect_timeout (float) – 连接超时时间，以秒为单位。 app_name (str) – 应用名。该参数不为空，则在User Agent中加入其值。注意到，最终这个字符串是要作为HTTP Header的值传输的，所以必须要遵循HTTP标准。

参数:

auth (oss2.Auth) – 包含了用户认证信息的Auth对象
endpoint (str) – 访问域名或者CNAME
bucket_name (str) – Bucket
is_cname (bool) – 如果endpoint是CNAME则设为True；反之，则为False。
session (oss2.Session) – 会话。如果是None表示新开会话，非None则复用传入的会话。
connect_timeout (float) – 连接超时时间，以秒为单位。
app_name (str) – 应用名。该参数不为空，则在User Agent中加入其值。注意到，最终这个字符串是要作为HTTP Header的值传输的，所以必须要遵循HTTP标准。

ACL = 'acl'

BUCKET_INFO = 'bucketInfo'

COMP = 'comp'

CORS = 'cors'

LIFECYCLE = 'lifecycle'

LIVE = 'live'

LOCATION = 'location'

LOGGING = 'logging'

REFERER = 'referer'

STAT = 'stat'

STATUS = 'status'

SYMLINK = 'symlink'

VOD = 'vod'

WEBSITE = 'website'

abort_multipart_upload(key, upload_id)[源代码]

取消分片上传。

参数:

key (str) – 待上传的文件名，这个文件名要和

追加上传一个文件。

参数:

key (str) – 新的文件名，或已经存在的可追加文件名
position (int) – 追加上传一个新的文件， position 设为0；追加一个已经存在的可追加文件， position 设为文件的当前长度。position 可以从上次追加的结果 AppendObjectResult.next_position 中获得。
data (str,bytes,file-like object or iterator object.) – 用户数据
headers (dict or oss2.CaseInsensitiveDict(recommended)) – 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-开头的头部等
progress_callback – 用户指定的进度回调函数。可以用来实现进度条等功能。参考上传下载进度。

批量删除文件。待删除文件列表不能为空。

参数:

key_list (list of str) – 文件名列表，不能为空。

完成分片上传，创建文件。

参数:

key (str) – 待上传的文件名，这个文件名要和

拷贝一个文件到当前Bucket。

参数:

source_bucket_name (str) – 源Bucket名
source_key (str) – 源文件名
target_key (str) – 目标文件名
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部

创建新的Bucket。

参数:

permission (str) – 指定Bucket的ACL。可以是oss2.BUCKET_ACL_PRIVATE（推荐、缺省）、oss2.BUCKET_ACL_PUBLIC_READ或是oss2.BUCKET_ACL_PUBLIC_READ_WRITE。

input –

创建推流直播频道。

参数:

channel_name (str) – 创建推流直播频道。
input – LiveChannelInfo类型，包含了live channel中的描述信息。

删除一个Bucket。只有没有任何文件，也没有任何未完成的分片上传的Bucket才能被删除。

返回:	删除Bucket的CORS配置。

delete_bucket_lifecycle()[源代码]: 删除生命周期管理配置。如果Lifecycle没有设置，也返回成功。

delete_bucket_logging()[源代码]: 关闭Bucket的访问日志功能。

delete_bucket_website()[源代码]: 关闭Bucket的静态网站托管功能。

delete_live_channel(channel_name)[源代码]

删除推流直播频道

参数:	channel_name (str) – 创建推流直播频道。

delete_object(key)[源代码]

删除一个文件。

参数:

key (str) – 待上传的文件名

获取Bucket的ACL。

获取Bucket的CORS配置

获取bucket相关信息，如创建时间，访问Endpoint，Owner与ACL等。

获取生命周期管理配置。

获取Bucket的数据中心。

获取Bucket的访问日志功能配置。

获取Bucket的防盗链配置。

查看Bucket的状态，目前包括bucket大小，bucket的object数量，bucket正在上传的Multipart Upload事件个数等。

获取Bucket的静态网站托管配置。

获取直播频道配置

参数:

channel_name (str) – 创建推流直播频道。

获取live channel中最近的最多十次的推流记录，记录中包含推流的起止时间和远端的地址。

参数:

channel_name (str) – 创建推流直播频道。

获取live channel当前推流的状态。

参数:

channel_name (str) – 创建推流直播频道。

下载一个文件。

用法:

>>> result = bucket.get_object('readme.txt')
>>> print(result.read())
'hello world'

参数:

key – 上传到OSS的文件名
byte_range – 指定下载范围。参见指定下载范围
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部
progress_callback – 用户指定的进度回调函数。参考上传下载进度
process – OSS文件处理，如图像服务等。指定后process，返回的内容为处理后的文件
params – 请求的查询字符串参数。

file-like对象

Raises:

如果文件不存在，则抛出

设置文件的ACL。

获取文件基本元信息，包括该Object的ETag、Size（文件大小）、LastModified，并不返回其内容。

HTTP响应的头部包含了文件基本元信息，可以通过 GetObjectMetaResult 的 last_modified，content_length, etag 成员获得。

参数:

key – 文件名

下载一个文件到本地文件。

参数:

key – OSS侧的对象名。
filename – 本地文件名。要求父目录已经存在，且有写权限。
byte_range – 指定下载范围。参见指定下载范围
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部
progress_callback – 用户指定的进度回调函数。参考上传下载进度
process – OSS文件处理，如图像服务等。指定后process，返回的内容为处理后的文件

如果文件不存在，则抛出

获取符号连接文件的目标文件。

参数:

symlink_key (str) – 符号连接类文件。

获取文件元信息。

HTTP响应的头部包含了文件元信息，可以通过 RequestResult 的 headers 成员获得。

用法:

>>> result = bucket.head_object('readme.txt')
>>> print(result.content_type)
text/plain

参数:

key – OSS侧的对象名。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部

初始化分片上传。

返回值中的 upload_id 以及`Bucket名`和`Object名`三元组唯一对应了此次分片上传事件。

参数:

key (str) – 待上传的文件名
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部

列举出Bucket下所有符合条件的live channel。

参数:

prefix (str) – list时channel_id的公共前缀
marker (str) – list时指定的起始标记
max_keys (int) – 本次list返回live channel的最大个数

罗列正在进行中的分片上传。支持分页。

参数:

prefix (str) – 只罗列匹配该前缀的文件的分片上传。
delimiter (str) – 目录分割符
key_marker (str) – 文件名分页符。第一次调用可以不传，后续设为返回值中的 next_key_marker 。
upload_id_marker (str) – 分片ID分页符。第一次调用可以不传，后续设为返回值中的 next_upload_id_marker 。
max_uploads (int) – 一次罗列最多能够返回的条目数。

根据前缀罗列Bucket里的文件。

参数:

prefix (str) – 只罗列文件名为该前缀的文件。
delimiter (str) – 分隔符。可以用来模拟目录。
marker (str) – 分页标志。首次调用传空串，后续使用返回值的next_marker。
max_keys (int) – 最多返回文件的个数，文件和目录的和不能超过该值。

列举已经上传的分片。支持分页。

参数:	key (str) – 待上传的文件名 upload_id (str) – 分片上传ID marker (str) – 一次最多罗列多少分片 max_parts (int) – 一次罗列最多能够返回的条目数。
返回:	如果文件存在就返回True，否则返回False。如果Bucket不存在，或是发生其他错误，则抛出异常。

post_vod_playlist(channel_name, playlist_name, start_time=0, end_time=0)[源代码]

根据指定的playlist name以及startTime和endTime生成一个点播的播放列表。

参数:	channel_name (str) – 创建推流直播频道。 playlist_name (str) – 要生成点播列表m3u8文件的名称。 start_time (int) – 点播的起始时间，Unix Time格式，可以使用int(time.time())获取 end_time (int) – 点播的结束时间，Unix Time格式，可以使用int(time.time())获取

put_bucket_acl(permission)[源代码]

设置Bucket的ACL。

参数:	permission (str) – 新的ACL，可以是oss2.BUCKET_ACL_PRIVATE、oss2.BUCKET_ACL_PUBLIC_READ或oss2.BUCKET_ACL_PUBLIC_READ_WRITE

put_bucket_cors(input)[源代码]

设置Bucket的CORS。

参数:

input –

设置生命周期管理的配置。

参数:

input –

设置Bucket的访问日志功能。

参数:

input –

为Bucket设置防盗链。

参数:

input –

为Bucket配置静态网站托管功能。

参数:

input –

更改live channel的status，仅能在’enabled’和’disabled’两种状态中更改。

参数:	channel_name (str) – 创建推流直播频道。 status (str) – live channel的目标状态。

put_object(key, data, headers=None, progress_callback=None)[源代码]

上传一个普通文件。

用法:

>>> bucket.put_object('readme.txt', 'content of readme.txt')
>>> with open(u'local_file.txt', 'rb') as f:
>>>     bucket.put_object('remote_file.txt', f)

上传文件夹。

>>> bucket.enable_crc = False # this is needed as by default crc is enabled and it will not work when creating folder.
>>> bucket.put_object('testfolder/', None)

参数:

key – OSS侧的对象名。
data (bytes, str or file-like object.) – 待上传的内容。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-开头的头部等。
progress_callback – 用户指定的进度回调函数。可以用来实现进度条等功能。参考上传下载进度。

设置文件的ACL。

参数:

key (str) – 文件名
permission (str) – 可以是oss2.OBJECT_ACL_DEFAULT,oss2.OBJECT_ACL_PRIVATE,oss2.OBJECT_ACL_PUBLIC_READ或oss2.OBJECT_ACL_PUBLIC_READ_WRITE.

上传一个本地文件到OSS的普通文件。

参数:

key (str) – 上传到OSS的文件名
filename (str) – 本地文件名，需要有可读权限
headers (dict or oss2.CaseInsensitiveDict(recommended)) – 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-meta-开头的头部等。
progress_callback – 用户指定的进度回调函数。可以用来实现进度条等功能。参考上传下载进度。

创建Symlink。

参数:

target_key (str) – 目标文件，目标文件不能为符号连接。
symlink_key (str) – 符号连接类文件，其实质是一个特殊的文件，数据指向目标文件。

恢复一个对象。

如果是第一次针对该object调用接口，返回RequestResult.status = 202。如果已经成功调用过restore接口，且服务端仍处于解冻中，抛异常RestoreAlreadyInProgress(status=409)如果已经成功调用过restore接口，且服务端解冻已经完成，再次调用时返回RequestResult.status = 200，且会将object的可下载时间延长一天，最多延长7天。如果object不存在，则抛异常NoSuchKey(status=404)。对非Archive类型的Object提交restore，则抛异常OperationNotSupported(status=400)也可以通过调用head_object接口来获取meta信息来判断是否可以restore与restore的状态。
用法:
>>> meta = bucket.head_object(key)
>>> if meta.resp.headers['x-oss-storage-class'] == oss2.BUCKET_STORAGE_CLASS_ARCHIVE:
>>>     bucket.restore_object(key)
>>>         while True:
>>>             meta = bucket.head_object(key)
>>>             if meta.resp.headers['x-oss-restore'] == 'ongoing-request="true"':
>>>                 time.sleep(5)
>>>             else:
>>>                 break

参数:

key (str) – 文件名

直播频道中的推流记录信息。

生成RTMP推流的签名URL。常见的用法是生成加签的URL以供授信用户向OSS推RTMP流。

参数:	channel_name – 直播频道的名称。 expires – 过期时间（单位：秒），链接在当前时间再过expires秒后过期。 playlist_name – 播放列表名称，注意与创建live channel时一致。 params – 需要签名的HTTP查询参数。
返回:	签名URL。

sign_url(method, key, expires, headers=None, params=None)[源代码]

生成签名URL。

常见的用法是生成加签的URL以供授信用户下载，如为log.jpg生成一个5分钟后过期的下载链接:

>>> bucket.sign_url('GET', 'log.jpg', 5 * 60)
'http://your-bucket.oss-cn-hangzhou.aliyuncs.com/logo.jpg?OSSAccessKeyId=YourAccessKeyId\&Expires=1447178011&Signature=UJfeJgvcypWq6Q%2Bm3IJcSHbvSak%3D'

参数:	method (str) – HTTP方法，如’GET’、’PUT’、’DELETE’等。 key – 待上传的文件名 expires – 过期时间（单位：秒），链接在当前时间再过expires秒后过期。 headers (dict or oss2.CaseInsensitiveDict(recommended)) – 需要签名的HTTP头部，如名称以x-oss-meta-开头的头部（作为用户自定义元数据）、Content-Type头部等。对于下载，不需要填。 params – 需要签名的HTTP查询参数。
返回:	签名URL。

参数:

method (str) – HTTP方法，如’GET’、’PUT’、’DELETE’等。
key – 待上传的文件名
expires – 过期时间（单位：秒），链接在当前时间再过expires秒后过期。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – 需要签名的HTTP头部，如名称以x-oss-meta-开头的头部（作为用户自定义元数据）、Content-Type头部等。对于下载，不需要填。
params – 需要签名的HTTP查询参数。

签名URL。

update_object_meta(key, headers)[源代码]

更改Object的元数据信息，包括Content-Type这类标准的HTTP头部，以及以x-oss-meta-开头的自定义元数据。

用户可以通过

上传一个分片。

参数:

key (str) – 待上传文件名，这个文件名要和

分片拷贝。把一个已有文件的一部分或整体拷贝成目标文件的一个分片。

参数:

byte_range – 指定待拷贝内容在源文件里的范围。参见指定下载范围
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部

用于加密Bucket和Object操作的类，诸如上传、下载Object等。创建、删除bucket的操作需使用Bucket类接口。

用法（假设Bucket属于杭州区域）

>>> import oss2
>>> auth = oss2.Auth('your-access-key-id', 'your-access-key-secret')
>>> bucket = oss2.CryptoBucket(auth, 'http://oss-cn-hangzhou.aliyuncs.com', 'your-bucket', oss2.LocalRsaProvider())
>>> bucket.put_object('readme.txt', 'content of the object')
<oss2.models.PutObjectResult object at 0x029B9930>

参数:

auth (oss2.Auth) – 包含了用户认证信息的Auth对象
endpoint (str) – 访问域名或者CNAME
bucket_name (str) – Bucket名

crypto_provider (

下载一个文件。

用法:

>>> result = bucket.get_object('readme.txt')
>>> print(result.read())
'hello world'

参数:

key – OSS侧的对象名。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部
progress_callback – 上传进度回调函数。参见上传下载进度。

file-like对象。

Raises:

如果文件不存在，则抛出

下载一个文件到本地文件。

参数:

key – OSS侧的对象名。
filename – 本地文件名。要求父目录已经存在，且有写权限。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – HTTP头部
progress_callback – 上传进度回调函数。参见上传下载进度。
process – OSS文件处理，如图像服务等。指定后process，返回的内容为处理后的文件。

如果文件不存在，则抛出

上传一个普通文件。

用法:

>>> bucket.put_object('readme.txt', 'content of readme.txt')
>>> with open(u'local_file.txt', 'rb') as f:
>>>     bucket.put_object('remote_file.txt', f)

参数:

key – OSS侧的对象名。
data (bytes, str or file-like object) – 待上传的内容。
headers (dict or oss2.CaseInsensitiveDict(recommended)) – 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-开头的头部等
progress_callback – 用户指定的进度回调函数。可以用来实现进度条等功能。参考上传下载进度。

上传一个本地文件到OSS的普通文件。

参数:

key (str) – OSS侧的对象名。
filename (str) – 本地文件名，需要有可读权限。
headers (dict, but recommendation is oss2.CaseInsensitiveDict) – 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-开头的头部等。
progress_callback – 用户指定的进度回调函数。可以用来实现进度条等功能。参考上传下载进度。

基类：oss2.api._Base

用于Service操作的类，如罗列用户所有的Bucket。

用法:

>>> import oss2
>>> auth = oss2.Auth('your-access-key-id', 'your-access-key-secret')
>>> service = oss2.Service(auth, 'oss-cn-hangzhou.aliyuncs.com')
>>> service.list_buckets()
<oss2.models.ListBucketsResult object at 0x0299FAB0>

参数:

auth (oss2.Auth) – 包含了用户认证信息的Auth对象。
endpoint (str) – 访问域名，如杭州区域的域名为’oss-cn-hangzhou.aliyuncs.com’。
session (oss2.Session) – 会话。如果是None表示新开会话，非None则复用传入的会话。
connect_timeout (float) – 连接超时时间，以秒为单位。
app_name (str) – 应用名。该参数不为空，则在User Agent中加入其值。注意到，最终这个字符串是要作为HTTP Header的值传输的，所以必须要遵循HTTP标准。

list_buckets(prefix='', marker='', max_keys=100)[源代码]

根据前缀罗列用户的Bucket。

参数:	prefix (str) – 只罗列Bucket名为该前缀的Bucket，空串表示罗列所有的Bucket。 marker (str) – 分页标志。首次调用传空串，后续使用返回值中的next_marker。 max_keys (int) – 每次调用最多返回的Bucket数目。
返回:	罗列的结果
返回类型:	基类：`object` 用于匿名访问。注解匿名用户只能读取public-read的Bucket，或只能读取、写入public-read-write的Bucket。不能进行Service、Bucket相关的操作，也不能罗列文件等。

class oss2.auth.Auth(access_key_id, access_key_secret)[源代码]

基类：

基类：object

用于保存用户AccessKeyId、AccessKeySecret，以及计算签名的对象。

class oss2.auth.AuthV2(access_key_id, access_key_secret)[源代码]

基类：

基类：object

用于STS临时凭证访问。可以通过官方STS客户端获得临时密钥（AccessKeyId、AccessKeySecret）以及临时安全令牌（SecurityToken）。

注解

临时凭证会在一段时间后过期，在此之前需要重新获取临时凭证，并更新 Bucket 的 auth 成员变量为新的 StsAuth 实例。

参数:	access_key_id (str) – 临时AccessKeyId access_key_secret (str) – 临时AccessKeySecret security_token (str) – 临时安全令牌(SecurityToken) auth_version (str) – 需要生成auth的版本，默认为AUTH_VERSION_1(v1)

oss2.auth.make_auth(access_key_id, access_key_secret, auth_version='v1')[源代码]

oss2.auth.v2_uri_encode(raw_text)[源代码]

oss2.compat module

兼容Python版本

oss2.compat.stringify(input)[源代码]

oss2.compat.to_bytes(data)[源代码]: 若输入为unicode，则转为utf-8编码的bytes；其他则原样返回。

oss2.compat.to_string(data)[源代码]: 把输入转换为str对象

oss2.compat.to_unicode(data)[源代码]: 把输入转换为unicode，要求输入是unicode或者utf-8编码的bytes。

oss2.crypto module

oss2.encryption

该模块包含了客户端加解密相关的函数和类。

class oss2.crypto.AliKMSProvider(access_key_id, access_key_secret, region, cmkey, sts_token=None, passphrase=None, cipher=<class oss2.utils.AESCipher>)[源代码]: 基类：

decrypt_oss_meta_data(headers, key, conv=<function <lambda>>)[源代码]

get_key()[源代码]

get_start()[源代码]

class oss2.crypto.BaseCryptoProvider(cipher)[源代码]

基类：object

CryptoProvider 基类，提供基础的数据加密解密adapter

make_decrypt_adapter(stream, key, start)[源代码]

make_encrypt_adapter(stream, key, start)[源代码]

class oss2.crypto.LocalRsaProvider(dir=None, key='', passphrase=None, cipher=<class oss2.utils.AESCipher>)[源代码]: 基类：

PUB_KEY_FILE = '.public_key.pem'

build_header(headers=None)[源代码]

decrypt_oss_meta_data(headers, key, conv=<function <lambda>>)[源代码]

get_key()[源代码]

get_start()[源代码]

oss2.defaults module

oss2.defaults

全局缺省变量

oss2.defaults.connect_timeout = 60: 连接超时时间

oss2.defaults.connection_pool_size = 10: 每个Session连接池大小

oss2.defaults.get(value, default_value)[源代码]

oss2.defaults.get_logger()[源代码]

oss2.defaults.logger = <logging.RootLogger object>: 缺省Logger

oss2.defaults.multiget_num_threads = 4: 并行下载（multiget）缺省线程数

oss2.defaults.multiget_part_size = 10485760: 并行下载（multiget）的缺省分片大小

oss2.defaults.multiget_threshold = 104857600: 对于断点下载，如果OSS文件大小大于该值就进行并行下载（multiget）

oss2.defaults.multipart_num_threads = 1: 分片上传缺省线程数

oss2.defaults.multipart_threshold = 10485760: 对于某些接口，上传数据长度大于或等于该值时，就采用分片上传。

oss2.defaults.part_size = 10485760: 缺省分片大小

oss2.defaults.request_retries = 3: 缺省重试次数

oss2.exceptions module

oss2.exceptions

异常类。

exception oss2.exceptions.AccessDenied(status, headers, body, details)[源代码]: 基类：

status = 403

exception oss2.exceptions.BucketNotEmpty(status, headers, body, details)[源代码]: 基类：

status = 409

exception oss2.exceptions.ChannelStillLive(status, headers, body, details)[源代码]: 基类：

status = 409

exception oss2.exceptions.ClientError(message)[源代码]: 基类：; 基类：

status = 409

exception oss2.exceptions.InconsistentError(message, request_id='')[源代码]: 基类：; 基类：

status = 400

exception oss2.exceptions.InvalidDigest(status, headers, body, details)[源代码]: 基类：

status = 400

exception oss2.exceptions.InvalidObjectName(status, headers, body, details)[源代码]: 基类：

status = 400

exception oss2.exceptions.InvalidRequest(status, headers, body, details)[源代码]: 基类：

status = 400

exception oss2.exceptions.LiveChannelDisabled(status, headers, body, details)[源代码]: 基类：

status = 409

exception oss2.exceptions.MalformedXml(status, headers, body, details)[源代码]: 基类：

status = 400

exception oss2.exceptions.NoSuchBucket(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchCors(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchKey(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchLifecycle(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchLiveChannel(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchUpload(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NoSuchWebsite(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NotFound(status, headers, body, details)[源代码]: 基类：

status = 404

exception oss2.exceptions.NotModified(status, headers, body, details)[源代码]: 基类：

status = 304

exception oss2.exceptions.ObjectNotAppendable(status, headers, body, details)[源代码]: 基类：

status = 409

exception oss2.exceptions.OpenApiFormatError(message)[源代码]: 基类：; 基类：; 基类：

status = 400

exception oss2.exceptions.OssError(status, headers, body, details)[源代码]

基类：exceptions.Exception

body = None: HTTP响应体（部分）

code = None: OSS错误码

details = None: 详细错误信息，是一个string到string的dict。

request_id = None: 请求ID，用于跟踪一个OSS请求。提交工单时，最好能够提供请求ID。

status = None: HTTP 状态码（比如200）

exception oss2.exceptions.PositionNotEqualToLength(status, headers, body, details)[源代码]: 基类：

status = 409

exception oss2.exceptions.PreconditionFailed(status, headers, body, details)[源代码]: 基类：

status = 412

exception oss2.exceptions.RequestError(e)[源代码]: 基类：; 基类：

status = 409

exception oss2.exceptions.ServerError(status, headers, body, details)[源代码]: 基类：

oss2.http module

oss2.http

这个模块包含了HTTP Adapters。尽管OSS Python SDK内部使用requests库进行HTTP通信，但是对使用者是透明的。该模块中的 Session、 Request、 Response 对requests的对应的类做了简单的封装。

class oss2.http.Request(method, url, data=None, params=None, headers=None, app_name='')[源代码]: 基类：object

class oss2.http.Response(response)[源代码]

基类：object

read(amt=None)[源代码]

class oss2.http.Session[源代码]

基类：object

属于同一个Session的请求共享一组连接池，如有可能也会重用HTTP连接。

do_request(req, timeout)[源代码]

oss2.iterators module

oss2.iterators

该模块包含了一些易于使用的迭代器，可以用来遍历Bucket、文件、分片上传等。

class oss2.iterators.BucketIterator(service, prefix='', marker='', max_keys=100, max_retries=None)[源代码]