iterdir#

罗列目录

p123client.tool.iterdir.iterdir(client: P123Client, payload: dict | int | str = 0, min_depth: int = 1, max_depth: int = 1, predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, keep_raw: bool = False, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, list_method: Literal['list', 'list_new', 'list_v1', 'list_v2'] | Callable = 'list_new', *, async_: Literal[False] = False, **request_kwargs) Iterator[dict][source]#
p123client.tool.iterdir.iterdir(client: P123Client, payload: dict | int | str = 0, min_depth: int = 1, max_depth: int = 1, predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, keep_raw: bool = False, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, list_method: Literal['list', 'list_new', 'list_v1', 'list_v2'] | Callable = 'list_new', *, async_: Literal[True], **request_kwargs) AsyncIterator[dict]

遍历文件列表

Parameters:
  • client – 123 网盘的客户端对象

  • payload – 父目录 id 或查询参数

  • min_depth – 最小深度,小于此深度的不会输出

  • max_depth – 最大深度,大于此深度的不会输出,如果小于 0 则无限

  • predicate

    以文件或目录的信息(是原始数据,而不是输出的数据)作为参数进行调用,并以返回值作为筛选条件

    • 如果返回值是 0 或 None,则跳过此节点以及位于此节点之下的所有节点

    • 如果返回值是 1,则输出此节点,但跳过位于此节点之下的所有节点

    • 如果返回值是 False,则跳过此节点(但依然会继续处理位于此节点之下的节点)

    • 如果返回值是 True,则输出此节点

  • keep_raw – 是否保留原始数据,如果为 True,则会保存到 “raw” 字段

  • cooldown – 两次调用之间,冷却的时间(用两次调用开始时的时间差,而不是一次完成到下一次开始的时间差)

  • base_url – 基地址,如果为空,则用默认

  • list_method

    使用哪个罗列目录的方法

    • ”list”: 使用 P123Client.fs_list

    • ”list_new”: 使用 P123Client.fs_list_new

    • ”list_v1”: 使用 P123Client.fs_list_v1_open

    • ”list_v2”: 使用 P123Client.fs_list_v2_open

  • async – 是否异步

  • request_kwargs – 其它请求参数

Returns:

迭代器,产生文件或目录的信息

p123client.tool.iterdir.share_iter(client: P123Client, predicate: None | Callable[[dict], bool] = lambda info: ..., keep_raw: bool = True, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, *, async_: Literal[False] = False, **request_kwargs) Iterator[dict][source]#
p123client.tool.iterdir.share_iter(client: P123Client, predicate: None | Callable[[dict], bool] = lambda info: ..., keep_raw: bool = True, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, *, async_: Literal[True], **request_kwargs) AsyncIterator[dict]

遍历用户的分享列表

Parameters:
  • client – 123 网盘的客户端对象

  • predicate – 以分享信息(是原始数据,而不是输出的数据)作为参数进行调用,并以返回值作为筛选条件

  • keep_raw – 是否保留原始数据,如果为 True,则会保存到 “raw” 字段

  • cooldown – 两次调用之间,冷却的时间(用两次调用开始时的时间差,而不是一次完成到下一次开始的时间差)

  • base_url – 基地址,如果为空,则用默认

  • async – 是否异步

  • request_kwargs – 其它请求参数

Returns:

迭代器,产生文件或目录的信息

p123client.tool.iterdir.share_iterdir(share_key: str = '', share_pwd: str = '', payload: dict | int | str = 0, min_depth: int = 1, max_depth: int = 1, predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, keep_raw: bool = False, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, *, async_: Literal[False] = False, **request_kwargs) Iterator[dict][source]#
p123client.tool.iterdir.share_iterdir(share_key: str = '', share_pwd: str = '', payload: dict | int | str = 0, min_depth: int = 1, max_depth: int = 1, predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, keep_raw: bool = False, cooldown: float = 0, base_url: None | str | Callable[[], str] = None, *, async_: Literal[True], **request_kwargs) AsyncIterator[dict]

遍历分享的文件列表

Parameters:
  • share_key

    分享码或者分享链接(可以携带提取码)

    Note

    在分享链接中的位置形如 f”https://www.123pan.com/s/{share_key}”

    如果携带提取码,要写成

    f”https://www.123pan.com/s/{share_key}?提取码:{share_pwd}”

    或者

    f”https://www.123pan.com/s/{share_key}?pwd={share_pwd}”

    上面的基地址不必是 “https://www.123pan.com

  • share_pwd – 提取码(4个文字),可以为空

  • payload – 父目录 id 或查询参数

  • min_depth – 最小深度,小于此深度的不会输出

  • max_depth – 最大深度,大于此深度的不会输出,如果小于 0 则无限

  • predicate

    以文件或目录的信息(是原始数据,而不是输出的数据)作为参数进行调用,并以返回值作为筛选条件

    • 如果返回值是 0 或 None,则跳过此节点以及位于此节点之下的所有节点

    • 如果返回值是 1,则输出此节点,但跳过位于此节点之下的所有节点

    • 如果返回值是 False,则跳过此节点(但依然会继续处理位于此节点之下的节点)

    • 如果返回值是 True,则输出此节点

  • keep_raw – 是否保留原始数据,如果为 True,则会保存到 “raw” 字段

  • cooldown – 两次调用之间,冷却的时间(用两次调用开始时的时间差,而不是一次完成到下一次开始的时间差)

  • base_url – 基地址,如果为空,则用默认

  • async – 是否异步

  • request_kwargs – 其它请求参数

Returns:

迭代器,产生文件或目录的信息