Object Storage Service：同步處理（Python SDK V2）

注意事項

• 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

方法定義

process_object(request: ProcessObjectRequest, **kwargs) → ProcessObjectResult

請求參數列表

傳回值列表

關於同步處理方法的完整定義，請參見process_object。

範例程式碼

以下代碼展示了如何使用Python SDK V2進行圖片縮放的操作，並將處理後的圖片持久化儲存至指定的Bucket。

import base64
import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：處理對象（如影像處理）
parser = argparse.ArgumentParser(description="process object sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint、對象鍵名、樣式以及目標儲存空間和映像名稱
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)
parser.add_argument('--style', help='The style to apply for processing the object, such as image resizing.', required=True)
parser.add_argument('--target_image', help='Specify the name of the processed image.', required=True)
parser.add_argument('--target_bucket', help='Specify the name of the bucket used to store processed images.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # 使用者提供的樣式參數，用於指定如何處理對象（例如調整映像大小）
    # 例如：style = 'image/resize,m_fixed,w_100,h_100'
    style = args.style

    # 對目標儲存空間名和檔案名稱進行Base64編碼，以確保它們可以在URL中安全傳輸
    target_bucket_base64 = base64.b64encode(args.target_bucket.encode()).decode()
    target_key_base64 = base64.b64encode(args.target_image.encode()).decode()

    # 構建處理指示，包含樣式和儲存位置
    process = f"{style}|sys/saveas,o_{target_key_base64},b_{target_bucket_base64}"

    # 發送請求以處理指定對象並按照給定的樣式儲存到目標儲存空間
    result = client.process_object(oss.ProcessObjectRequest(
        bucket=args.bucket,  # 儲存空間名
        key=args.key,  # 對象鍵名
        process=process,  # 處理指示
    ))

    # 列印操作結果的狀態代碼和其他相關資訊，以便確認請求狀態和處理結果
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket},'
          f' file size: {result.file_size},'
          f' key: {result.key},'
          f' process status: {result.process_status},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

常見使用情境

import base64
import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：處理對象
parser = argparse.ArgumentParser(description="process object sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint、對象鍵名、樣式以及目標儲存空間和映像名稱
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)
parser.add_argument('--target_image', help='Specify the name of the processed image.', required=True)
parser.add_argument('--target_bucket', help='Specify the name of the bucket used to store processed images.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

     # 指定浮水印內容
    content = "阿里雲著作權"

    # 產生圖片盲浮水印
    encoded_content = base64.urlsafe_b64encode(content.encode()).decode()

    style = f"image/blindwatermark,content_{encoded_content}"

    # 對目標儲存空間名和檔案名稱進行Base64編碼，以確保它們可以在URL中安全傳輸
    target_bucket_base64 = base64.b64encode(args.target_bucket.encode()).decode()
    target_key_base64 = base64.b64encode(args.target_image.encode()).decode()

    # 構建處理指示，包含樣式和儲存位置
    process = f"{style}|sys/saveas,o_{target_key_base64},b_{target_bucket_base64}"

    # 發送請求以處理指定對象並按照給定的樣式儲存到目標儲存空間
    result = client.process_object(oss.ProcessObjectRequest(
        bucket=args.bucket,  # 儲存空間名
        key=args.key,  # 對象鍵名
        process=process,  # 處理指示
    ))

    # 列印操作結果的狀態代碼和其他相關資訊，以便確認請求狀態和處理結果
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket},'
          f' file size: {result.file_size},'
          f' key: {result.key},'
          f' process status: {result.process_status},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

相關文檔

• 關於圖片處理參數的更多資訊，請參見圖片處理參數。

• 關於同步處理功能的更多資訊，請參見同步處理。

• 關於同步處理功能的完整範例程式碼，請參見process_object.py。