AliyunOSS
- class czsc.utils.AliyunOSS(access_key_id: str, access_key_secret: str, endpoint: str, bucket_name: str)[source]
Bases:
object
Methods Summary
batch_download
(oss_keys, local_paths[, ...])批量从OSS下载文件。
batch_upload
(filepaths, oss_keys[, replace, ...])批量上传文件到OSS。
create_folder
(folder_path)在OSS上创建文件夹。
delete_file
(oss_key)从OSS删除文件。
download
(oss_key, filepath[, replace])从OSS下载文件。
download_folder
(oss_folder, local_folder[, ...])从OSS下载指定文件夹。
file_exists
(oss_key)检查文件是否在OSS上存在。
get_file_stream
(oss_key)获取OSS上文件的数据流。
list_files
([prefix, extensions])列举OSS上的文件。
multipart_upload
(filepath, oss_key)分块上传大文件到OSS。
upload
(filepath, oss_key[, replace])上传文件到OSS。
upload_folder
(local_folder, oss_folder[, ...])上传本地文件夹到OSS。
Methods Documentation
- batch_download(oss_keys: List[str], local_paths: List[str], replace: bool = False, threads: int = 5)[source]
批量从OSS下载文件。
- Parameters:
oss_keys – list, 文件在OSS上的路径和名称列表。
local_paths – list, 本地存储文件的路径列表。
threads – int, 并行下载的线程数。默认为5。
- batch_upload(filepaths: List[str], oss_keys: List[str], replace: bool = False, threads: int = 5)[source]
批量上传文件到OSS。
- Parameters:
filepaths – list, 本地文件的路径列表。
oss_keys – list, 文件在OSS上的路径和名称列表。
replace – boolean, 如果为True,将覆盖OSS上的同名文件。默认为False。
threads – int, 并行上传的线程数。默认为5。
- delete_file(oss_key: str) bool [source]
从OSS删除文件。
- Parameters:
oss_key – string, 文件在OSS上的路径和名称。
- Returns:
boolean, 如果删除成功,返回True;否则,返回False.
- download(oss_key: str, filepath: str, replace: bool = False) bool [source]
从OSS下载文件。
- Parameters:
oss_key – string, 文件在OSS上的路径和名称。
filepath – string, 本地存储文件的路径。
- Returns:
boolean, 如果下载成功,返回True;否则,返回False。
- download_folder(oss_folder: str, local_folder: str, threads: int = 5)[source]
从OSS下载指定文件夹。
- Parameters:
oss_folder – string, OSS上的文件夹路径。
local_folder – string, 本地存储文件夹的路径。
threads – int, 并行下载的线程数。默认为5。
- file_exists(oss_key: str) bool [source]
检查文件是否在OSS上存在。
- Parameters:
oss_key – string, 文件在OSS上的路径和名称。
- Returns:
boolean, 如果文件存在,返回True;否则,返回False.
- get_file_stream(oss_key: str) BytesIO [source]
获取OSS上文件的数据流。
- Parameters:
oss_key – string, 文件在OSS上的路径和名称。
- Returns:
BytesIO, 文件的数据流。
- list_files(prefix='', extensions=None)[source]
列举OSS上的文件。
- Parameters:
prefix – string, 列举的文件前缀,默认为空。
extensions – list, 需要列举的文件的后缀名,默认为空,表示列举所有文件。
- Returns:
list, 列举的文件的名称列表。
- multipart_upload(filepath: str, oss_key: str)[source]
分块上传大文件到OSS。
- Parameters:
filepath – string, 本地文件的路径。
oss_key – string, 文件在OSS上的路径和名称。