p123client 0.0.6__tar.gz

p123client-0.0.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ChenyangGao <https://github.com/ChenyangGao>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

p123client-0.0.6/PKG-INFO

@@ -0,0 +1,320 @@
+Metadata-Version: 2.1
+Name: p123client
+Version: 0.0.6
+Summary: Python 123 webdisk client.
+Home-page: https://github.com/ChenyangGao/python-123-client
+License: MIT
+Keywords: 123,webdisk,client
+Author: ChenyangGao
+Author-email: wosiwujm@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiofile
+Requires-Dist: httpx
+Requires-Dist: httpx_request (>=0.1.2)
+Requires-Dist: multidict
+Requires-Dist: orjson
+Requires-Dist: python-asynctools (>=0.0.8.2)
+Requires-Dist: python-encode_uri (>=0.0.3)
+Requires-Dist: python-filewrap (>=0.2.6.1)
+Requires-Dist: python-hashtools (>=0.0.3.3)
+Requires-Dist: python-http_request (>=0.0.7)
+Requires-Dist: python-httpfile (>=0.0.5)
+Requires-Dist: python-iterutils (>=0.2)
+Requires-Dist: python-property (>=0.0.3)
+Requires-Dist: yarl
+Project-URL: Repository, https://github.com/ChenyangGao/python-123-client
+Description-Content-Type: text/markdown
+
+# Python 123 网盘客户端
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/p123client)
+![PyPI - Version](https://img.shields.io/pypi/v/p123client)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/p123client)
+![PyPI - Format](https://img.shields.io/pypi/format/p123client)
+![PyPI - Status](https://img.shields.io/pypi/status/p123client)
+
+## 安装
+
+你可以从 [pypi](https://pypi.org/project/p123client/) 安装最新版本
+
+```console
+pip install -U p123client
+```
+
+## 入门介绍
+
+### 1. 导入模块和创建实例
+
+导入模块
+
+```python
+from p123client import P123Client
+```
+
+创建客户端对象，需要传入 JWT <kbd>token</kbd>
+
+```python
+token = "..."
+client = P123Client(token=token)
+```
+
+你也可以用账户和密码登录
+
+```python
+passport = "..." # 手机号或者邮箱
+password = "..." # 密码
+client = P123Client(passport, password)
+```
+
+### 2. 接口调用
+
+所有需要直接或间接执行 HTTP 请求的接口，都有同步和异步的调用方式，且默认是采用 POST 发送 JSON 请求数据
+
+```python
+# 同步调用
+client.method(payload)
+client.method(payload, async_=False)
+
+# 异步调用
+await client.method(payload, async_=True)
+```
+
+从根本上讲，除了几个 `staticmethod`，它们都会调用 `P123Client.request`
+
+```python
+url = "https://www.123pan.com/api/someapi"
+response = client.request(url=url, json={...})
+```
+
+当你需要构建自己的扩展模块，以增加一些新的 123 web 接口时，就需要用到此方法了
+
+```python
+from collections.abc import Coroutine
+from typing import overload, Any, Literal
+
+from p123client import P123Client
+
+class MyCustom123Client(P123Client):
+
+    @overload
+    def foo(
+        self, 
+        payload: dict, 
+        /, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def foo(
+        self, 
+        payload: dict, 
+        /, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def foo(
+        self, 
+        payload: dict, 
+        /, 
+        async_: bool = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        api = "https://www.123pan.com/api/foo"
+        return self.request(
+            api, 
+            method="GET", 
+            params=payload, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
+    @overload
+    def bar(
+        self, 
+        payload: dict, 
+        /, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def bar(
+        self, 
+        payload: dict, 
+        /, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def bar(
+        self, 
+        payload: dict, 
+        /, 
+        async_: bool = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        api = "https://www.123pan.com/api/bar"
+        return self.request(
+            api, 
+            method="POST", 
+            json=payload, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+```
+
+### 3. 检查响应
+
+接口被调用后，如果返回的是 dict 类型的数据（说明原本是 JSON），则可以用 `p123client.check_response` 执行检查。首先会查看其中名为 "code" 的键的对应值，如果为 0 或 200 或者不存在，则原样返回被检查的数据；否则，抛出一个 `p123client.P123OSError` 的实例。
+
+```python
+from p123client import check_response
+
+# 检查同步调用
+data = check_response(client.method(payload))
+# 检查异步调用
+data = check_response(await client.method(payload, async_=True))
+```
+
+### 4. 辅助工具
+
+一些简单的封装工具可能是必要的，特别是那种实现起来代码量比较少，可以封装成单个函数的。我把平常使用过程中，积累的一些经验具体化为一组工具函数。这些工具函数分别有着不同的功能，如果组合起来使用，或许能解决很多问题。
+
+```python
+from p123client import tool
+```
+
+#### 1. 创建自定义 uri
+
+```python
+from p123client import P123Client
+from p123client.tool import make_uri
+
+# TODO: 改成你自己的账户和密码
+client = P123Client(passport="手机号或邮箱", password="登录密码")
+
+# TODO: 请改成你要处理的文件 id
+file_id = 15688945
+print(make_uri(client, file_id))
+```
+
+#### 2. 由自定义 uri 转存文件到你的网盘
+
+```python
+from p123client import P123Client
+from p123client.tool import upload_uri
+
+# TODO: 改成你自己的账户和密码
+client = P123Client(passport="手机号或邮箱", password="登录密码")
+
+uri = "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd"
+print(upload_uri(client, uri, duplicate=1))
+```
+
+#### 3. 由自定义 uri 获取下载直链
+
+```python
+from p123client import P123Client
+from p123client.tool import get_downurl
+
+# TODO: 改成你自己的账户和密码
+client = P123Client(passport="手机号或邮箱", password="登录密码")
+
+# 带 s3_key_flag
+print(get_downurl(client, "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd?1812602326-0"))
+# 不带 s3_key_flag（会转存）
+print(get_downurl(client, "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd"))
+```
+
+#### 4. 直链服务
+
+需要先安装 [fastapi](https://pypi.org/project/fastapi/)
+
+```console
+pip install 'fastapi[uvicorn]'
+```
+
+然后启动如下服务，就可以访问以获取直链了
+
+**带 s3_key_flag**
+
+http://localhost:8123/torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd?1812602326-0
+
+**不带 s3_key_flag（会转存）**
+
+http://localhost:8123/torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd
+
+```python
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse, RedirectResponse
+from p123client import P123Client
+from p123client.tool import get_downurl
+
+# TODO: 改成你自己的账户和密码
+client = P123Client(passport="手机号或邮箱", password="登录密码")
+
+app = FastAPI(debug=True)
+
+@app.get("/{uri:path}")
+@app.head("/{uri:path}")
+async def index(request: Request, uri: str):
+    try:
+        payload = int(uri)
+    except ValueError:
+        if uri.count("|") < 2:
+            return JSONResponse({"state": False, "message": f"bad uri: {uri!r}"}, 500)
+        payload = uri
+        if s3_key_flag := request.url.query:
+            payload += "?" + s3_key_flag
+    url = await get_downurl(client, payload, quoted=False, async_=True)
+    return RedirectResponse(url, 302)
+
+if __name__ == "__main__":
+    from uvicorn import run
+
+    run(app, host="0.0.0.0", port=8123)
+```
+
+#### 5. 遍历文件列表
+
+**遍历网盘中的文件列表**
+
+```python
+from p123client import P123Client
+from p123client.tool import iterdir
+
+# TODO: 改成你自己的账户和密码
+client = P123Client(passport="手机号或邮箱", password="登录密码")
+
+for info in iterdir(client, parent_id=0, max_depth=-1, predicate=lambda a: not a["is_dir"]):
+    print(info)
+```
+
+**遍历分享中的文件列表（无需登录）**
+
+```python
+from p123client.tool import share_iterdir
+
+# TODO: 分享码
+share_key = "g0n0Vv-2sbI"
+# TODO: 密码
+share_pwd = ""
+
+for info in share_iterdir(share_key, share_pwd, parent_id=0, max_depth=-1, predicate=lambda a: not a["is_dir"]):
+    print(info)
+```
+

p123client-0.0.6/p123client/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+
+__author__ = "ChenyangGao <https://chenyanggao.github.io>"
+__version__ = (0, 0, 6)
+
+from .client import *
+from .const import *
+from .exception import *
+from .type import *