fs_files

罗列文件列表

这个模块利用 P115Client.fs_files 方法做了一些封装

p115client.tool.fs_files.iter_fs_files(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: None | float = None, max_workers: None | int = None, *, async_: Literal[False] = False, **request_kwargs) → Iterator[dict]

p115client.tool.fs_files.iter_fs_files(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: None | float = None, max_workers: None | int = None, *, async_: Literal[True], **request_kwargs) → AsyncIterator[dict]

拉取一个目录中的文件或目录的数据

Parameters:

• client – 115 网盘客户端对象

• payload – 目录的 id 或者详细的查询参数

• page_size – 分页大小，如果 <= 0，则自动确定

• first_page_size – 首次拉取的分页大小，如果 <= 0，则自动确定

• count – 文件总数

• callback – 回调函数，调用后，会获得一个值，会添加到返回值中，key 为 “callback”

• app – 使用此设备的接口

• raise_for_changed_count – 分批拉取时，发现总数发生变化后，是否报错

• cooldown – 冷却时间，单位为秒。如果为 None，则用默认值（非并发时为 0，并发时为 1）

• max_workers – 最大并发数，如果为 None 或 < 0 则自动确定，如果为 0 则单工作者惰性执行

• async – 是否异步

• request_kwargs – 其它 http 请求参数，会传给具体的请求函数，默认的是 httpx，可用参数 request 进行设置

Returns:

迭代器，每次返回一次接口调用的结果

async p115client.tool.fs_files.iter_fs_files_asynchronized(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: float = 1, max_workers: None | int = None, **request_kwargs) → AsyncIterator[dict]

异步并发拉取一个目录中的文件或目录的数据

Parameters:

• client – 115 网盘客户端对象

• payload – 目录的 id、pickcode 或者详细的查询参数

• page_size – 分页大小，如果 <= 0，则自动确定

• first_page_size – 第 1 次拉取的分页大小，如果指定此参数，则会等待这次请求返回，才会开始后续，也即非并发

• count – 文件总数

• callback – 回调函数，调用后，会获得一个值，会添加到返回值中，key 为 “callback”

• app – 使用此设备的接口

• raise_for_changed_count – 分批拉取时，发现总数发生变化后，是否报错

• cooldown – 冷却时间，单位为秒

• max_workers – 最大工作协程数，如果为 None 或 <= 0，则为 64

• request_kwargs – 其它 http 请求参数，会传给具体的请求函数，默认的是 httpx，可用参数 request 进行设置

Returns:

异步迭代器

p115client.tool.fs_files.iter_fs_files_serialized(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: float = 0, *, async_: Literal[False] = False, **request_kwargs) → Iterator[dict]

p115client.tool.fs_files.iter_fs_files_serialized(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: float = 0, *, async_: Literal[True], **request_kwargs) → AsyncIterator[dict]

拉取一个目录中的文件或目录的数据

Parameters:

• client – 115 网盘客户端对象

• payload – 目录的 id 或者详细的查询参数

• page_size – 分页大小，如果 <= 0，则自动确定

• first_page_size – 首次拉取的分页大小，如果 <= 0，则自动确定

• count – 文件总数

• callback – 回调函数，调用后，会获得一个值，会添加到返回值中，key 为 “callback”

• app – 使用此设备的接口

• raise_for_changed_count – 分批拉取时，发现总数发生变化后，是否报错

• cooldown – 冷却时间，单位为秒

• async – 是否异步

• request_kwargs – 其它 http 请求参数，会传给具体的请求函数，默认的是 httpx，可用参数 request 进行设置

Returns:

迭代器，每次返回一次接口调用的结果

p115client.tool.fs_files.iter_fs_files_threaded(client: str | PathLike | P115Client | P115OpenClient, payload: int | str | dict = 0, /, page_size: int = 7000, first_page_size: int = 0, count: int = -1, callback: None | Callable[[dict], Any] = None, app: str = 'web', raise_for_changed_count: bool = False, cooldown: float = 1, max_workers: None | int = None, **request_kwargs) → Iterator[dict]

多线程并发拉取一个目录中的文件或目录的数据

Parameters:

• client – 115 网盘客户端对象

• payload – 目录的 id、pickcode 或者详细的查询参数

• page_size – 分页大小，如果 <= 0，则自动确定

• first_page_size – 第 1 次拉取的分页大小，如果指定此参数，则会等待这次请求返回，才会开始后续，也即非并发

• count – 文件总数

• callback – 回调函数，调用后，会获得一个值，会添加到返回值中，key 为 “callback”

• app – 使用此设备的接口

• raise_for_changed_count – 分批拉取时，发现总数发生变化后，是否报错

• cooldown – 冷却时间，单位为秒

• max_workers – 最大工作线程数，如果为 None，则自动确定

• request_kwargs – 其它 http 请求参数，会传给具体的请求函数，默认的是 httpx，可用参数 request 进行设置

Returns:

迭代器