跳转至

File类

File类

File

文件相关操作封装

Source code in src/cpan115/File.py 
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
class File:
    """文件相关操作封装"""

    def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None):
        """初始化

        Args:
            auth: 已授权的 Auth 实例
            userinfo: 可选的用户信息模型
        """
        self.auth = auth
        self.userinfo = userinfo

    @validate_call
    def add(self, pid: int | str, file_name: str) -> dict:
        """新建文件夹

        Args:
            pid: 新建文件夹所在的父目录ID (根目录的ID为0)
            file_name: 新建文件夹名称, 限制255个字符

        Returns:
            包含新建文件夹的信息

        """
        assert str(pid).isdigit() and int(pid) >= 0, "pid 必须是非负整数"

        data = {"pid": str(pid), "file_name": file_name}
        resp = self.auth.request_json("POST", API.FilePath.FOLDER_ADD, data=data)
        return resp

    @validate_call
    def files(
        self,
        cid: int | None = None,
        type: int | None = None,
        limit: int = 20,
        offset: int = 0,
        suffix: str | None = None,
        asc: int | None = None,
        o: SortField | None = None,
        custom_order: int | None = None,
        stdir: int | None = None,
        star: int | None = None,
        cur: int | None = None,
        show_dir: int = 0,
    ) -> dict:
        """获取文件列表

        获取指定目录下的文件列表

        Args:
            cid:        目录ID, 对应parent_id
            type:       文件类型；1.文档；2.图片；3.音乐；4.视频；5.压缩；6.应用；7.书籍
            limit:      查询数量, 默认20, 最大1150
            offset:     查询起始位, 默认0
            suffix:     文件后缀名
            asc:        排序, 1: 升序 0: 降序
            o:          排序字段, file_name: 文件名 file_size: 文件大小 user_utime: 更新时间 file_type 文件类型
            custom_order: 是否使用记忆排序。1 使用自定义排序, 不使用记忆排序,0 使用记忆排序, 自定义排序失效,2自定义排序, 非文件夹置顶
            stdir:          筛选文件时, 是否显示文件夹；1:要展示文件夹 0不展示
            star:        筛选星标文件, 1:是 0全部
            cur:         是否只显示当前文件夹内文件
            show_dir:   是否显示目录；0 或 1, 默认为0, 解读: 1表示显示目录和文件, 0表示只显示文件

        Returns:
            包含文件列表信息

        Example:
            解读:
            - 当show_dir=0 且 cur=True时, 表示只显示当前目录下的所有文件,不显示目录(不含子文件夹内文件)

            - 当show_dir=0 且 cur=False时,表 示显示当前目录下的所有文件,不显示目录(含子文件夹内文件)

            - 当show_dir=1 且 cur=False时,表示显示当前目录下的所有文件和目录(不含子文件夹内文件)

            - 当show_dir=1 且 cur=True时, 表示只显示当前目录下的文件和目录(不含子文件夹内文件)

        """
        params = FilesListParams(
            cid=cid,
            type=type,
            limit=limit,
            offset=offset,
            suffix=suffix,
            asc=asc,
            o=o,
            custom_order=custom_order,
            stdir=stdir,
            star=star,
            cur=cur,
            show_dir=show_dir,
        )
        data = params.model_dump(exclude_none=True)

        resp = self.auth.request_json("GET", API.FilePath.UFILE_FILES, params=data)
        return resp

    def get_info(self, file_id: int | None = None, path: str | None = None) -> dict:
        """获取文件(夹)详情

        获取文件(夹)详情

        Args:
            file_id: 文件ID
            path: 文件路径,  二者选一传入即可,如果都传入则以 file_id 为准

        Returns:
            包含文件信息

        """
        assert file_id is None or path is None, "file_id 和 path 不能同时为None"

        if file_id == 0 or path == "/":
            raise ValueError("不能传递根目录的 file_id 或 path 参数")
        elif file_id is None:
            params = {"path": path}
        else:
            assert file_id is not None and file_id >= 0, "file_id 必须是非负整数"
            params = {"file_id": str(file_id)}

        resp = self.auth.request_json("GET", API.FilePath.FOLDER_INFO, params=params)
        return resp

    @validate_call
    def search(
        self,
        search_value: str,
        limit: int = 20,
        offset: int = 0,
        file_label: str | None = None,
        cid: int | None = None,
        gte_day: str | None = None,
        lte_day: str | None = None,
        fc: int | None = None,
        type: int | None = None,
        suffix: str | None = None,
    ) -> dict:
        """搜索文件

        Args:
            search_value: 查找关键字
            limit: 单页记录数, 默认20, offset+limit最大不超过10000
            offset: 数据显示偏移量
            file_label: 文件标签搜索
            cid: 目标目录cid
            gte_day: 开始时间, 格式 2020-11-19
            lte_day: 结束时间, 格式2020-11-20
            fc: 只显示文件或文件夹。1 只显示文件夹, 2 只显示文件
            type: 文件类型, 1: 文档, 2: 图片, 3: 音乐, 4: 视频, 5: 压缩包, 6: 应用
            suffix: 文件后缀名
        """
        params = FileSearchParams(
            search_value=search_value,
            limit=limit,
            offset=offset,
            file_label=file_label,
            cid=cid,
            gte_day=gte_day,
            lte_day=lte_day,
            fc=fc,
            type=type,
            suffix=suffix,
        )

        data = params.model_dump(exclude_none=True)
        resp = self.auth.request_json("GET", API.FilePath.UFILE_SEARCH, params=data)
        return resp

    @validate_call
    def copy(self, pid: int, file_id: int | list[int], nodupli: int | None = None) -> dict:
        """文件复制

        批量复制文件

        Args:
            pid: 目标目录，即所需移动到的目录ID
            file_id: 所复制的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
            nodupli: 复制的文件在目标目录是否允许重复，默认0：0：可以；1：不可以

        Returns:
            包含复制结果信息

        """
        assert pid >= 0, "pid 必须是非负整数"

        if isinstance(file_id, list):
            file_id_str = ",".join(str(fid) for fid in file_id)
        else:
            file_id_str = str(file_id)

        data: dict[str, str] = {"pid": str(pid), "file_id": file_id_str}
        if nodupli is not None:
            data["nodupli"] = str(nodupli)

        resp = self.auth.request_json("POST", API.FilePath.UFILE_COPY, data=data)
        return resp

    @validate_call
    def move(self, file_ids: list[int] | int, to_cid: int) -> dict:
        """文件移动

        批量移动文件

        Args:
            file_ids: 所移动的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
            to_cid: 要移动所在的目录ID，根目录为0

        """
        assert to_cid >= 0, "to_cid 必须是非负整数"

        if isinstance(file_ids, list):
            file_ids_str = ",".join(str(fid) for fid in file_ids)
        else:
            file_ids_str = str(file_ids)

        data = {"to_cid": to_cid, "file_ids": file_ids_str}
        resp = self.auth.request_json("POST", API.FilePath.UFILE_MOVE, data=data)
        return resp

    @validate_call
    def downurl(self, pick_code: str) -> dict:
        """获取文件下载地址

        根据文件提取码取文件下载地址

        Args:
            pick_code: 文件提取码

        Returns:
            包含文件下载地址信息

        """

        params = {"pick_code": pick_code}
        resp = self.auth.request_json("POST", API.FilePath.UFILE_DOWNURL, data=params)
        if not resp.get("data"):
            print("提取码对应的文件不存在或提取码错误，下载地址为空")
        return resp

    @validate_call
    def update(self, file_id: int, file_name: str | None = None, star: int | None = None) -> dict:
        """文件(夹)更新

        更新文件名或星标文件

        Args:
            file_id: 需要更改名字的文件(夹)ID
            file_name: 新的文件(夹)名字(文件夹名称限制255字节)
            star: 是否星标；1：星标；0：取消星标

        Returns:
            包含更新结果信息
        """
        assert file_name is not None or star is not None, "file_name 和 star 不能同时为 None"

        params: dict[str, Any] = {"file_id": file_id}
        if file_name is not None:
            params["file_name"] = str(file_name)
        if star is not None:
            params["star"] = star

        resp = self.auth.request_json("POST", API.FilePath.UFILE_UPDATE, data=params)
        return resp

    @validate_call
    def delete(self, file_ids: list[int] | int, parent_id: int | None = None) -> dict:
        """删除文件

        批量删除文件(夹)


        Args:
            file_ids: 需要删除的文件(夹)ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
            parent_id: 删除的文件(夹)ID所在的父目录ID
        """
        if isinstance(file_ids, list):
            file_ids_str = ",".join(str(fid) for fid in file_ids)
        else:
            file_ids_str = str(file_ids)

        data = {"file_ids": file_ids_str, "parent_id": parent_id}
        data = {k: v for k, v in data.items() if v is not None}
        resp = self.auth.request_json("POST", API.FilePath.UFILE_DELETE, data=data)
        return resp

__init__ 

__init__(auth: Auth, userinfo: UserInfoModel | None = None)

初始化

Parameters:

Name Type Description Default
auth Auth

已授权的 Auth 实例

 required
userinfo UserInfoModel | None

可选的用户信息模型

 None
Source code in src/cpan115/File.py 
16
17
18
19
20
21
22
23
24
def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None):
    """初始化

    Args:
        auth: 已授权的 Auth 实例
        userinfo: 可选的用户信息模型
    """
    self.auth = auth
    self.userinfo = userinfo

add 

add(pid: int | str, file_name: str) -> dict

新建文件夹

Parameters:

Name Type Description Default
pid int | str

新建文件夹所在的父目录ID (根目录的ID为0)

 required
file_name str

新建文件夹名称, 限制255个字符

 required

Returns:

Type Description
dict

包含新建文件夹的信息
Source code in src/cpan115/File.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@validate_call
def add(self, pid: int | str, file_name: str) -> dict:
    """新建文件夹

    Args:
        pid: 新建文件夹所在的父目录ID (根目录的ID为0)
        file_name: 新建文件夹名称, 限制255个字符

    Returns:
        包含新建文件夹的信息

    """
    assert str(pid).isdigit() and int(pid) >= 0, "pid 必须是非负整数"

    data = {"pid": str(pid), "file_name": file_name}
    resp = self.auth.request_json("POST", API.FilePath.FOLDER_ADD, data=data)
    return resp

files 

files(
    cid: int | None = None,
    type: int | None = None,
    limit: int = 20,
    offset: int = 0,
    suffix: str | None = None,
    asc: int | None = None,
    o: SortField | None = None,
    custom_order: int | None = None,
    stdir: int | None = None,
    star: int | None = None,
    cur: int | None = None,
    show_dir: int = 0,
) -> dict

获取文件列表

获取指定目录下的文件列表

Parameters:

Name Type Description Default
cid int | None

目录ID, 对应parent_id

 None
type int | None

文件类型；1.文档；2.图片；3.音乐；4.视频；5.压缩；6.应用；7.书籍

 None
limit int

查询数量, 默认20, 最大1150

 20
offset int

查询起始位, 默认0

 0
suffix str | None

文件后缀名

 None
asc int | None

排序, 1: 升序 0: 降序

 None
o SortField | None

排序字段, file_name: 文件名 file_size: 文件大小 user_utime: 更新时间 file_type 文件类型

 None
custom_order int | None

是否使用记忆排序。1 使用自定义排序, 不使用记忆排序,0 使用记忆排序, 自定义排序失效,2自定义排序, 非文件夹置顶

 None
stdir int | None

筛选文件时, 是否显示文件夹；1:要展示文件夹 0不展示

 None
star int | None

筛选星标文件, 1:是 0全部

 None
cur int | None

是否只显示当前文件夹内文件

 None
show_dir int

是否显示目录；0 或 1, 默认为0, 解读: 1表示显示目录和文件, 0表示只显示文件

 0

Returns:

Type Description
dict

包含文件列表信息
Example

解读: - 当show_dir=0 且 cur=True时, 表示只显示当前目录下的所有文件,不显示目录(不含子文件夹内文件)

  • 当show_dir=0 且 cur=False时,表 示显示当前目录下的所有文件,不显示目录(含子文件夹内文件)

  • 当show_dir=1 且 cur=False时,表示显示当前目录下的所有文件和目录(不含子文件夹内文件)

  • 当show_dir=1 且 cur=True时, 表示只显示当前目录下的文件和目录(不含子文件夹内文件)

Source code in src/cpan115/File.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@validate_call
def files(
    self,
    cid: int | None = None,
    type: int | None = None,
    limit: int = 20,
    offset: int = 0,
    suffix: str | None = None,
    asc: int | None = None,
    o: SortField | None = None,
    custom_order: int | None = None,
    stdir: int | None = None,
    star: int | None = None,
    cur: int | None = None,
    show_dir: int = 0,
) -> dict:
    """获取文件列表

    获取指定目录下的文件列表

    Args:
        cid:        目录ID, 对应parent_id
        type:       文件类型；1.文档；2.图片；3.音乐；4.视频；5.压缩；6.应用；7.书籍
        limit:      查询数量, 默认20, 最大1150
        offset:     查询起始位, 默认0
        suffix:     文件后缀名
        asc:        排序, 1: 升序 0: 降序
        o:          排序字段, file_name: 文件名 file_size: 文件大小 user_utime: 更新时间 file_type 文件类型
        custom_order: 是否使用记忆排序。1 使用自定义排序, 不使用记忆排序,0 使用记忆排序, 自定义排序失效,2自定义排序, 非文件夹置顶
        stdir:          筛选文件时, 是否显示文件夹；1:要展示文件夹 0不展示
        star:        筛选星标文件, 1:是 0全部
        cur:         是否只显示当前文件夹内文件
        show_dir:   是否显示目录；0 或 1, 默认为0, 解读: 1表示显示目录和文件, 0表示只显示文件

    Returns:
        包含文件列表信息

    Example:
        解读:
        - 当show_dir=0 且 cur=True时, 表示只显示当前目录下的所有文件,不显示目录(不含子文件夹内文件)

        - 当show_dir=0 且 cur=False时,表 示显示当前目录下的所有文件,不显示目录(含子文件夹内文件)

        - 当show_dir=1 且 cur=False时,表示显示当前目录下的所有文件和目录(不含子文件夹内文件)

        - 当show_dir=1 且 cur=True时, 表示只显示当前目录下的文件和目录(不含子文件夹内文件)

    """
    params = FilesListParams(
        cid=cid,
        type=type,
        limit=limit,
        offset=offset,
        suffix=suffix,
        asc=asc,
        o=o,
        custom_order=custom_order,
        stdir=stdir,
        star=star,
        cur=cur,
        show_dir=show_dir,
    )
    data = params.model_dump(exclude_none=True)

    resp = self.auth.request_json("GET", API.FilePath.UFILE_FILES, params=data)
    return resp

get_info 

get_info(
    file_id: int | None = None, path: str | None = None
) -> dict

获取文件(夹)详情

获取文件(夹)详情

Parameters:

Name Type Description Default
file_id int | None

文件ID

 None
path str | None

文件路径, 二者选一传入即可,如果都传入则以 file_id 为准

 None

Returns:

Type Description
dict

包含文件信息
Source code in src/cpan115/File.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def get_info(self, file_id: int | None = None, path: str | None = None) -> dict:
    """获取文件(夹)详情

    获取文件(夹)详情

    Args:
        file_id: 文件ID
        path: 文件路径,  二者选一传入即可,如果都传入则以 file_id 为准

    Returns:
        包含文件信息

    """
    assert file_id is None or path is None, "file_id 和 path 不能同时为None"

    if file_id == 0 or path == "/":
        raise ValueError("不能传递根目录的 file_id 或 path 参数")
    elif file_id is None:
        params = {"path": path}
    else:
        assert file_id is not None and file_id >= 0, "file_id 必须是非负整数"
        params = {"file_id": str(file_id)}

    resp = self.auth.request_json("GET", API.FilePath.FOLDER_INFO, params=params)
    return resp

search 

search(
    search_value: str,
    limit: int = 20,
    offset: int = 0,
    file_label: str | None = None,
    cid: int | None = None,
    gte_day: str | None = None,
    lte_day: str | None = None,
    fc: int | None = None,
    type: int | None = None,
    suffix: str | None = None,
) -> dict

搜索文件

Parameters:

Name Type Description Default
search_value str

查找关键字

 required
limit int

单页记录数, 默认20, offset+limit最大不超过10000

 20
offset int

数据显示偏移量

 0
file_label str | None

文件标签搜索

 None
cid int | None

目标目录cid

 None
gte_day str | None

开始时间, 格式 2020-11-19

 None
lte_day str | None

结束时间, 格式2020-11-20

 None
fc int | None

只显示文件或文件夹。1 只显示文件夹, 2 只显示文件

 None
type int | None

文件类型, 1: 文档, 2: 图片, 3: 音乐, 4: 视频, 5: 压缩包, 6: 应用

 None
suffix str | None

文件后缀名

 None
Source code in src/cpan115/File.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
@validate_call
def search(
    self,
    search_value: str,
    limit: int = 20,
    offset: int = 0,
    file_label: str | None = None,
    cid: int | None = None,
    gte_day: str | None = None,
    lte_day: str | None = None,
    fc: int | None = None,
    type: int | None = None,
    suffix: str | None = None,
) -> dict:
    """搜索文件

    Args:
        search_value: 查找关键字
        limit: 单页记录数, 默认20, offset+limit最大不超过10000
        offset: 数据显示偏移量
        file_label: 文件标签搜索
        cid: 目标目录cid
        gte_day: 开始时间, 格式 2020-11-19
        lte_day: 结束时间, 格式2020-11-20
        fc: 只显示文件或文件夹。1 只显示文件夹, 2 只显示文件
        type: 文件类型, 1: 文档, 2: 图片, 3: 音乐, 4: 视频, 5: 压缩包, 6: 应用
        suffix: 文件后缀名
    """
    params = FileSearchParams(
        search_value=search_value,
        limit=limit,
        offset=offset,
        file_label=file_label,
        cid=cid,
        gte_day=gte_day,
        lte_day=lte_day,
        fc=fc,
        type=type,
        suffix=suffix,
    )

    data = params.model_dump(exclude_none=True)
    resp = self.auth.request_json("GET", API.FilePath.UFILE_SEARCH, params=data)
    return resp

copy 

copy(
    pid: int,
    file_id: int | list[int],
    nodupli: int | None = None,
) -> dict

文件复制

批量复制文件

Parameters:

Name Type Description Default
pid int

目标目录，即所需移动到的目录ID

 required
file_id int | list[int]

所复制的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)

 required
nodupli int | None

复制的文件在目标目录是否允许重复，默认0：0：可以；1：不可以

 None

Returns:

Type Description
dict

包含复制结果信息
Source code in src/cpan115/File.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
@validate_call
def copy(self, pid: int, file_id: int | list[int], nodupli: int | None = None) -> dict:
    """文件复制

    批量复制文件

    Args:
        pid: 目标目录，即所需移动到的目录ID
        file_id: 所复制的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
        nodupli: 复制的文件在目标目录是否允许重复，默认0：0：可以；1：不可以

    Returns:
        包含复制结果信息

    """
    assert pid >= 0, "pid 必须是非负整数"

    if isinstance(file_id, list):
        file_id_str = ",".join(str(fid) for fid in file_id)
    else:
        file_id_str = str(file_id)

    data: dict[str, str] = {"pid": str(pid), "file_id": file_id_str}
    if nodupli is not None:
        data["nodupli"] = str(nodupli)

    resp = self.auth.request_json("POST", API.FilePath.UFILE_COPY, data=data)
    return resp

move 

move(file_ids: list[int] | int, to_cid: int) -> dict

文件移动

批量移动文件

Parameters:

Name Type Description Default
file_ids list[int] | int

所移动的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)

 required
to_cid int

要移动所在的目录ID，根目录为0

 required
Source code in src/cpan115/File.py 
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
@validate_call
def move(self, file_ids: list[int] | int, to_cid: int) -> dict:
    """文件移动

    批量移动文件

    Args:
        file_ids: 所移动的文件和目录ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
        to_cid: 要移动所在的目录ID，根目录为0

    """
    assert to_cid >= 0, "to_cid 必须是非负整数"

    if isinstance(file_ids, list):
        file_ids_str = ",".join(str(fid) for fid in file_ids)
    else:
        file_ids_str = str(file_ids)

    data = {"to_cid": to_cid, "file_ids": file_ids_str}
    resp = self.auth.request_json("POST", API.FilePath.UFILE_MOVE, data=data)
    return resp

downurl 

downurl(pick_code: str) -> dict

获取文件下载地址

根据文件提取码取文件下载地址

Parameters:

Name Type Description Default
pick_code str

文件提取码

 required

Returns:

Type Description
dict

包含文件下载地址信息
Source code in src/cpan115/File.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
@validate_call
def downurl(self, pick_code: str) -> dict:
    """获取文件下载地址

    根据文件提取码取文件下载地址

    Args:
        pick_code: 文件提取码

    Returns:
        包含文件下载地址信息

    """

    params = {"pick_code": pick_code}
    resp = self.auth.request_json("POST", API.FilePath.UFILE_DOWNURL, data=params)
    if not resp.get("data"):
        print("提取码对应的文件不存在或提取码错误，下载地址为空")
    return resp

update 

update(
    file_id: int,
    file_name: str | None = None,
    star: int | None = None,
) -> dict

文件(夹)更新

更新文件名或星标文件

Parameters:

Name Type Description Default
file_id int

需要更改名字的文件(夹)ID

 required
file_name str | None

新的文件(夹)名字(文件夹名称限制255字节)

 None
star int | None

是否星标；1：星标；0：取消星标

 None

Returns:

Type Description
dict

包含更新结果信息
Source code in src/cpan115/File.py 
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
@validate_call
def update(self, file_id: int, file_name: str | None = None, star: int | None = None) -> dict:
    """文件(夹)更新

    更新文件名或星标文件

    Args:
        file_id: 需要更改名字的文件(夹)ID
        file_name: 新的文件(夹)名字(文件夹名称限制255字节)
        star: 是否星标；1：星标；0：取消星标

    Returns:
        包含更新结果信息
    """
    assert file_name is not None or star is not None, "file_name 和 star 不能同时为 None"

    params: dict[str, Any] = {"file_id": file_id}
    if file_name is not None:
        params["file_name"] = str(file_name)
    if star is not None:
        params["star"] = star

    resp = self.auth.request_json("POST", API.FilePath.UFILE_UPDATE, data=params)
    return resp

delete 

delete(
    file_ids: list[int] | int, parent_id: int | None = None
) -> dict

删除文件

批量删除文件(夹)

Parameters:

Name Type Description Default
file_ids list[int] | int

需要删除的文件(夹)ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)

 required
parent_id int | None

删除的文件(夹)ID所在的父目录ID

 None
Source code in src/cpan115/File.py 
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
@validate_call
def delete(self, file_ids: list[int] | int, parent_id: int | None = None) -> dict:
    """删除文件

    批量删除文件(夹)


    Args:
        file_ids: 需要删除的文件(夹)ID，多个文件和目录请以, 隔开(这里直接传入整数列表或单个整数)
        parent_id: 删除的文件(夹)ID所在的父目录ID
    """
    if isinstance(file_ids, list):
        file_ids_str = ",".join(str(fid) for fid in file_ids)
    else:
        file_ids_str = str(file_ids)

    data = {"file_ids": file_ids_str, "parent_id": parent_id}
    data = {k: v for k, v in data.items() if v is not None}
    resp = self.auth.request_json("POST", API.FilePath.UFILE_DELETE, data=data)
    return resp

回收站

Rb

文件相关操作封装

Source code in src/cpan115/Rb.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class Rb:
    """文件相关操作封装"""

    def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None):
        """初始化

        Args:
            auth: 已授权的 Auth 实例
            userinfo: 可选的用户信息模型
        """
        self.auth = auth
        self.userinfo = userinfo

    @validate_call
    def lists(self, limit: int = Field(30, ge=1, le=200), offset: int = Field(0, ge=0)) -> dict:
        """回收站列表


        回收站列表

        Args:
            limit:      单页记录数，int，默认30，最大200
            offset:     数据显示偏移量

        Returns:
            包含文件列表信息

        """
        params = {"limit": limit, "offset": offset}
        resp = self.auth.request_json("GET", API.FilePath.RB_LIST, params=params)
        return resp

    @validate_call
    def revert(self, tid: list[int] | int) -> dict:
        """还原回收站文件

        还原回收站文件(夹)

        Args:
            tid:   需要还原的ID，可多个，用半角逗号分开，最多1150个

        Returns:
            包含还原结果

        """
        if isinstance(tid, list):
            tid_str = ",".join(str(t) for t in tid)
        else:
            tid_str = str(tid)

        payload = {"tid": tid_str}
        resp = self.auth.request_json("POST", API.FilePath.RB_REVERT, data=payload)
        return resp

    @validate_call
    def delete(self, tid: list[int] | int | None = None) -> dict:
        """彻底删除回收站文件

        批量删除回收站文件、清空回收站

        Args:
            tid:  需要删除的文件的Id,如若不传就是清空回收站(最多支持1150个)

        Returns:
            包含删除结果

        """
        if tid is None:
            payload = {}
        elif isinstance(tid, list):
            tid_str = ",".join(str(t) for t in tid)
            payload = {"tid": tid_str}
        elif isinstance(tid, int):
            payload = {"tid": str(tid)}
        else:
            payload = {}
        resp = self.auth.request_json("POST", API.FilePath.RB_DELETE, data=payload)
        return resp

__init__ 

__init__(auth: Auth, userinfo: UserInfoModel | None = None)

初始化

Parameters:

Name Type Description Default
auth Auth

已授权的 Auth 实例

 required
userinfo UserInfoModel | None

可选的用户信息模型

 None
Source code in src/cpan115/Rb.py 
11
12
13
14
15
16
17
18
19
def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None):
    """初始化

    Args:
        auth: 已授权的 Auth 实例
        userinfo: 可选的用户信息模型
    """
    self.auth = auth
    self.userinfo = userinfo

lists 

lists(
    limit: int = Field(30, ge=1, le=200),
    offset: int = Field(0, ge=0),
) -> dict

回收站列表

回收站列表

Parameters:

Name Type Description Default
limit int

单页记录数，int，默认30，最大200

 Field(30, ge=1, le=200)
offset int

数据显示偏移量

 Field(0, ge=0)

Returns:

Type Description
dict

包含文件列表信息
Source code in src/cpan115/Rb.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@validate_call
def lists(self, limit: int = Field(30, ge=1, le=200), offset: int = Field(0, ge=0)) -> dict:
    """回收站列表


    回收站列表

    Args:
        limit:      单页记录数，int，默认30，最大200
        offset:     数据显示偏移量

    Returns:
        包含文件列表信息

    """
    params = {"limit": limit, "offset": offset}
    resp = self.auth.request_json("GET", API.FilePath.RB_LIST, params=params)
    return resp

revert 

revert(tid: list[int] | int) -> dict

还原回收站文件

还原回收站文件(夹)

Parameters:

Name Type Description Default
tid list[int] | int

需要还原的ID，可多个，用半角逗号分开，最多1150个

 required

Returns:

Type Description
dict

包含还原结果
Source code in src/cpan115/Rb.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@validate_call
def revert(self, tid: list[int] | int) -> dict:
    """还原回收站文件

    还原回收站文件(夹)

    Args:
        tid:   需要还原的ID，可多个，用半角逗号分开，最多1150个

    Returns:
        包含还原结果

    """
    if isinstance(tid, list):
        tid_str = ",".join(str(t) for t in tid)
    else:
        tid_str = str(tid)

    payload = {"tid": tid_str}
    resp = self.auth.request_json("POST", API.FilePath.RB_REVERT, data=payload)
    return resp

delete 

delete(tid: list[int] | int | None = None) -> dict

彻底删除回收站文件

批量删除回收站文件、清空回收站

Parameters:

Name Type Description Default
tid list[int] | int | None

需要删除的文件的Id,如若不传就是清空回收站(最多支持1150个)

 None

Returns:

Type Description
dict

包含删除结果
Source code in src/cpan115/Rb.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@validate_call
def delete(self, tid: list[int] | int | None = None) -> dict:
    """彻底删除回收站文件

    批量删除回收站文件、清空回收站

    Args:
        tid:  需要删除的文件的Id,如若不传就是清空回收站(最多支持1150个)

    Returns:
        包含删除结果

    """
    if tid is None:
        payload = {}
    elif isinstance(tid, list):
        tid_str = ",".join(str(t) for t in tid)
        payload = {"tid": tid_str}
    elif isinstance(tid, int):
        payload = {"tid": str(tid)}
    else:
        payload = {}
    resp = self.auth.request_json("POST", API.FilePath.RB_DELETE, data=payload)
    return resp