modelscope-api 0.0.4__tar.gz → 0.0.5__tar.gz

{modelscope_api-0.0.4/src/modelscope_api.egg-info → modelscope_api-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modelscope-api
-Version: 0.0.4
+Version: 0.0.5
 Summary: A Python async SDK that wraps the ModelScope API into a clean, type-safe interface.
 Author-email: Jerry <wujr24@m.fudan.edu.cn>
 License: MIT

{modelscope_api-0.0.4 → modelscope_api-0.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "modelscope-api"         # 包名，保持与项目仓库名一致
-version = "0.0.4"               # 当前版本
+version = "0.0.5"               # 当前版本
 description = "A Python async SDK that wraps the ModelScope API into a clean, type-safe interface." # 简短描述
 readme = "README.md"            # 自述文件，PyPI 会将其渲染为项目首页
 authors = [{name = "Jerry", email = "wujr24@m.fudan.edu.cn"}]  # 作者信息

{modelscope_api-0.0.4 → modelscope_api-0.0.5}/src/modelscope_api/models/modelscope_client.py

@@ -3,7 +3,7 @@
 """
 
 import json
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, AsyncContextManager, Dict, List, Optional, Union
 
 from fake_useragent import UserAgent
 import httpx
@@ -201,6 +201,24 @@ class ModelScopeClient:
         return response
 
 
+    def stream(self, **kwargs) -> AsyncContextManager[httpx.Response]:
+        """
+        用该客户端发送流式请求。
+
+        用法与 `httpx.AsyncClient.stream` 完全一致，区别在于发送前会通过
+        `self._get_kwargs` 合并本客户端初始化时的 `self._kwargs`（以及 API Token）。
+
+        用法：
+            async with client.stream(method="GET", url=url) as response:
+                async for chunk in response.aiter_bytes():
+                    ...
+
+        注意：该方法不是协程，直接返回异步上下文管理器，使用时无需 `await`。
+        """
+        kwargs = self._get_kwargs(kwargs)
+        return self._http_client.stream(**kwargs)
+
+
     async def request_data(
         self,
         *,

{modelscope_api-0.0.4 → modelscope_api-0.0.5/src/modelscope_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modelscope-api
-Version: 0.0.4
+Version: 0.0.5
 Summary: A Python async SDK that wraps the ModelScope API into a clean, type-safe interface.
 Author-email: Jerry <wujr24@m.fudan.edu.cn>
 License: MIT

{modelscope_api-0.0.4 → modelscope_api-0.0.5}/src/modelscope_api.egg-info/SOURCES.txt

@@ -42,4 +42,5 @@ src/modelscope_api/models/studio/studio_client.py
 src/modelscope_api/models/user/__init__.py
 src/modelscope_api/models/user/user_client.py
 src/modelscope_api/utils/regex.py
-src/modelscope_api/utils/typing.py
+src/modelscope_api/utils/typing.py
+tests/test_stream.py

modelscope_api-0.0.5/tests/test_stream.py

@@ -0,0 +1,125 @@
+"""
+`ModelScopeClient.stream` 的测试用例。
+
+通过 `httpx.MockTransport` 伪造网络请求，无需真实网络与 API Token。
+"""
+
+import asyncio
+
+import httpx
+
+from modelscope_api import ModelScopeClient
+
+
+def _run(coro):
+    return asyncio.run(coro)
+
+
+def test_stream_merges_init_kwargs():
+    """
+    初始化客户端时传入的 kwargs 应被合并进流式请求。
+    """
+    async def main():
+        received = {}
+
+        def handler(request: httpx.Request) -> httpx.Response:
+            received["headers"] = dict(request.headers)
+            received["url"] = str(request.url)
+            return httpx.Response(200, content=b"hello world")
+
+        transport = httpx.MockTransport(handler)
+        http_client = httpx.AsyncClient(transport=transport)
+
+        client = ModelScopeClient(
+            api_key="",  # 避免读取环境变量中的 Token
+            http_client=http_client,
+            headers={
+                "user-agent": "test-agent",  # 避免动态生成 UA
+                "X-Injected": "from-init",
+            },
+        )
+
+        async with client.stream(method="GET", url="https://example.com/echo") as response:
+            assert response.status_code == 200
+            chunks = [chunk async for chunk in response.aiter_bytes()]
+
+        assert b"".join(chunks) == b"hello world"
+        assert received["url"] == "https://example.com/echo"
+        assert received["headers"]["x-injected"] == "from-init"
+        assert received["headers"]["user-agent"] == "test-agent"
+
+        await http_client.aclose()
+
+    _run(main())
+
+
+def test_stream_call_kwargs_override_init_kwargs():
+    """
+    调用 stream 时传入的 kwargs 应覆盖初始化时的 kwargs。
+    """
+    async def main():
+        received = {}
+
+        def handler(request: httpx.Request) -> httpx.Response:
+            received["headers"] = dict(request.headers)
+            return httpx.Response(200, content=b"ok")
+
+        transport = httpx.MockTransport(handler)
+        http_client = httpx.AsyncClient(transport=transport)
+
+        client = ModelScopeClient(
+            api_key="",
+            http_client=http_client,
+            headers={"user-agent": "test-agent", "X-Test": "init"},
+        )
+
+        async with client.stream(
+            method="POST",
+            url="https://example.com/echo",
+            headers={"X-Test": "call"},
+            content=b"body",
+        ) as response:
+            await response.aread()
+
+        assert received["headers"]["x-test"] == "call"
+
+        await http_client.aclose()
+
+    _run(main())
+
+
+def test_stream_injects_api_key():
+    """
+    流式请求应携带 API Token 的 Authorization 头。
+    """
+    async def main():
+        received = {}
+
+        def handler(request: httpx.Request) -> httpx.Response:
+            received["headers"] = dict(request.headers)
+            return httpx.Response(200, content=b"ok")
+
+        transport = httpx.MockTransport(handler)
+        http_client = httpx.AsyncClient(transport=transport)
+
+        client = ModelScopeClient(
+            api_key="test-key",
+            http_client=http_client,
+            headers={"user-agent": "test-agent"},
+        )
+
+        async with client.stream(method="GET", url="https://example.com/echo") as response:
+            await response.aread()
+
+        assert received["headers"]["authorization"] == "Bearer test-key"
+
+        await http_client.aclose()
+
+    _run(main())
+
+
+if __name__ == "__main__":
+    test_stream_merges_init_kwargs()
+    test_stream_call_kwargs_override_init_kwargs()
+    test_stream_injects_api_key()
+    print("All stream tests passed.")