如何通過PythonSDK實現禁止同名檔案的覆蓋 - Object Storage Service

預設情況下，如果新添加檔案與現有檔案（Object）同名且對該檔案有存取權限，則新添加的檔案將覆蓋原有的檔案。本文介紹如何通過佈建要求頭x-oss-forbid-overwrite在簡單上傳、拷貝檔案及分區上傳等情境中禁止覆蓋同名檔案。

注意事項

本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS訪問網域名稱、資料中心、開放連接埠。
本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見初始化。

簡單上傳

以下代碼用於簡單上傳時禁止覆蓋同名檔案：

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# 上傳檔案。
# 指定PutObject操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = {'x-oss-forbid-overwrite': 'true'}
result = bucket.put_object('yourObjectName', 'content of object', headers=headers)

# HTTP返回碼。
print('http status: {0}'.format(result.status))
# 請求ID。請求ID是請求的唯一標識，強烈建議在程式日誌中添加此參數。
print('request_id: {0}'.format(result.request_id))
# ETag是put_object方法傳回值特有的屬性。
print('ETag: {0}'.format(result.etag))
# HTTP回應標頭部。
print('date: {0}'.format(result.headers['date']))

拷貝檔案

拷貝小檔案

以下代碼用於拷貝小檔案時禁止覆蓋同名檔案：

# -*- coding: utf-8 -*-
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')

# 指定copy_object操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = dict()
headers = {'x-oss-forbid-overwrite':'true'}
bucket.copy_object('yourSourceBucketName', 'yourSourceObjectName', 'yourDestinationObjectName', headers=headers)

拷貝大檔案

以下代碼用於拷貝大檔案（分區拷貝）時禁止覆蓋同名檔案：

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
from oss2.models import PartInfo
from oss2 import determine_part_size
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

src_object = 'yourSourceObjectName'
dst_object = 'yourDestinationObjectName'

total_size = bucket.head_object(src_object).content_length
part_size = determine_part_size(total_size, preferred_size=100 * 1024)

# 初始化分區。
# 指定拷貝檔案操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = dict()
headers = {'x-oss-forbid-overwrite': 'true'}
upload_id = bucket.init_multipart_upload(dst_object, headers=headers).upload_id
parts = []

# 逐個分區拷貝。
part_number = 1
offset = 0
while offset < total_size:
    num_to_upload = min(part_size, total_size - offset)
    byte_range = (offset, offset + num_to_upload - 1)

    result = bucket.upload_part_copy(bucket.bucket_name, src_object, byte_range, dst_object, upload_id, part_number)
    parts.append(PartInfo(part_number, result.etag))

    offset += num_to_upload
    part_number += 1

# 完成分區拷貝。
# 指定拷貝檔案操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = dict()
headers = {'x-oss-forbid-overwrite':'true'}
bucket.complete_multipart_upload(dst_object, upload_id, parts, headers=headers)

分區上傳

以下代碼用於分區上傳時禁止覆蓋同名檔案：

# -*- coding: utf-8 -*-
import os
from oss2 import SizedFileAdapter, determine_part_size
from oss2.models import PartInfo
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# yourBucketName填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

key = 'yourObjectName'
filename = 'yourLocalFile'

total_size = os.path.getsize(filename)
# determine_part_size方法用來確定分區大小。
part_size = determine_part_size(total_size, preferred_size=100 * 1024)

# 初始化分區。
# 指定分區上傳操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = {'x-oss-forbid-overwrite': 'true'}
upload_id = bucket.init_multipart_upload(key, headers=headers).upload_id
parts = []

# 逐個上傳分區。
with open(filename, 'rb') as fileobj:
    part_number = 1
    offset = 0
    while offset < total_size:
        num_to_upload = min(part_size, total_size - offset)
        # SizedFileAdapter(fileobj, size)方法會產生一個新的檔案對象，重新計算起始追加位置。
        result = bucket.upload_part(key, upload_id, part_number,
                                    SizedFileAdapter(fileobj, num_to_upload))
        parts.append(PartInfo(part_number, result.etag))

        offset += num_to_upload
        part_number += 1

# 完成分區上傳。
# 指定分區上傳操作時是否覆蓋同名Object。
# 不指定x-oss-forbid-overwrite時，預設覆蓋同名Object。
# 指定x-oss-forbid-overwrite為false時，表示允許覆蓋同名Object。
# 指定x-oss-forbid-overwrite為true時，表示禁止覆蓋同名Object，如果同名Object已存在，程式將報錯。
headers = {'x-oss-forbid-overwrite': 'true'}
bucket.complete_multipart_upload(key, upload_id, parts, headers=headers)

# 驗證分區上傳。
with open(filename, 'rb') as fileobj:
    assert bucket.get_object(key).read() == fileobj.read()

Object Storage Service：Python禁止覆蓋同名檔案

注意事項

簡單上傳

拷貝檔案

分區上傳

相關文檔