Skip to main content

Aliyun OSS SDK for Python

https://badge.fury.io/py/oss2.svg https://travis-ci.org/aliyun/aliyun-oss-python-sdk.svg?branch=master https://coveralls.io/repos/github/aliyun/aliyun-oss-python-sdk/badge.svg?branch=master

概述

阿里云对象存储Python SDK 2.x版本。该版本不和上一个版本(0.x版本)兼容,包的名称为oss2,以避免和先前的版本冲突。

该版本的SDK依赖于第三方HTTP库 requests 以及 crcmod。 请按照下述安装方法进行安装。

运行环境

Python 2.6,2.7,3.3,3.4,3.5

安装方法

通过pip安装官方发布的版本(以Linux系统为例):

$ pip install oss2

也可以直接安装解压后的安装包:

$ sudo python setup.py install

快速使用

# -*- coding: utf-8 -*-

import oss2

endpoint = 'http://oss-cn-hangzhou.aliyuncs.com' # 假设你的Bucket处于杭州区域

auth = oss2.Auth('<你的AccessKeyId>', '<你的AccessKeySecret>')
bucket = oss2.Bucket(auth, endpoint, '<你的Bucket名>')

# Bucket中的文件名(key)为story.txt
key = 'story.txt'

# 上传
bucket.put_object(key, 'Ali Baba is a happy youth.')

# 下载
bucket.get_object(key).read()

# 删除
bucket.delete_object(key)

# 遍历Bucket里所有文件
for object_info in oss2.ObjectIterator(bucket):
    print(object_info.key)

更多例子请参考examples目录下的代码。

出错处理

除非特别说明,一旦出错,Python SDK的接口就会抛出异常(见oss2.exceptions子模块)。参考下面的例子:

try:
    result = bucket.get_object(key)
    print(result.read())
except oss2.exceptions.NoSuchKey as e:
    print('{0} not found: http_status={1}, request_id={2}'.format(key, e.status, e.request_id))

测试

首先通过环境变量来设置测试所需的AccessKeyId、AccessKeySecret、Endpoint以及Bucket信息(请不要使用生产环境的Bucket)。 以Linux系统为例:

$ export OSS_TEST_ACCESS_KEY_ID=<AccessKeyId>
$ export OSS_TEST_ACCESS_KEY_SECRET=<AccessKeySecret>
$ export OSS_TEST_ENDPOINT=<endpoint>
$ export OSS_TEST_BUCKET=<bucket>

$ export OSS_TEST_STS_ID=<AccessKeyId for testing STS>
$ export OSS_TEST_STS_KEY=<AccessKeySecret for testing STS>
$ export OSS_TEST_STS_ARN=<Role ARN for testing STS>

然后通过以下方式运行测试:

$ nosetests                          # 请先安装nose

更多使用

联系我们

代码许可

MIT许可证,参见LICENSE文件。

Release files for oss2r 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for oss2r 0.0.3
File Interpreter ABI Platform
oss2r-0.0.3-py2-none-any.whl Python 2 none any Details

Release files / oss2r-0.0.3-py2-none-any.whl

Download URL oss2r-0.0.3-py2-none-any.whl
Size 46.7 kB
Tags Python 2
SHA-256 checksum
How to use checksums
07fd44595fcf44c043adb855278ff5618e3c775470cec46a3cc1606abda35d05
BLAKE2b-256 checksum
How to use checksums
a753a994822787dcc27c46f0484cec1cc7172d627bc5ba2efd0ba5d812684e2d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.3 This release

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page