Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Globalization #116

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 38 additions & 38 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,106 +1,106 @@
OSS SDK for Python 版本记录
OSS SDK for Python Release record
===========================

Python SDK的版本号遵循 `Semantic Versioning <http://semver.org/>`_ 规则。
Python SDK version follows `Semantic Versioning <http://semver.org/>`.

Version 2.3.3
-------------

- 修复:RequestResult.resp没有read,链接无法重用
- Fix:No in RequestResult.resp and the link does not work.


Version 2.3.2
-------------

- 修复:issue #70
- Fix:issue #70


Version 2.3.1
-------------

- 修复:#63 增加 `oss2.defaults.logger` 配置项,用户可以设置该变量,来改变缺省的 `logger` (缺省是 `root` logger
- 修复:#66 oss2相关的Adapter中用了__len__()函数会导致requests super_len()函数在32bit Windows上导致不能够上传超过2GB的文件。
- Fix:issue #63 Add `oss2.defaults.logger` config. The default one is 'root logger'.
- Fix:issue #66 oss2 related Adapter uses __len__()function which leads to requests super_len() cannot handle file with more than 2GB size in 32 bit Windows.


Version 2.3.0
-------------

- 增加:符号链接接口 `bucket.put_symlink`,`bucket.get_symlink`
- Add:APIs `bucket.put_symlink`,`bucket.get_symlink`


Version 2.2.3
-------------

- 修复:`bucket.resumable_upload` 的返回值从null修正为PutObjectResult
- 修复:优化 `Response.read` 的字符串拼接方式,提高 `bucket.get_object` 的效率 issue #39
- 修复:`bucket.copy_object` 对source key进行url编码
- Fix:The return value of `bucket.resumable_upload` is corrected as PutObjectResult from null.
- Fix:Improves the way concatenanting string in `Response.read` which improves the efficiency of `bucket.get_object`. Issue #39.
- Fix:Uses the url encoding for source key in `bucket.copy_object`.


Version 2.2.2
-------------

- 修复:upload_part接口加上headers参数
- Fix:Add header parameters in upload_part.


Version 2.2.1
-------------

- 修复:只有当OSS返回x-oss-hash-crc64ecma头部时,才对上传的文件进行CRC64完整性校验。
- Fix:Only does the CRC64 integrity check when x-oss-hash-crc64ecma is returned from OSS.


Version 2.2.0
-------------

- 依赖:增加新的依赖: `crcmod`
- 增加:上传、下载增加了CRC64校验,缺省打开
- 增加:`RTMP` 直播推流相关接口
- 增加:`bucket.get_object_meta()` 接口,用来更为快速的获取文件基本信息
- 修复:`bucket.object_exists()` 接口采用 `bucket.get_object_meta()` 来实现,避免因镜像回源造成的 issue #39
- Dependency:Add a new dependency `crcmod`
- Add:Enable CRC (by default) in upload and download.
- Add:`RTMP` pushing streaming related APIs
- Add:`bucket.get_object_meta()` API for getting basic metadata.
- Fix:`bucket.object_exists()` API is re-implemented with `bucket.get_object_meta()` to solve the "retrieve from source" impact. issue #39

Version 2.1.1
-------------

- 修复:issue #28。
- 修复:正确的设置连接池大小。
- Fix:issue #28。
- Fix:Sets a correct connection pool size.


Version 2.1.0
-------------

- 增加:可以通过 `oss2.defaults.connection_pool_size` 来设置连接池的最大连接数。
- 增加:可以通过 `oss2.resumable_upload` 函数的 `num_threads` 参数指定并发的线程数,来进行并发上传。
- 增加:提供断点下载函数 `oss2.resumable_download`
- 修复:保存断点信息的文件名应该由“规则化”的本地文件名生成;当断点信息文件格式不是json时,删除断点信息文件。
- 修复:修复一些文档的Bug。
- Add:Add a property `oss2.defaults.connection_pool_size` to set the max connection count in connection pool.
- Add:Add the parameter `num_threads` in `oss2.resumable_upload` to specify the thread number of uploading.
- Add:Add `oss2.resumable_download` to resume a download.
- Fix:The checkpoint file name should be generated from normalized local file name; when the checkpoint file is not in JSON format, delete the checkpoint file.
- Fix:Fix some documents bug.

Version 2.0.6
-------------

- 增加:可以通过新增的 `StsAuth` 类,进行STS临时授权
- 增加:加入Travis CI的支持
- 改变:对unit test进行了初步的梳理;
- Add:Support STS authentication by `StsAuth` class.
- Add:Add Travis CI support.
- Update:Initial version of unit test.

Version 2.0.5
-------------

- 改变:缺省的connect timeout由10秒改为60秒。为了兼容老的requests库(版本低于2.4.0),目前connect timeout和read timeout是同一个值,为了避免
CopyObject、UploadPartCopy因read timeout超时,故把这个超时时间设长。
- 增加:把 `security-token` 加入到子资源中,参与签名。
- 修复:用户可以通过设置oss2.defaults里的变量值,直接修改缺省参数
- Add:The default connect timeout is changed to 60s from 10s. To be compatible with older request library (< 2.4.0), the connect timeout and read timeout share the same value.
This is to avoid the read timeout in CopyObject、UploadPartCopy因read timeout.
- Add:Add `security-token` into sub resources and get signed.
- Fix:User could set properties in oss2.defaults to change the default value.

Version 2.0.4
-------------

- 改变:增加了unittest目录,原先的tests作为functional test;Tox默认是跑unittest
- 修复:按照依赖明确排除requests 2.9.0。因为 `Issue 2844 <https://github.com/kennethreitz/requests/issues/2844>`_ 导致不能传输UTF-8数据。
- 修复:Object名以'/'开头时,oss server应该报InvalidObjectName,而不是报SignatureDoesNotMatch。原因是URL中对'/'也要做URL编码。
- 修复:MANIFEST.in中改正README.rst等
- Update:Add the folder of unittests. The tests folder now becomes functional tests. Tox runs unittest by default.
- Fix:Remove the dependency of requests 2.9.0. This is due to `Issue 2844 <https://github.com/kennethreitz/requests/issues/2844>`, which leads to UTF-8 data transfer issue.
- Fix:OSS server should return InvalidObjectName error instead of SignatureDoesNotMatch when Object name starts with '/'. The fix is to url encode the '/' in URL.
- Fix:Correct the README.rst in MANIFEST.in.



Version 2.0.3
-------------

- 重新设计Python SDK,不再基于原有的官方0.x.x版本开发。
- 只支持Python2.6及以上版本,支持Python 3。
- 基于requests库
- Redesign the Python SDK. The original offical SDK of version 0.x.x is deprecated.
- Only supports Python2.6 or higher, supports Python 3 as well.
- Adds the dependency on request library.
40 changes: 20 additions & 20 deletions doc/api.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. _api:

API文档
API document
==========

.. module:: oss2

基础类
Base classes
------

.. autoclass:: oss2.Auth
Expand All @@ -15,38 +15,38 @@ API文档
.. autoclass:: oss2.Service
.. autoclass:: oss2.Session

输入、输出和异常说明
Input, Output and Exceptions
------------------

.. automodule:: oss2.api

文件(Object)相关操作
Object operations
--------------------

上传
Upload
~~~~
.. automethod:: oss2.Bucket.put_object
.. automethod:: oss2.Bucket.put_object_from_file
.. automethod:: oss2.Bucket.append_object


下载
Download
~~~~
.. automethod:: oss2.Bucket.get_object
.. automethod:: oss2.Bucket.get_object_to_file


删除
Delete
~~~~
.. automethod:: oss2.Bucket.delete_object
.. automethod:: oss2.Bucket.batch_delete_objects


罗列
List
~~~~
.. automethod:: oss2.Bucket.list_objects

获取、更改文件信息
Get/Update file information
~~~~~~~~~~~~~~~

.. automethod:: oss2.Bucket.head_object
Expand All @@ -57,7 +57,7 @@ API文档
.. automethod:: oss2.Bucket.get_object_meta


分片上传
Multipart upload
~~~~~~~~

.. automethod:: oss2.Bucket.init_multipart_upload
Expand All @@ -68,65 +68,65 @@ API文档
.. automethod:: oss2.Bucket.list_parts


符号链接
Symlink
~~~~~~~~

.. automethod:: oss2.Bucket.put_symlink
.. automethod:: oss2.Bucket.get_symlink


存储空间(Bucket)相关操作
Bucket operations
-------------------------

创建、删除、查询
Create, Delete, Query
~~~~~~~~~~~~~~

.. automethod:: oss2.Bucket.create_bucket
.. automethod:: oss2.Bucket.delete_bucket
.. automethod:: oss2.Bucket.get_bucket_location

Bucket权限管理
Bucket ACL
~~~~~~~~~~~~~~
.. automethod:: oss2.Bucket.put_bucket_acl
.. automethod:: oss2.Bucket.get_bucket_acl


跨域资源共享(CORS
CORS (cross origin resource sharing)
~~~~~~~~~~~~~~~~~~~~
.. automethod:: oss2.Bucket.put_bucket_cors
.. automethod:: oss2.Bucket.get_bucket_cors
.. automethod:: oss2.Bucket.delete_bucket_cors


生命周期管理
Lifecycle management
~~~~~~~~~~~
.. automethod:: oss2.Bucket.put_bucket_lifecycle
.. automethod:: oss2.Bucket.get_bucket_lifecycle
.. automethod:: oss2.Bucket.delete_bucket_lifecycle


日志收集
Logging
~~~~~~~~

.. automethod:: oss2.Bucket.put_bucket_logging
.. automethod:: oss2.Bucket.get_bucket_logging
.. automethod:: oss2.Bucket.delete_bucket_logging

防盗链
Referrer
~~~~~~

.. automethod:: oss2.Bucket.put_bucket_referer
.. automethod:: oss2.Bucket.get_bucket_referer

静态网站托管
Static website
~~~~~~~~~~~~

.. automethod:: oss2.Bucket.put_bucket_website
.. automethod:: oss2.Bucket.get_bucket_website
.. automethod:: oss2.Bucket.delete_bucket_website


RTPM推流操作
RTPM pushing streaming operations
~~~~~~~~~~~~

.. automethod:: oss2.Bucket.create_live_channel
Expand Down
8 changes: 4 additions & 4 deletions doc/easy.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _easy:


易用性接口
interfaces for easy to use
==========

.. module:: oss2

迭代器
Iterators
~~~~~~

.. autoclass:: oss2.BucketIterator
Expand All @@ -16,13 +16,13 @@
.. autoclass:: oss2.PartIterator


断点续传(上传、下载)
Resumable upload or download.
~~~~~~~~~~~~~~~~~~~

.. autofunction:: oss2.resumable_upload
.. autofunction:: oss2.resumable_download

FileObject适配器
FileObject Adapter
~~~~~~~~~~~~~~~~~~

.. autoclass:: oss2.SizedFileAdapter
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Aliyun OSS SDK for Python
=========================


开发文档
Development documentation
--------

.. toctree::
Expand Down
Loading