Welcome to Qcloud COS SDK for Python 3’s documentation!

class qcloud_cos_py3.cos.CosBucket(app_id, secret_id, secret_key, bucket_name, region='sh')
async_upload_file(file_stream, upload_filename, *, dir_name='', biz_attr='', replace=True, mime='application/octet-stream')

异步上传文件 (使用简单上传文件接口)

Parameters:
  • file_stream – 类文件对象
  • upload_filename – 文件名称
  • dir_name – 目录名称（可选）
  • biz_attr – 业务属性（可选）
  • replace – 是否覆盖（可选）
  • mime – 文件类型，默认为 application/octet-stream (可选)
copy_file(source_file_path, dest_file_path)

拷贝文件

Parameters:
  • source_file_path – 源文件路径
  • dest_file_path – 目标路径
注意:
目标路径若不以 / 开头，则认为是相对路径
create_folder(dir_name, *, biz_attr='')

创建目录

Parameters:
  • dir_name – 目录名
  • biz_attr – 业务属性（可选）
delete_file(file_path)

删除文件

Parameters:file_path – 文件路径
delete_folder(dir_name)

删除目录

Parameters:dir_name – 目录路径
注意:
  • 虚拟目录无法删除，只能删除显式创建的目录
  • 若显式目录中有文件存在，仍可删除该目录，但文件仍然存在于虚拟目录中
get_file(file_path)
Parameters:file_path – 文件路径
list_folder(dir_name, *, prefix=None, num=1000, context=None)

列出目录

Parameters:
  • dir_name – 文件夹名称
  • prefix – 前缀
  • num – 查询的文件的数量，最大支持1000，默认查询数量为1000
  • context –

    起始位置。将上次查询结果的context的字段传入，可实现翻页

    注意：如果在进行列表操作的目录是真实目录而非虚拟目录 (上传文件路径中带有斜线会认为是虚拟目录), 实际列出的文件数量会是 num - 1
move_file(source_file_path, dest_file_path)

移动文件

Parameters:
  • source_file_path – 源文件路径
  • dest_file_path – 目标路径
注意:
目标路径若不以 / 开头，则认为是相对路径
stat_file(file_path)

查询文件属性

Parameters:file_path – 文件路径
stat_folder(dir_name)

查询目录属性

Parameters:dir_name – 目录路径
update_file_status(file_path, *, authority='eInvalid', custom_headers=None)

修改文件属性

Parameters:
  • file_path – 文件路径
  • authority (eInvalid / eWRPrivate / eWPrivateRPublic) – 文件权限
  • custom_headers – 自定义文件头信息
upload_file(file_stream, upload_filename, *, dir_name='', biz_attr='', replace=True, mime='application/octet-stream')

简单上传文件

Parameters:
  • file_stream – 类文件对象
  • upload_filename – 文件名称
  • dir_name – 目录名称（可选）
  • biz_attr – 业务属性（可选）
  • replace – 是否覆盖（可选）
  • mime – 文件类型，默认为 application/octet-stream (可选)
upload_file_from_url(url, file_name, *, dir_name='')

从 url 抓取文件并上传 （使用简单上传文件接口）

Parameters:
  • url – 文件url地址
  • file_name – 文件名称
  • dir_name – 文件夹名称（可选）
upload_slice_file(real_file_path, slice_size, upload_filename, *, offset=0, dir_name='', biz_attr='', replace=True)

分片上传文件

Parameters:
  • real_file_path – 文件路径
  • slice_size –

    分片大小，单位为 Byte，有效取值：

    • 524288 (512 KB)
    • 1048576 (1 MB)
    • 2097152 (2 MB)
    • 3145728 (3 MB)
  • upload_filename – 上传文件名
  • offset – 起始位移（可选），默认从头开始
  • dir_name – 上传目录（可选）
  • biz_attr – 业务属性（可选）
  • replace – 是否覆盖（可选）

Indices and tables