本文介紹如何使用OSS Python SDK判斷檔案是否存在。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。要判斷檔案是否存在,您必須有
oss:GetObject許可權。具體操作,請參見為RAM使用者授予自訂的權限原則。
方法定義
is_object_exist(bucket: str, key: str, version_id: str | None = None, request_payer: str | None = None, **kwargs) → bool請求參數列表
參數名 | 類型 | 說明 |
bucket | str | 儲存空間名稱 |
key | str | 對象名稱 |
version_id | str | (可選)對象版本號碼 |
傳回值列表
類型 | 說明 |
bool | 判斷檔案是否存在 |
關於判斷檔案是否存在的方法完整定義,請參見is_object_exist。
範例程式碼
您可以使用以下代碼判斷檔案是否存在。
import argparse
import alibabacloud_oss_v2 as oss
# 建立一個命令列參數解析器
parser = argparse.ArgumentParser(description="Check if an object exists in a specified OSS bucket")
# 添加需要的命令列參數
parser.add_argument('--region', help='The region where the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket to check.', required=True)
parser.add_argument('--endpoint', help='Optional: The endpoint URL for the OSS service. If not provided, the default endpoint will be used.')
parser.add_argument('--key', help='The key (or name) of the object to check for existence.', 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
if args.endpoint is not None:
cfg.endpoint = args.endpoint
# 建立OSS用戶端執行個體
client = oss.Client(cfg)
# 調用is_object_exist方法檢查指定的對象是否存在於指定的儲存空間中
result = client.is_object_exist(
bucket=args.bucket,
key=args.key,
)
# 列印對象是否存在
print(f'Object exists: {result}')
# 當指令碼直接運行時執行main函數
if __name__ == "__main__":
main()
相關文檔
關於判斷檔案是否存在的完整範例程式碼,請參見is_object_exist.py.