Python判断文件是否存在

更新时间:2025-03-07 06:13:55

本文介绍如何使用OSS Python SDK判断文件是否存在。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见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()

相关文档

  • 本页导读 (1)
  • 注意事项
  • 方法定义
  • 示例代码
  • 相关文档