py-easy-httpx 1.0.0__py3-none-any.whl

py_easy_httpx/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-

py_easy_httpx/mixin.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+"""
+httpx 客户端工具类模块
+
+提供同步和异步 httpx 客户端的创建和请求封装，
+方便在其他类中通过混入(Mixin)方式使用 httpx 功能。
+"""
+import httpx
+
+
+class HttpxMixin:
+    """httpx 客户端混入类
+
+    提供 httpx 同步和异步客户端的创建与请求方法，
+    支持传入现有客户端或自动创建新客户端。
+    """
+
+    def httpx_client(self, **kwargs):
+        """创建同步 httpx 客户端
+
+        首先使用实例的 httpx_client_kwargs 属性（如果存在且为字典类型），
+        然后使用传入的 kwargs 参数覆盖默认设置。
+
+        Args:
+            **kwargs: 传递给 httpx.Client 的参数，可覆盖默认设置
+
+        Returns:
+            httpx.Client: 同步 httpx 客户端实例
+        """
+        httpx_client_kwargs = self.httpx_client_kwargs if hasattr(self, "httpx_client_kwargs") and isinstance(
+            self.httpx_client_kwargs, dict) else {}
+        return httpx.Client(**{**httpx_client_kwargs, **kwargs})
+
+    def async_httpx_client(self, **kwargs):
+        """创建异步 httpx 客户端
+
+        首先使用实例的 httpx_client_kwargs 属性（如果存在且为字典类型），
+        然后使用传入的 kwargs 参数覆盖默认设置。
+
+        Args:
+            **kwargs: 传递给 httpx.AsyncClient 的参数，可覆盖默认设置
+
+        Returns:
+            httpx.AsyncClient: 异步 httpx 客户端实例
+        """
+        httpx_client_kwargs = self.httpx_client_kwargs if hasattr(self, "httpx_client_kwargs") and isinstance(
+            self.httpx_client_kwargs, dict) else {}
+        return httpx.AsyncClient(**{**httpx_client_kwargs, **kwargs})
+
+    def request(self, httpx_client: httpx.Client = None, **kwargs):
+        """执行同步 HTTP 请求
+
+        如果提供的 httpx_client 不是 httpx.Client 实例（或为 None），
+        则自动创建新客户端并在请求完成后关闭。
+
+        支持通过实例的 httpx_client_kwargs 属性（字典类型）
+        传递额外的客户端配置参数。
+
+        Args:
+            httpx_client: httpx.Client 实例，默认 None
+            **kwargs: 传递给 httpx_client.request 的参数
+
+        Returns:
+            httpx.Response: HTTP 响应对象
+        """
+        if not isinstance(httpx_client, httpx.Client):
+            with self.httpx_client() as httpx_client:
+                return httpx_client.request(**kwargs)
+        else:
+            return httpx_client.request(**kwargs)
+
+    async def async_request(self, httpx_client: httpx.AsyncClient = None, **kwargs):
+        """执行异步 HTTP 请求
+
+        如果提供的 httpx_client 不是 httpx.AsyncClient 实例（或为 None），
+        则自动创建新客户端并在请求完成后关闭。
+
+        支持通过实例的 httpx_client_kwargs 属性（字典类型）
+        传递额外的客户端配置参数。
+
+        Args:
+            httpx_client: httpx.AsyncClient 实例，默认 None
+            **kwargs: 传递给 httpx_client.request 的参数
+
+        Returns:
+            httpx.Response: HTTP 响应对象
+        """
+        if not isinstance(httpx_client, httpx.AsyncClient):
+            async with self.async_httpx_client() as httpx_client:
+                return await httpx_client.request(**kwargs)
+        else:
+            return await httpx_client.request(**kwargs)

py_easy_httpx-1.0.0.dist-info/METADATA

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: py-easy-httpx
+Version: 1.0.0
+Summary: 一个用于 HTTP 请求的 Python 包，提供简洁易用的 API 接口，支持同步和异步操作，帮助开发者快速实现 HTTP 请求功能。
+Home-page: https://gitee.com/guolei19850528/py_easy_httpx
+Author: guolei
+Author-email: 174000902@qq.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# py-easy-httpx
+
+一个用于 HTTP 请求的 Python 包，提供简洁易用的 API 接口，支持同步和异步操作，帮助开发者快速实现 HTTP 请求功能。
+
+## 功能特性
+
+- 支持同步和异步 HTTP 请求
+- 提供简洁易用的 API 接口
+- 通过混入(Mixin)方式方便集成到其他类中
+- 支持全局客户端配置和请求级配置
+- 自动管理客户端的创建和关闭
+- 灵活的参数配置，支持覆盖默认设置
+
+## 安装
+
+使用 pip 安装：
+
+```bash
+pip install py-easy-httpx
+```
+
+## 依赖
+
+- httpx
+
+## 快速开始
+
+### 同步请求
+
+```python
+from py_easy_httpx.mixin import HttpxMixin
+
+class MyApi(HttpxMixin):
+    # 可选：全局客户端配置
+    httpx_client_kwargs = {
+        "base_url": "https://api.example.com",
+        "timeout": 60,
+        "headers": {"User-Agent": "MyApi/1.0"}
+    }
+
+# 创建实例
+api = MyApi()
+
+# 执行 GET 请求（自动创建和关闭客户端）
+response = api.request(method="GET", url="/users")
+print(response.status_code)
+print(response.json())
+
+# 使用自定义客户端
+client = api.httpx_client(timeout=30)
+response = api.request(client, method="POST", url="/users", json={"name": "test"})
+print(response.status_code)
+```
+
+### 异步请求
+
+```python
+import asyncio
+from py_easy_httpx.mixin import HttpxMixin
+
+class MyApi(HttpxMixin):
+    # 可选：全局客户端配置
+    httpx_client_kwargs = {
+        "base_url": "https://api.example.com",
+        "timeout": 60
+    }
+
+async def main():
+    # 创建实例
+    api = MyApi()
+
+    # 执行异步 GET 请求（自动创建和关闭客户端）
+    response = await api.async_request(method="GET", url="/users")
+    print(response.status_code)
+    print(response.json())
+
+    # 使用自定义异步客户端
+    client = api.async_httpx_client(timeout=30)
+    response = await api.async_request(client, method="POST", url="/users", json={"name": "test"})
+    print(response.status_code)
+
+# 运行异步函数
+asyncio.run(main())
+```
+
+## API 文档
+
+### HttpxMixin 类
+
+提供 httpx 客户端的创建和请求方法，可作为混入类使用。
+
+#### httpx_client(**kwargs)
+
+创建同步 httpx 客户端。
+
+- **参数**：传递给 `httpx.Client` 的参数
+- **返回**：`httpx.Client` 实例
+
+客户端参数优先级：`kwargs` > `self.httpx_client_kwargs` > 默认设置
+
+#### async_httpx_client(**kwargs)
+
+创建异步 httpx 客户端。
+
+- **参数**：传递给 `httpx.AsyncClient` 的参数
+- **返回**：`httpx.AsyncClient` 实例
+
+客户端参数优先级：`kwargs` > `self.httpx_client_kwargs` > 默认设置
+
+#### request(httpx_client=None, **kwargs)
+
+执行同步 HTTP 请求。
+
+- **参数**：
+  - `httpx_client`: `httpx.Client` 实例，默认 None
+  - `**kwargs`: 传递给 `httpx_client.request` 的参数
+- **返回**：`httpx.Response` 实例
+
+如果 `httpx_client` 不是 `httpx.Client` 实例或为 None，则自动创建新客户端并在请求完成后关闭。
+
+#### async_request(httpx_client=None, **kwargs)
+
+执行异步 HTTP 请求。
+
+- **参数**：
+  - `httpx_client`: `httpx.AsyncClient` 实例，默认 None
+  - `**kwargs`: 传递给 `httpx_client.request` 的参数
+- **返回**：`httpx.Response` 实例
+
+如果 `httpx_client` 不是 `httpx.AsyncClient` 实例或为 None，则自动创建新客户端并在请求完成后关闭。
+
+## 配置选项
+
+### httpx_client_kwargs 属性
+
+可以在继承 HttpxMixin 的类中定义 `httpx_client_kwargs` 属性，用于配置全局客户端参数：
+
+```python
+class MyApi(HttpxMixin):
+    httpx_client_kwargs = {
+        "base_url": "https://api.example.com",
+        "timeout": 60,
+        "verify": False,
+        "headers": {
+            "User-Agent": "MyApi/1.0",
+            "Authorization": "Bearer token"
+        },
+        "proxies": {
+            "http://": "http://proxy.example.com:8080",
+            "https://": "http://proxy.example.com:8080"
+        }
+    }
+```
+
+这些配置将应用于所有通过 `httpx_client()` 和 `async_httpx_client()` 方法创建的客户端，但可以在请求时通过传入参数覆盖。
+
+## 示例
+
+### 基本使用
+
+```python
+from py_easy_httpx.mixin import HttpxMixin
+
+class JsonPlaceholderApi(HttpxMixin):
+    httpx_client_kwargs = {
+        "base_url": "https://jsonplaceholder.typicode.com",
+        "timeout": 30
+    }
+
+# 创建客户端
+api = JsonPlaceholderApi()
+
+# 获取所有帖子
+response = api.request(method="GET", url="/posts")
+print(f"Status: {response.status_code}")
+print(f"First post: {response.json()[0]}")
+
+# 创建新帖子
+new_post = {
+    "title": "Test Post",
+    "body": "This is a test post",
+    "userId": 1
+}
+response = api.request(method="POST", url="/posts", json=new_post)
+print(f"Create post status: {response.status_code}")
+print(f"Created post: {response.json()}")
+```
+
+### 异步使用
+
+```python
+import asyncio
+from py_easy_httpx.mixin import HttpxMixin
+
+class AsyncJsonPlaceholderApi(HttpxMixin):
+    httpx_client_kwargs = {
+        "base_url": "https://jsonplaceholder.typicode.com",
+        "timeout": 30
+    }
+
+async def fetch_posts():
+    api = AsyncJsonPlaceholderApi()
+    response = await api.async_request(method="GET", url="/posts")
+    return response.json()[:5]  # 返回前5个帖子
+
+async def fetch_users():
+    api = AsyncJsonPlaceholderApi()
+    response = await api.async_request(method="GET", url="/users")
+    return response.json()[:3]  # 返回前3个用户
+
+async def main():
+    # 并行执行多个请求
+    posts, users = await asyncio.gather(fetch_posts(), fetch_users())
+    
+    print("Posts:")
+    for post in posts:
+        print(f"  - {post['title']}")
+    
+    print("\nUsers:")
+    for user in users:
+        print(f"  - {user['name']}")
+
+asyncio.run(main())
+```
+
+## 许可证
+
+MIT License
+
+## 作者
+
+guolei - 174000902@qq.com
+
+## 项目链接
+
+- [Gitee 仓库](https://gitee.com/guolei19850528/py_easy_httpx)

py_easy_httpx-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+py_easy_httpx/__init__.py,sha256=_ZTg5hKBudrPm7yfzWY8oBRoNo5CbL9XHuXmgaCyXUU,47
+py_easy_httpx/mixin.py,sha256=NcKc32PygdTUGuf69GkCULEFdlFzj61S8LnjD9uWrfY,3440
+py_easy_httpx-1.0.0.dist-info/licenses/LICENSE,sha256=HazFJNaQP3rbY1dvg3hAmO-FZ6v7DwM0YHwXvWsGG3A,1063
+py_easy_httpx-1.0.0.dist-info/METADATA,sha256=8J6QoKZrKbIyPbGYcl-ez2BufQ_CqpdpKMCn4N9Q7iM,6666
+py_easy_httpx-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+py_easy_httpx-1.0.0.dist-info/top_level.txt,sha256=mXsobBsTKsU3-cb4YAbOXUpA5vUw_6EgtWhtYikZqrE,14
+py_easy_httpx-1.0.0.dist-info/RECORD,,

py_easy_httpx-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

py_easy_httpx-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 郭磊
+
+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.

py_easy_httpx-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+py_easy_httpx