pixelarraylib 1.1.5__tar.gz → 1.1.6__tar.gz

{pixelarraylib-1.1.5/pixelarraylib.egg-info → pixelarraylib-1.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraylib
-Version: 1.1.5
+Version: 1.1.6
 Summary: PixelArray Python开发工具库 - 包含阿里云服务、数据库工具、装饰器、监控等功能
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/__init__.py

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

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/__main__.py

@@ -15,6 +15,10 @@ import argparse
 
 
 def main():
+    """
+    description:
+        PixelArrayLib命令行工具主入口函数
+    """
     # 检查是否有子命令
     if len(sys.argv) < 2:
         parser = argparse.ArgumentParser(

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/acr.py

@@ -18,12 +18,26 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class ACRUtils:
     def __init__(self, region_id: str, access_key_id: str, access_key_secret: str):
+        """
+        description:
+            初始化ACR（容器镜像服务）工具类
+        parameters:
+            region_id(str): 阿里云区域ID
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+        """
         self.region_id = region_id
         self.access_key_id = access_key_id
         self.access_key_secret = access_key_secret
         self.client = self._create_client()
 
     def _create_client(self):
+        """
+        description:
+            创建ACR客户端
+        return:
+            client(cr20181201Client): ACR客户端对象
+        """
         credential = CredentialClient()
         config = open_api_models.Config(
             credential=credential,

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/aliyun_email.py

@@ -14,6 +14,13 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class AliyunEmailSender:
     def __init__(self, access_key_id, access_key_secret):
+        """
+        description:
+            初始化阿里云邮件发送工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+        """
         self.client = Dm20151123Client(
             open_api_models.Config(
                 access_key_id=access_key_id,

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/billing.py

@@ -87,7 +87,15 @@ class BillingUtils:
         }
 
         def add_comment(value, field_name):
-            """为字段值添加注释"""
+            """
+            description:
+                为字段值添加注释
+            parameters:
+                value(Any): 字段值
+                field_name(str): 字段名称
+            return:
+                value_with_comment(str): 带注释的字段值
+            """
             if with_comments and field_name in field_comments:
                 return f"{value} # {field_comments[field_name]}"
             return value
@@ -391,6 +399,14 @@ class BillingUtils:
             # 2) 去除首尾空白，并将内部连续空白压缩为一个空格
             # 3) 去除常见的不可见空白字符（如不间断空格、零宽空格）
             def _clean_string(value):
+                """
+                description:
+                    清洗字符串，去除注释、不可见字符并规范化空白
+                parameters:
+                    value(Any): 需要清洗的值
+                return:
+                    cleaned_value(Any): 清洗后的值
+                """
                 if not isinstance(value, str):
                     return value
                 # 去注释

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/content_scanner.py

@@ -18,6 +18,14 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class ContentScanner:
     def __init__(self, access_key_id, access_key_secret, region_id):
+        """
+        description:
+            初始化内容安全扫描工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            region_id(str): 阿里云区域ID
+        """
         self.client = Client(
             Config(
                 access_key_id=access_key_id,

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/domain.py

@@ -7,12 +7,29 @@ from typing import Optional, Dict, Any
 
 class DomainUtils:
     def __init__(self, access_key_id: str, access_key_secret: str, domain_name: str):
+        """
+        description:
+            初始化域名服务工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            domain_name(str): 域名名称
+        """
         self.domain_name = domain_name
         self.client = self._create_client(access_key_id, access_key_secret)
 
     def _create_client(
         self, access_key_id: str, access_key_secret: str
     ) -> Alidns20150109Client:
+        """
+        description:
+            创建阿里云DNS客户端
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+        return:
+            client(Alidns20150109Client): DNS客户端对象
+        """
         config = open_api_models.Config(
             access_key_id=access_key_id,
             access_key_secret=access_key_secret,

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/ecs.py

@@ -8,6 +8,14 @@ from alibabacloud_tea_util import models as util_models
 
 class ECSUtils:
     def __init__(self, access_key_id: str, access_key_secret: str, region_id: str):
+        """
+        description:
+            初始化ECS（弹性计算服务）工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            region_id(str): 阿里云区域ID
+        """
         self.cms_client = Cms20190101Client(
             open_api_models.Config(
                 type="access_key",

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/eip.py

@@ -15,12 +15,26 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class EIPUtils:
     def __init__(self, region_id: str, access_key_id: str, access_key_secret: str):
+        """
+        description:
+            初始化EIP工具类
+        parameters:
+            region_id(str): 地域ID
+            access_key_id(str): 访问密钥ID
+            access_key_secret(str): 访问密钥Secret
+        """
         self.region_id = region_id
         self.access_key_id = access_key_id
         self.access_key_secret = access_key_secret
         self.client = self._create_client()
 
     def _create_client(self) -> Vpc20160428Client:
+        """
+        description:
+            创建EIP客户端
+        return:
+            Vpc20160428Client: EIP客户端实例
+        """
         config = open_api_models.Config(
             access_key_id=self.access_key_id,
             access_key_secret=self.access_key_secret,

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/fc.py

@@ -16,6 +16,15 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class FCUtils:
     def __init__(self, access_key_id, access_key_secret, account_id, region_id):
+        """
+        description:
+            初始化函数计算（FC）工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            account_id(str): 阿里云账号ID
+            region_id(str): 阿里云区域ID
+        """
         self.client = FC20230330Client(
             open_api_models.Config(
                 access_key_id=access_key_id,
@@ -31,6 +40,18 @@ class FCUtils:
         retry: int = 5,
         timeout: int = 6000 * 1000,
     ) -> tuple[str, bool]:
+        """
+        description:
+            调用函数计算服务中的函数
+        parameters:
+            function_name(str): 函数名称
+            params(dict): 函数参数
+            retry(int): 重试次数，默认为5
+            timeout(int): 超时时间（毫秒），默认为6000秒
+        return:
+            result(str): 函数执行结果
+            success(bool): 是否调用成功
+        """
         last_exception = None
         for i in range(retry):
             try:
@@ -80,6 +101,16 @@ class FCUtils:
         dir_path: str,
         retry: int = 5,
     ) -> tuple[str, bool]:
+        """
+        description:
+            更新函数计算服务中的函数代码
+        parameters:
+            function_name(str): 函数名称
+            dir_path(str): 代码目录路径
+            retry(int): 重试次数，默认为5
+        return:
+            success(bool): 是否更新成功
+        """
         last_exception = None
         for i in range(retry):
             try:

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/oss.py

@@ -29,6 +29,16 @@ class OSSUtils:
         bucket_name,
         use_vpc=False,
     ):
+        """
+        description:
+            初始化OSS工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            region_id(str): 阿里云区域ID
+            bucket_name(str): OSS存储桶名称
+            use_vpc(bool): 是否使用VPC内网端点，默认为False
+        """
         self.bucket_name = bucket_name
         if use_vpc:
             self.endpoint = f"https://oss-{region_id}-internal.aliyuncs.com"

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/sms.py

@@ -12,6 +12,13 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class SMSUtils:
     def __init__(self, access_key_id, access_key_secret):
+        """
+        description:
+            初始化短信服务工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+        """
         self.sms_cilent = Dysmsapi20170525Client(
             open_api_models.Config(
                 type="access_key",
@@ -36,9 +43,9 @@ class SMSUtils:
         """
         description:
             发送验证码给指定手机号
-        param:
-            phone_numbers: 手机号
-            verification_code: 验证码（6位数字）
+        parameters:
+            phone_numbers(str): 手机号
+            verification_code(str): 验证码（6位数字）
         return:
             flag(bool): 是否发送成功
         """
@@ -64,6 +71,13 @@ class SMSUtils:
 
 class SMSUtilsAsync:
     def __init__(self, access_key_id, access_key_secret):
+        """
+        description:
+            初始化异步短信服务工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+        """
         self.sms_cilent = Dysmsapi20170525Client(
             open_api_models.Config(
                 type="access_key",

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/aliyun/sts.py

@@ -15,6 +15,17 @@ class STSUtils:
     def __init__(
         self, access_key_id, access_key_secret, role_arn, region_id, bucket_name, redis_utils
     ):
+        """
+        description:
+            初始化STS（安全令牌服务）工具类
+        parameters:
+            access_key_id(str): 阿里云访问密钥ID
+            access_key_secret(str): 阿里云访问密钥Secret
+            role_arn(str): 角色ARN
+            region_id(str): 阿里云区域ID
+            bucket_name(str): OSS存储桶名称
+            redis_utils(RedisUtils): Redis工具类实例，用于缓存STS令牌
+        """
         assert isinstance(redis_utils, RedisUtils), "redis_utils must be a RedisUtils instance"
         self.access_key_id = access_key_id
         self.access_key_secret = access_key_secret

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/db_utils/mysql.py

@@ -19,6 +19,17 @@ class MysqlUtils:
         port,
         max_retries=3,
     ):
+        """
+        description:
+            初始化MySQL工具类
+        parameters:
+            host(str): 数据库主机地址
+            database(str): 数据库名称
+            user(str): 数据库用户名
+            password(str): 数据库密码
+            port(int): 数据库端口
+            max_retries(int): 最大重试次数，默认为3
+        """
         self.host = host
         self.database = database
         self.user = user
@@ -29,7 +40,10 @@ class MysqlUtils:
         self._connect()
 
     def _connect(self):
-        """建立数据库连接，支持重试"""
+        """
+        description:
+            建立数据库连接，支持重试机制
+        """
         for attempt in range(self.max_retries):
             try:
                 self.mysql = pymysql.connect(
@@ -55,10 +69,19 @@ class MysqlUtils:
                     raise
 
     def get_conn(self):
+        """
+        description:
+            获取MySQL连接对象
+        return:
+            mysql_conn(pymysql.Connection): MySQL连接对象
+        """
         return self.mysql
 
     def _ensure_connection(self):
-        """确保连接有效，如果断开则重新连接"""
+        """
+        description:
+            确保连接有效，如果断开则重新连接
+        """
         try:
             self.mysql.ping(reconnect=True)
         except Exception:
@@ -77,12 +100,13 @@ class MysqlUtils:
 
     def create_table(self, table_name, columns):
         """
-        创建表
+        description:
+            创建数据表
         parameters:
             table_name(str): 表名
-            columns(list(tuple)): 列名和类型
-        returnType:
-            flag(bool): 是否成功
+            columns(list(tuple)): 列名和类型的元组列表
+        return:
+            flag(bool): 是否创建成功
         """
         sql = f"""
             CREATE TABLE {table_name} (
@@ -253,12 +277,28 @@ class MysqlUtils:
             cursor.close()
 
     def clear_table(self, table_name):
+        """
+        description:
+            清空数据表
+        parameters:
+            table_name(str): 表名
+        return:
+            flag(bool): 是否清空成功
+        """
         sql = f"""
             TRUNCATE TABLE {table_name};
         """
         return self.execute_sql(sql)
 
     def delete_table(self, table_name):
+        """
+        description:
+            删除数据表
+        parameters:
+            table_name(str): 表名
+        return:
+            flag(bool): 是否删除成功
+        """
         sql = f"""
             DROP TABLE {table_name};
         """
@@ -275,6 +315,17 @@ class MysqlUtilsAsync:
         port,
         max_retries=3,
     ):
+        """
+        description:
+            初始化异步MySQL工具类
+        parameters:
+            host(str): 数据库主机地址
+            database(str): 数据库名称
+            user(str): 数据库用户名
+            password(str): 数据库密码
+            port(int): 数据库端口
+            max_retries(int): 最大重试次数，默认为3
+        """
         self.host = host
         self.database = database
         self.user = user
@@ -284,13 +335,21 @@ class MysqlUtilsAsync:
         self.async_mysql = None
 
     async def get_async_conn(self):
-        """获取异步MySQL连接"""
+        """
+        description:
+            获取异步MySQL连接对象
+        return:
+            async_mysql_conn(aiomysql.Connection): 异步MySQL连接对象
+        """
         if self.async_mysql is None:
             await self._async_connect()
         return self.async_mysql
 
     async def _async_connect(self):
-        """建立异步数据库连接，支持重试"""
+        """
+        description:
+            建立异步数据库连接，支持重试机制
+        """
         for attempt in range(self.max_retries):
             try:
                 self.async_mysql = await aiomysql.connect(
@@ -316,7 +375,10 @@ class MysqlUtilsAsync:
                     raise
 
     async def _async_ensure_connection(self):
-        """确保异步连接有效，如果断开则重新连接"""
+        """
+        description:
+            确保异步连接有效，如果断开则重新连接
+        """
         try:
             if self.async_mysql is None:
                 await self._async_connect()
@@ -341,12 +403,13 @@ class MysqlUtilsAsync:
 
     async def create_table(self, table_name, columns):
         """
-        异步创建表
+        description:
+            异步创建数据表
         parameters:
             table_name(str): 表名
-            columns(list(tuple)): 列名和类型
-        returnType:
-            flag(bool): 是否成功
+            columns(list(tuple)): 列名和类型的元组列表
+        return:
+            flag(bool): 是否创建成功
         """
         sql = f"""
             CREATE TABLE {table_name} (
@@ -526,19 +589,38 @@ class MysqlUtilsAsync:
                 await cursor.close()
 
     async def clear_table(self, table_name):
+        """
+        description:
+            异步清空数据表
+        parameters:
+            table_name(str): 表名
+        return:
+            flag(bool): 是否清空成功
+        """
         sql = f"""
             TRUNCATE TABLE {table_name};
         """
         return await self.execute_sql(sql)
 
     async def delete_table(self, table_name):
+        """
+        description:
+            异步删除数据表
+        parameters:
+            table_name(str): 表名
+        return:
+            flag(bool): 是否删除成功
+        """
         sql = f"""
             DROP TABLE {table_name};
         """
         return await self.execute_sql(sql)
 
     async def close(self):
-        """关闭异步MySQL连接"""
+        """
+        description:
+            关闭异步MySQL连接
+        """
         if self.async_mysql:
             self.async_mysql.close()
             await self.async_mysql.wait_closed()

{pixelarraylib-1.1.5 → pixelarraylib-1.1.6}/pixelarraylib/db_utils/redis.py

@@ -9,6 +9,15 @@ feishu_alert = Feishu("devtoolkit服务报警")
 
 class RedisUtils:
     def __init__(self, host, port, password, db):
+        """
+        description:
+            初始化Redis工具类
+        parameters:
+            host(str): Redis主机地址
+            port(int): Redis端口
+            password(str): Redis密码
+            db(int): Redis数据库编号
+        """
         self.redis_client = redis.Redis(
             host=host,
             port=port,
@@ -17,6 +26,12 @@ class RedisUtils:
         )
 
     def get_redis_client(self):
+        """
+        description:
+            获取Redis客户端对象
+        return:
+            redis_client(redis.Redis): Redis客户端对象
+        """
         return self.redis_client
 
     def set(self, key, value, expire_seconds=None):
@@ -187,6 +202,10 @@ class RedisUtils:
             return []
 
     def __del__(self):
+        """
+        description:
+            析构函数，关闭Redis连接
+        """
         self.redis_client.close()
 
 
@@ -197,6 +216,12 @@ class RedisUtilsAsync:
         )
 
     async def get_async_redis_client(self):
+        """
+        description:
+            获取异步Redis客户端对象
+        return:
+            async_redis_client(aioredis.Redis): 异步Redis客户端对象
+        """
         return self.async_redis_client
 
     async def set(self, key, value, expire_seconds=None):
@@ -368,6 +393,9 @@ class RedisUtilsAsync:
             return []
 
     async def close(self):
-        """关闭异步Redis连接"""
+        """
+        description:
+            关闭异步Redis连接
+        """
         if self.async_redis_client:
             await self.async_redis_client.close()