huidevkit 0.6.0__tar.gz

huidevkit-0.6.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

huidevkit-0.6.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include py_tools/utils/project_templates *

huidevkit-0.6.0/PKG-INFO

@@ -0,0 +1,417 @@
+Metadata-Version: 2.1
+Name: huidevkit
+Version: 0.6.0
+Summary: Practical Python development tools
+Home-page: https://github.com/HuiDBK/py-tools
+Author: hui
+Author-email: huidbk@163.com
+License: Apache
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru<0.8,>=0.7.0
+Requires-Dist: pydantic<3,>=2.1.1
+Requires-Dist: asgiref==3.8.1
+Requires-Dist: nest_asyncio==1.6.0
+Requires-Dist: tqdm==4.66.4
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: requests==2.31.0
+Requires-Dist: aiohttp==3.9.5
+Requires-Dist: cacheout==0.14.1
+Requires-Dist: aiofiles==24.1.0
+Requires-Dist: python-jose==3.3.0
+Provides-Extra: db-orm
+Requires-Dist: sqlalchemy[asyncio]==2.0.20; extra == "db-orm"
+Requires-Dist: aiomysql==0.2.0; extra == "db-orm"
+Provides-Extra: db-redis
+Requires-Dist: redis>=4.5.4; extra == "db-redis"
+Provides-Extra: cache-proxy
+Requires-Dist: redis>=4.5.4; extra == "cache-proxy"
+Requires-Dist: python-memcached==1.62; extra == "cache-proxy"
+Requires-Dist: cacheout==0.14.1; extra == "cache-proxy"
+Provides-Extra: minio
+Requires-Dist: minio==7.1.17; extra == "minio"
+Provides-Extra: excel-tools
+Requires-Dist: pandas==2.0.3; extra == "excel-tools"
+Requires-Dist: openpyxl==3.0.10; extra == "excel-tools"
+Provides-Extra: all
+Requires-Dist: loguru<0.8,>=0.7.0; extra == "all"
+Requires-Dist: cacheout==0.14.1; extra == "all"
+Requires-Dist: python-dateutil==2.8.2; extra == "all"
+Requires-Dist: pandas==2.0.3; extra == "all"
+Requires-Dist: python-jose==3.3.0; extra == "all"
+Requires-Dist: pydantic<3,>=2.1.1; extra == "all"
+Requires-Dist: aiofiles==24.1.0; extra == "all"
+Requires-Dist: tqdm==4.66.4; extra == "all"
+Requires-Dist: aiomysql==0.2.0; extra == "all"
+Requires-Dist: nest_asyncio==1.6.0; extra == "all"
+Requires-Dist: asgiref==3.8.1; extra == "all"
+Requires-Dist: redis>=4.5.4; extra == "all"
+Requires-Dist: minio==7.1.17; extra == "all"
+Requires-Dist: sqlalchemy[asyncio]==2.0.20; extra == "all"
+Requires-Dist: aiohttp==3.9.5; extra == "all"
+Requires-Dist: python-memcached==1.62; extra == "all"
+Requires-Dist: requests==2.31.0; extra == "all"
+Requires-Dist: openpyxl==3.0.10; extra == "all"
+Provides-Extra: test
+Requires-Dist: pytest==7.3.1; extra == "test"
+Requires-Dist: pytest-mock==3.14.0; extra == "test"
+Requires-Dist: pytest-asyncio==0.23.8; extra == "test"
+
+# Py-Tools
+
+> Py-Tools 是一个实用的 Python 工具集和可复用组件库，旨在简化常见任务，提高 Python 项目的开发效率。
+> 
+> 设计细节请移步到掘金查看：https://juejin.cn/column/7131286129713610766
+
+## 安装
+- 环境要求：python version >= 3.8
+- 历史版本记录：https://pypi.org/project/hui-tools/#history
+
+> 根据 [PEP 625](https://peps.python.org/pep-0625/) 要求，从 0.6.0 版本开始，将包名改成了 `huidevkit`， 历史版本的包名仍然可用，但是不推荐使用。
+
+### 默认安装
+```python
+pip install huidevkit
+```
+默认安装如下功能可以使用
+- 时间工具类
+- http客户端
+- 同步异步互转装饰器
+- 常用枚举
+- pydantic
+- loguru的日志器
+- jwt工具类
+- 等...
+
+### 全部安装
+```python
+pip install huidevkit[all]
+```
+
+### 可选安装
+```python
+pip install huidevkit[db-orm, db-redis, excel-tools]
+```
+
+可选参数参考：
+```python
+extras_require = {
+    "db-orm": ["sqlalchemy[asyncio]==2.0.20", "aiomysql==0.2.0"],
+    "db-redis": ["redis>=4.5.4"],
+    "cache-proxy": ["redis>=4.5.4", "python-memcached==1.62", "cacheout==0.14.1"],
+    "minio": ["minio==7.1.17"],
+    "excel-tools": ["pandas==2.2.2", "openpyxl==3.0.10"],
+    "test": ["pytest==7.3.1", "pytest-mock==3.14.0", "pytest-asyncio==0.23.8"],
+}
+```
+
+### 简单使用
+> 所有功能都是从 py_tools 包中导入使用
+> 详细使用请查看项目的DEMO： https://github.com/HuiDBK/py-tools/tree/master/demo
+
+生成python web项目结构模板
+```python
+py_tools make_project WebDemo
+```
+
+快速配置项目日志
+```python
+from py_tools.constants import BASE_DIR
+from py_tools.logging import logger, setup_logging
+
+
+def main():
+    setup_logging(log_dir=BASE_DIR / "logs")
+    logger.info("use log dir")
+    logger.error("test error")
+
+
+if __name__ == '__main__':
+    main()
+```
+
+异步http客户端
+```python
+import asyncio
+from py_tools.connections.http import AsyncHttpClient
+
+
+async def main():
+    url = "https://juejin.cn/"
+    resp = await AsyncHttpClient().get(url).execute()
+    text_data = await AsyncHttpClient().get(url, params={"test": "hui"}).text()
+    json_data = await AsyncHttpClient().post(url, data={"test": "hui"}).json()
+    byte_data = await AsyncHttpClient().get(url).bytes()
+    
+    async with AsyncHttpClient() as client:
+        upload_file_ret = await client.upload_file(url, file="test.txt").json()
+    
+    async for chunk in AsyncHttpClient().get(url).stream(chunk_size=512):
+        # 流式调用
+        print(chunk)
+    
+    await AsyncHttpClient.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+mysql数据库操作demo
+```python
+import asyncio
+import uuid
+from typing import List
+
+from connections.sqlalchemy_demo.manager import UserFileManager
+from connections.sqlalchemy_demo.table import UserFileTable
+from sqlalchemy import func
+
+from py_tools.connections.db.mysql import BaseOrmTable, DBManager, SQLAlchemyManager
+
+db_client = SQLAlchemyManager(
+    host="127.0.0.1",
+    port=3306,
+    user="root",
+    password="123456",
+    db_name="hui-demo",
+)
+
+
+async def create_and_transaction_demo():
+    async with UserFileManager.transaction() as session:
+        await UserFileManager(session).bulk_add(table_objs=[{"filename": "aaa", "oss_key": uuid.uuid4().hex}])
+        user_file_obj = UserFileTable(filename="eee", oss_key=uuid.uuid4().hex)
+        file_id = await UserFileManager(session).add(table_obj=user_file_obj)
+        print("file_id", file_id)
+
+        ret: UserFileTable = await UserFileManager(session).query_by_id(2)
+        print("query_by_id", ret)
+
+        # a = 1 / 0
+
+        ret = await UserFileManager(session).query_one(
+            cols=[UserFileTable.filename, UserFileTable.oss_key], conds=[UserFileTable.filename == "ccc"],
+        )
+        print("ret", ret)
+
+
+async def query_demo():
+    ret = await UserFileManager().query_one(conds=[UserFileTable.filename == "ccc"])
+    print("ret", ret)
+
+    file_count = await UserFileManager().query_one(cols=[func.count()], flat=True)
+    print("str col one ret", file_count)
+
+    filename = await UserFileManager().query_one(cols=[UserFileTable.filename], conds=[UserFileTable.id == 2], flat=True)
+    print("filename", filename)
+
+    ret = await UserFileManager().query_all(cols=[UserFileTable.filename, UserFileTable.oss_key])
+    print("ret", ret)
+
+    ret = await UserFileManager().query_all(cols=["filename", "oss_key"])
+    print("str col ret", ret)
+
+    ret: List[UserFileTable] = await UserFileManager().query_all()
+    print("ret", ret)
+
+    ret = await UserFileManager().query_all(cols=[UserFileTable.id], flat=True)
+    print("ret", ret)
+
+
+async def list_page_demo():
+    """分页查询demo"""
+    total_count, data_list = await UserFileManager().list_page(
+        cols=["filename", "oss_key", "file_size"], curr_page=2, page_size=10
+    )
+    print("total_count", total_count, f"data_list[{len(data_list)}]", data_list)
+
+
+async def run_raw_sql_demo():
+    """运行原生sql demo"""
+    count_sql = "select count(*) as total_count from user_file"
+    count_ret = await UserFileManager().run_sql(count_sql, query_one=True)
+    print("count_ret", count_ret)
+
+    data_sql = "select * from user_file where id > :id_val and file_size >= :file_size_val"
+    params = {"id_val": 20, "file_size_val": 0}
+    data_ret = await UserFileManager().run_sql(data_sql, params=params)
+    print("dict data_ret", data_ret)
+
+    # 连表查询
+    data_sql = """
+    select
+        user.id as user_id,
+        username,
+        user_file.id as file_id,
+        filename,
+        oss_key
+    from 
+        user_file
+        join user on user.id = user_file.creator
+    where 
+        user_file.creator = :user_id
+    """
+    data_ret = await UserFileManager().run_sql(data_sql, params={"user_id": 1})
+    print("join sql data_ret", data_ret)
+
+
+async def curd_demo():
+    await create_and_transaction_demo()
+    await query_demo()
+    await list_page_demo()
+    await run_raw_sql_demo()
+
+
+async def create_tables():
+    # 根据映射创建库表
+    async with DBManager.connection() as conn:
+        await conn.run_sync(BaseOrmTable.metadata.create_all)
+
+
+async def main():
+    db_client.init_mysql_engine()
+    DBManager.init_db_client(db_client)
+    await create_tables()
+    await curd_demo()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## Todo List
+
+### 连接客户端
+1. [x] http 同步异步客户端
+2. [x] MySQL 客户端 - SQLAlchemy-ORM 封装
+3. [x] Redis 客户端
+4. [x] Minio 客户端 
+5. 消息队列客户端，rabbitmq、kafka 
+6. websocket 客户端
+
+### 工具类
+- [x] 同异步函数转化工具类
+- [x] excel 工具类
+- [x] 文件 工具类
+- [x] 实用函数工具模块
+- [x] 数据掩码工具类
+- [x] 常用正则工具类
+- [x] 时间工具类
+- [x] 树结构转换工具类
+- [x] pydantic model 、dataclass 与 SQLALChemy table 序列化与反序列工具类
+- 认证相关工具类
+  - [x] JWT 工具类
+- 图片操作工具类，例如校验图片分辨率
+- 邮件服务工具类
+- 配置解析工具类
+- 编码工具类，统一 base64、md5等编码入口
+- 加密工具类
+
+### 装饰器
+1. [x] 超时装饰器
+2. [x] 重试装饰器
+3. [x] 缓存装饰器
+4. [x] 异步执行装饰器
+
+### 枚举
+1. [x] 通用枚举类封装
+2. [x] 错误码枚举封装
+3. [x] 常用枚举
+
+### 异常
+1. [x] 业务异常类封装
+
+### 日志
+1. [x] logger 日志器（loguru）
+2. [x] 快速配置项目日志函数
+
+## 工程目录结构
+
+```
+py-tools/
+    ├── py_tools/
+    │   ├── chatbot/
+    │   ├── connections/
+    │   ├── constants/
+    │   ├── data_schemas/
+    │   ├── decorators/
+    │   ├── enums/
+    │   ├── exceptions/
+    │   ├── meta_cls/
+    │   └── utils/
+    ├── docs/
+    ├── demo/
+    ├── tests/
+    ├── .gitignore
+    ├── LICENSE
+    ├── README.md
+    └── requirements.txt
+```
+
+
+
+### 项目模块
+
+- **chatbot**: 用于构建和管理聊天机器人互动的工具集。
+- **connections**: 用于连接各种服务和 API 的连接管理工具。
+- **constants**: Python 项目中常用的常量。
+- **data_schemas**: 用于处理结构化数据的数据模型及相关工具。
+- **decorators**: 一系列有用的装饰器，用以增强函数和方法。
+- **enums**: 定义常用枚举类型，方便在项目中使用。
+- **exceptions**: 自定义异常类，用于项目中的错误处理。
+- **meta_cls**: 元类和元编程相关的工具和技术。
+- **utils**: 包含各种实用函数和工具，用于简化日常编程任务。
+
+
+
+### 项目文档
+
+在 `docs` 目录下存放一些项目相关文档。
+
+
+
+### 示例
+
+在 `demo` 目录下，您可以找到一些使用 Py-Tools 的示例代码，这些代码展示了如何使用这些工具集实现实际项目中的任务。
+
+demo：https://github.com/HuiDBK/py-tools/tree/master/demo
+
+### 测试
+
+在 `tests` 目录下，包含了针对 Py-Tools 的各个组件的单元测试。通过运行这些测试，您可以确保工具集在您的环境中正常工作。
+
+
+
+## 一起贡献
+> 欢迎您对本项目进行贡献。请在提交 Pull Request 之前阅读项目的贡献指南，并确保您的代码符合项目的代码风格。
+
+1. Fork后克隆本项目到本地：
+```bash
+git clone https://github.com/<github_name>/py-tools.git
+```
+
+2. 安装依赖:
+```python
+pip install -r requirements.txt
+```
+
+3. 配置python代码风格检查到 git hook 中
+
+安装 pre-commit
+```python
+pip install pre-commit
+```
+
+再项目目录下执行
+```python
+pre-commit install
+```
+安装成功后 git commit 后会提前进行代码检查
+
+4. 提PR