pixelarraylib 1.1.2__tar.gz → 1.1.3__tar.gz

pixelarraylib-1.1.3/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: pixelarraylib
+Version: 1.1.3
+Summary: PixelArray Python开发工具库 - 包含阿里云服务、数据库工具、装饰器、监控等功能
+Author-email: Lu qi <qi.lu@pixelarrayai.com>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/pixelarrayai/general_pythondevutils_lib
+Project-URL: Bug Reports, https://gitlab.com/pixelarrayai/general_pythondevutils_lib/-/issues
+Project-URL: Source, https://gitlab.com/pixelarrayai/general_pythondevutils_lib
+Keywords: python,utils,aliyun,database,tools,pixelarray
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: aliyun
+Requires-Dist: alibabacloud_tea_util; extra == "aliyun"
+Requires-Dist: alibabacloud_cms20190101; extra == "aliyun"
+Requires-Dist: alibabacloud_green20220302; extra == "aliyun"
+Requires-Dist: alibabacloud_dm20151123; extra == "aliyun"
+Requires-Dist: alibabacloud_fc20230330; extra == "aliyun"
+Requires-Dist: alibabacloud_darabonba_stream; extra == "aliyun"
+Requires-Dist: alibabacloud_dysmsapi20170525; extra == "aliyun"
+Requires-Dist: alibabacloud_sts20150401; extra == "aliyun"
+Requires-Dist: alibabacloud_alidns20150109; extra == "aliyun"
+Requires-Dist: alibabacloud_eci20180808; extra == "aliyun"
+Requires-Dist: alibabacloud_bssopenapi20171214; extra == "aliyun"
+Requires-Dist: alibabacloud_cr20181201; extra == "aliyun"
+Requires-Dist: alibabacloud_vpc20160428; extra == "aliyun"
+Requires-Dist: alibabacloud_tea_openapi; extra == "aliyun"
+Requires-Dist: alibabacloud_credentials; extra == "aliyun"
+Requires-Dist: oss2; extra == "aliyun"
+Requires-Dist: aiohttp; extra == "aliyun"
+Requires-Dist: aiofiles; extra == "aliyun"
+Requires-Dist: requests; extra == "aliyun"
+Provides-Extra: mysql
+Requires-Dist: pymysql; extra == "mysql"
+Requires-Dist: aiomysql; extra == "mysql"
+Requires-Dist: requests; extra == "mysql"
+Provides-Extra: redis
+Requires-Dist: redis; extra == "redis"
+Requires-Dist: requests; extra == "redis"
+Provides-Extra: monitor
+Requires-Dist: requests; extra == "monitor"
+Provides-Extra: net
+Requires-Dist: requests; extra == "net"
+Requires-Dist: aiohttp; extra == "net"
+Provides-Extra: system
+Requires-Dist: cryptography; extra == "system"
+Requires-Dist: paramiko; extra == "system"
+Requires-Dist: requests; extra == "system"
+Provides-Extra: gitlab
+Requires-Dist: requests; extra == "gitlab"
+Requires-Dist: aiohttp; extra == "gitlab"
+Requires-Dist: pandas; extra == "gitlab"
+Provides-Extra: all
+Requires-Dist: alibabacloud_tea_util; extra == "all"
+Requires-Dist: alibabacloud_cms20190101; extra == "all"
+Requires-Dist: alibabacloud_green20220302; extra == "all"
+Requires-Dist: alibabacloud_dm20151123; extra == "all"
+Requires-Dist: alibabacloud_fc20230330; extra == "all"
+Requires-Dist: alibabacloud_darabonba_stream; extra == "all"
+Requires-Dist: alibabacloud_dysmsapi20170525; extra == "all"
+Requires-Dist: alibabacloud_sts20150401; extra == "all"
+Requires-Dist: alibabacloud_alidns20150109; extra == "all"
+Requires-Dist: alibabacloud_eci20180808; extra == "all"
+Requires-Dist: alibabacloud_bssopenapi20171214; extra == "all"
+Requires-Dist: alibabacloud_cr20181201; extra == "all"
+Requires-Dist: alibabacloud_vpc20160428; extra == "all"
+Requires-Dist: alibabacloud_tea_openapi; extra == "all"
+Requires-Dist: alibabacloud_credentials; extra == "all"
+Requires-Dist: oss2; extra == "all"
+Requires-Dist: pymysql; extra == "all"
+Requires-Dist: aiomysql; extra == "all"
+Requires-Dist: redis; extra == "all"
+Requires-Dist: cryptography; extra == "all"
+Requires-Dist: paramiko; extra == "all"
+Requires-Dist: requests; extra == "all"
+Requires-Dist: aiohttp; extra == "all"
+Requires-Dist: aiofiles; extra == "all"
+Requires-Dist: pandas; extra == "all"
+Dynamic: license-file
+
+# PixelArrayLib - PixelArray Python开发工具库
+
+PixelArrayLib是一个功能丰富的Python开发工具库，包含阿里云服务、数据库工具、装饰器、监控等功能，同时提供便捷的命令行工具。
+
+## 安装
+
+### 基础安装
+
+```bash
+pip install pixelarraylib
+```
+
+### 可选依赖安装
+
+为了避免安装不必要的依赖，你可以按需安装特定模块的依赖：
+
+```bash
+# 只安装阿里云服务相关依赖
+pip install pixelarraylib[aliyun]
+
+# 只安装MySQL工具相关依赖
+pip install pixelarraylib[mysql]
+
+# 只安装Redis工具相关依赖
+pip install pixelarraylib[redis]
+
+# 只安装监控工具相关依赖
+pip install pixelarraylib[monitor]
+
+# 只安装网络工具相关依赖
+pip install pixelarraylib[net]
+
+# 只安装系统工具相关依赖
+pip install pixelarraylib[system]
+
+# 只安装GitLab工具相关依赖
+pip install pixelarraylib[gitlab]
+
+# 安装所有可选依赖
+pip install pixelarraylib[all]
+
+# 组合安装多个模块
+pip install pixelarraylib[mysql,redis]
+```
+
+**可选依赖说明：**
+- `aliyun`: 阿里云服务集成（OSS、SMS、FC、DM、ECS、ECI等）
+- `mysql`: MySQL数据库工具（pymysql、aiomysql）
+- `redis`: Redis数据库工具
+- `monitor`: 监控告警工具（飞书通知等）
+- `net`: 网络请求工具
+- `system`: 系统工具（加密、SSH等）
+- `gitlab`: GitLab工具（PyPI包管理、代码分析等）
+- `all`: 所有可选依赖
+
+## 使用方法
+
+### 1. Python程序中使用
+
+```python
+# 导入pixelarraylib模块
+import pixelarraylib
+
+# 使用各种功能模块
+from pixelarraylib.aliyun import some_service
+from pixelarraylib.db_utils import database_tools
+from pixelarraylib.decorators import useful_decorators
+```
+
+### 2. 命令行工具使用
+
+安装后，你可以在命令行中直接使用 `pixelarraylib` 命令：
+
+#### 创建测试用例文件
+```bash
+# 一键创建所有测试用例文件
+pixelarraylib create_test_case_files
+```
+
+## 功能特性
+
+- **阿里云服务集成**: 包含CMS、Green、DM、FC、SMS、STS等服务
+- **数据库工具**: MySQL、Redis等数据库操作工具
+- **Web框架**: FastAPI集成
+- **实用工具**: 二维码生成、加密解密、XML处理等
+- **命令行工具**: 测试用例生成、代码统计等实用脚本
+
+## 开发
+
+### 本地开发安装
+
+```bash
+# 克隆仓库
+git clone https://gitlab.com/pixelarrayai/general_pythondevutils_lib.git
+cd general_pythondevutils_lib
+
+# 安装开发依赖
+pip install -e .
+
+# 测试命令行工具
+pixelarraylib --help
+```
+
+### 添加新的命令行工具
+
+1. 在 `pixelarraylib/scripts/` 目录下创建新的脚本文件
+2. 在 `pixelarraylib/__main__.py` 中添加新的命令选项
+3. 更新 `pixelarraylib/scripts/__init__.py` 导出新功能
+
+## 许可证
+
+MIT License
+
+## 作者
+
+Lu qi (qi.lu@pixelarrayai.com) 

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/README.md

@@ -4,10 +4,55 @@ PixelArrayLib是一个功能丰富的Python开发工具库，包含阿里云服
 
 ## 安装
 
+### 基础安装
+
 ```bash
 pip install pixelarraylib
 ```
 
+### 可选依赖安装
+
+为了避免安装不必要的依赖，你可以按需安装特定模块的依赖：
+
+```bash
+# 只安装阿里云服务相关依赖
+pip install pixelarraylib[aliyun]
+
+# 只安装MySQL工具相关依赖
+pip install pixelarraylib[mysql]
+
+# 只安装Redis工具相关依赖
+pip install pixelarraylib[redis]
+
+# 只安装监控工具相关依赖
+pip install pixelarraylib[monitor]
+
+# 只安装网络工具相关依赖
+pip install pixelarraylib[net]
+
+# 只安装系统工具相关依赖
+pip install pixelarraylib[system]
+
+# 只安装GitLab工具相关依赖
+pip install pixelarraylib[gitlab]
+
+# 安装所有可选依赖
+pip install pixelarraylib[all]
+
+# 组合安装多个模块
+pip install pixelarraylib[mysql,redis]
+```
+
+**可选依赖说明：**
+- `aliyun`: 阿里云服务集成（OSS、SMS、FC、DM、ECS、ECI等）
+- `mysql`: MySQL数据库工具（pymysql、aiomysql）
+- `redis`: Redis数据库工具
+- `monitor`: 监控告警工具（飞书通知等）
+- `net`: 网络请求工具
+- `system`: 系统工具（加密、SSH等）
+- `gitlab`: GitLab工具（PyPI包管理、代码分析等）
+- `all`: 所有可选依赖
+
 ## 使用方法
 
 ### 1. Python程序中使用

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/pixelarraylib/__init__.py

@@ -20,7 +20,7 @@ PixelArray Python开发工具库
     from pixelarraylib.gitlab import pypi_package_manager
 """
 
-__version__ = "1.1.2"
+__version__ = "1.1.3"
 __author__ = "PixelArray"
 __email__ = "qi.lu@pixelarrayai.com"
 

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/pixelarraylib/__main__.py

@@ -1,12 +1,13 @@
 #!/usr/bin/env python3
 """
-ArrayLib 命令行工具入口点
+PixelArrayLib 命令行工具入口点
 支持的命令：
 - pixelarraylib create_test_case_files
 - pixelarraylib collect_code_to_txt [options]
 - pixelarraylib nginx_proxy_to_ecs [options]
 - pixelarraylib remove_empty_lines <input_file> [output_file]
 - pixelarraylib build_website
+- pixelarraylib tson_convert [options]
 """
 
 import sys
@@ -17,7 +18,7 @@ def main():
     # 检查是否有子命令
     if len(sys.argv) < 2:
         parser = argparse.ArgumentParser(
-            description="ArrayLib 命令行工具",
+            description="PixelArrayLib 命令行工具",
             formatter_class=argparse.RawDescriptionHelpFormatter,
             epilog="""
 示例用法:
@@ -26,6 +27,7 @@ def main():
   pixelarraylib nginx_proxy_to_ecs --help                        # 查看Nginx反向代理到ECS工具帮助
   pixelarraylib remove_empty_lines --help                        # 查看去除空行工具帮助
   pixelarraylib build_website --help                              # 查看一键构建网站工具帮助
+  pixelarraylib tson_convert --help                               # 查看TSON转换工具帮助
             """,
         )
         parser.print_help()
@@ -50,7 +52,7 @@ def main():
         try:
             from pixelarraylib.scripts.collect_code_to_txt import main as collect_main
 
-            # 修改sys.argv，移除第一个参数（arraylib），让collect_code_to_txt正确处理参数
+            # 修改sys.argv，移除第一个参数（pixelarraylib），让collect_code_to_txt正确处理参数
             original_argv = sys.argv
             sys.argv = [original_argv[0]] + original_argv[2:]
             collect_main()
@@ -66,7 +68,7 @@ def main():
                 main as nginx_proxy_to_ecs,
             )
 
-            # 修改sys.argv，移除第一个参数（arraylib），让nginx_proxy_to_ecs正确处理参数
+            # 修改sys.argv，移除第一个参数（pixelarraylib），让nginx_proxy_to_ecs正确处理参数
             original_argv = sys.argv
             sys.argv = [original_argv[0]] + original_argv[2:]
             nginx_proxy_to_ecs()
@@ -82,7 +84,7 @@ def main():
                 main as remove_empty_lines_main,
             )
 
-            # 修改sys.argv，移除第一个参数（arraylib），让remove_empty_lines正确处理参数
+            # 修改sys.argv，移除第一个参数（pixelarraylib），让remove_empty_lines正确处理参数
             original_argv = sys.argv
             sys.argv = [original_argv[0]] + original_argv[2:]
             remove_empty_lines_main()
@@ -103,9 +105,21 @@ def main():
             print(f"错误：无法导入 build_website 模块: {e}")
             sys.exit(1)
 
+    elif command == "tson_convert":
+        # 导入并执行TSON转换功能
+        try:
+            from pixelarraylib.scripts.tson_convert import main as tson_convert_main
+            original_argv = sys.argv
+            sys.argv = [original_argv[0]] + original_argv[2:]
+            tson_convert_main()
+            sys.argv = original_argv
+        except ImportError as e:
+            print(f"错误：无法导入 tson_convert 模块: {e}")
+            sys.exit(1)
+
     elif command in ["-h", "--help"]:
         parser = argparse.ArgumentParser(
-            description="ArrayLib 命令行工具",
+            description="PixelArrayLib 命令行工具",
             formatter_class=argparse.RawDescriptionHelpFormatter,
             epilog="""
 示例用法:
@@ -114,13 +128,14 @@ def main():
   pixelarraylib nginx_proxy_to_ecs --help                        # 查看Nginx反向代理到ECS工具帮助
   pixelarraylib remove_empty_lines --help                        # 查看去除空行工具帮助
   pixelarraylib build_website --help                              # 查看一键构建网站工具帮助
+  pixelarraylib tson_convert --help                               # 查看TSON转换工具帮助
             """,
         )
         parser.print_help()
     else:
         print(f"错误：未知命令 '{command}'")
         print(
-            "可用命令：create_test_case_files, collect_code_to_txt, nginx_proxy_to_ecs, remove_empty_lines, build_website"
+            "可用命令：create_test_case_files, collect_code_to_txt, nginx_proxy_to_ecs, remove_empty_lines, build_website, tson_convert"
         )
         print("使用 'pixelarraylib --help' 查看帮助")
         sys.exit(1)

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/pixelarraylib/decorators/decorators.py

@@ -18,6 +18,17 @@ def catch_exception(
     addtional_alert: str = "",
     alert_channel: str = "devtoolkit服务报警",
 ):
+    """
+    description:
+        异常捕获装饰器，当函数执行失败时发送飞书告警
+    parameters:
+        exception_return(Any): 异常时返回的默认值
+        alert_params(bool): 是否在告警中包含函数参数
+        addtional_alert(str): 额外的告警信息
+        alert_channel(str): 飞书告警频道名称
+    return:
+        decorator(Callable): 装饰器函数
+    """
     feishu_alert = Feishu(alert_channel)
     def get_caller_function_name():
         """
@@ -65,6 +76,15 @@ def with_retry(
     retry_times: int = 3,
     retry_interval: int = 1,
 ) -> Callable:
+    """
+    description:
+        重试装饰器，当函数执行失败时自动重试
+    parameters:
+        retry_times(int): 重试次数，默认为3
+        retry_interval(int): 重试间隔时间（秒），默认为1
+    return:
+        decorator(Callable): 装饰器函数
+    """
     def decorator(func: Callable) -> Callable:
         @functools.wraps(func)
         def wrapper(*args, **kwargs) -> Any:
@@ -85,6 +105,14 @@ def with_retry(
 
 
 def with_timeout(seconds):
+    """
+    description:
+        超时装饰器，限制函数执行时间
+    parameters:
+        seconds(int): 超时时间（秒）
+    return:
+        decorator(Callable): 装饰器函数
+    """
     def decorator(func):
         @wraps(func)
         def wrapper(*args, **kwargs):
@@ -103,6 +131,14 @@ def with_timeout(seconds):
 
 
 def avoid_chinese_filename(func):
+    """
+    description:
+        避免中文文件名的装饰器，自动处理包含中文的文件路径
+    parameters:
+        func(Callable): 被装饰的函数
+    return:
+        wrapper(Callable): 包装后的函数
+    """
     def contains_chinese(text):
         if not text:
             return False

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/pixelarraylib/gitlab/code_analyzer.py

@@ -34,11 +34,14 @@ class GitLabCodeAnalyzer:
             self.session = None
 
     async def get_project_id_name_list(self, group_id=None, owned_only=True):
-        """获取项目的 ID 和名称列表
-
-        Args:
-            group_id: 组ID，如果指定则只获取该组的项目
-            owned_only: 是否只获取用户拥有的项目，默认为True以提高速度
+        """
+        description:
+            获取项目的 ID 和名称列表
+        parameters:
+            group_id(int): 组ID，如果指定则只获取该组的项目
+            owned_only(bool): 是否只获取用户拥有的项目，默认为True以提高速度
+        return:
+            project_list(list): 项目列表，每个元素为(id, name)元组
         """
         projects = await self.get_all_projects(
             group_id, owned_only=owned_only, membership_only=True
@@ -48,12 +51,15 @@ class GitLabCodeAnalyzer:
     async def get_all_projects(
         self, group_id=None, owned_only=True, membership_only=True
     ):
-        """获取项目列表
-
-        Args:
-            group_id: 组ID，如果指定则只获取该组的项目
-            owned_only: 是否只获取用户拥有的项目
-            membership_only: 是否只获取用户有权限的项目
+        """
+        description:
+            获取项目列表
+        parameters:
+            group_id(int): 组ID，如果指定则只获取该组的项目
+            owned_only(bool): 是否只获取用户拥有的项目
+            membership_only(bool): 是否只获取用户有权限的项目
+        return:
+            projects(list): 项目列表
         """
         if group_id:
             url = f"{self.gitlab_url}/api/v4/groups/{group_id}/projects"
@@ -107,12 +113,15 @@ class GitLabCodeAnalyzer:
         return projects
 
     async def get_project_code_stats(self, project_id, since=None, until=None):
-        """获取项目的代码统计，包括每个贡献者的提交数和代码行数变化
-
-        Args:
-            project_id: 项目ID
-            since: 开始日期，格式为YYYY-MM-DD
-            until: 结束日期，格式为YYYY-MM-DD
+        """
+        description:
+            获取项目的代码统计，包括每个贡献者的提交数和代码行数变化
+        parameters:
+            project_id(int): 项目ID
+            since(str): 开始日期，格式为YYYY-MM-DD
+            until(str): 结束日期，格式为YYYY-MM-DD
+        return:
+            stats(dict): 代码统计信息
         """
         session = await self._get_session()
 
@@ -257,12 +266,15 @@ class GitLabCodeAnalyzer:
                 return None
 
     async def generate_code_report(self, group_id=None, since=None, until=None):
-        """生成代码统计报告
-
-        Args:
-            group_id: 组ID，如果指定则只获取该组的项目
-            since: 开始日期，格式为YYYY-MM-DD
-            until: 结束日期，格式为YYYY-MM-DD
+        """
+        description:
+            生成代码统计报告
+        parameters:
+            group_id(int): 组ID，如果指定则只获取该组的项目
+            since(str): 开始日期，格式为YYYY-MM-DD
+            until(str): 结束日期，格式为YYYY-MM-DD
+        return:
+            report_data(list): 代码统计报告数据
         """
         projects = await self.get_all_projects(group_id)
         report_data = []
@@ -316,15 +328,15 @@ class GitLabCodeAnalyzer:
         return project_data
 
     async def get_commit_details_report(self, project_id, since=None, until=None):
-        """获取详细的提交信息报告
-
-        Args:
-            project_id: 项目ID
-            since: 开始日期，格式为YYYY-MM-DD
-            until: 结束日期，格式为YYYY-MM-DD
-
-        Returns:
-            List[Dict]: 包含所有提交详细信息的列表
+        """
+        description:
+            获取详细的提交信息报告
+        parameters:
+            project_id(int): 项目ID
+            since(str): 开始日期，格式为YYYY-MM-DD
+            until(str): 结束日期，格式为YYYY-MM-DD
+        return:
+            commits(List[Dict]): 包含所有提交详细信息的列表
         """
         contributors = await self.get_project_code_stats(
             project_id, since=since, until=until

{pixelarraylib-1.1.2 → pixelarraylib-1.1.3}/pixelarraylib/gitlab/pypi_package_manager.py

@@ -15,6 +15,15 @@ class GitLabPyPIPackageManager:
         }
 
     def _find_package_id(self, package_name: str, package_version: str) -> str:
+        """
+        description:
+            查找包的ID
+        parameters:
+            package_name(str): 包名
+            package_version(str): 包版本
+        return:
+            str: 包ID
+        """
         url = f"{self.base_url}/packages"
         params = {
             "package_type": "pypi",
@@ -32,6 +41,12 @@ class GitLabPyPIPackageManager:
         return None
 
     def list_packages(self) -> List[str]:
+        """
+        description:
+            列出所有包
+        return:
+            List[str]: 包列表
+        """
         url = f"{self.base_url}/packages"
         params = {"package_type": "pypi"}
         response = requests.get(url, headers=self.headers, params=params)
@@ -41,6 +56,14 @@ class GitLabPyPIPackageManager:
             return []
 
     def list_package_versions(self, package_name: str) -> List[str]:
+        """
+        description:
+            列出包的版本
+        parameters:
+            package_name(str): 包名
+        return:
+            List[str]: 包版本列表
+        """
         url = f"{self.base_url}/packages"
         params = {"package_type": "pypi", "package_name": package_name}
         response = requests.get(url, headers=self.headers, params=params)
@@ -50,6 +73,15 @@ class GitLabPyPIPackageManager:
             return []
 
     def delete_package(self, package_name: str, package_version: str):
+        """
+        description:
+            删除包
+        parameters:
+            package_name(str): 包名
+            package_version(str): 包版本
+        return:
+            bool: 是否删除成功
+        """
         package_id = self._find_package_id(package_name, package_version)
         if package_id is None:
             raise ValueError(f"Package {package_name} {package_version} not found")