jit-utils-backend 0.0.1__py3-none-any.whl

jit_utils/__init__.py

@@ -0,0 +1,152 @@
+# -*-coding:utf-8-*-
+"""
+JIT Utils Backend - 极态后端工具包
+
+A comprehensive utility package for backend development with JIT.
+
+主要功能:
+- 时间处理工具
+- 字符串处理工具
+- 二维码和条形码生成
+- 数据验证
+- 网络工具
+- 签名工具
+等等...
+"""
+
+__version__ = '0.0.1'
+__author__ = 'zangtao'
+
+# 导入主要的工具类和函数
+try:
+    from .decorator import forward
+except ImportError:
+    pass
+
+# 时间工具
+try:
+    from . import time as time_utils
+    # 导出一些常用的时间函数
+    from .time import (
+        now, today, get, dayShift,
+        monday, weekShift, monthStart, monthShift,
+        quarterStart, quarterShift, yearStart, yearShift,
+        getTimestamp, timeStampToDateTime, strToTimestamp,
+        formatNow, datetime2string, string2datetime
+    )
+except ImportError:
+    pass
+
+# 字符串工具
+try:
+    from . import string as string_utils
+    from .string import (
+        randomString, randomNum, getUuidStr,
+        md5Bytes, md5Str, getFileMd5,
+        renderTemplateString
+    )
+except ImportError:
+    pass
+
+# 二维码工具
+try:
+    from .qrcode import Qrcode
+except ImportError:
+    Qrcode = None
+
+# 条形码工具
+try:
+    from .barcode import Barcode
+except ImportError:
+    Barcode = None
+
+# 验证工具
+try:
+    from .validator import ParamsValidator
+except ImportError:
+    ParamsValidator = None
+
+# 网络工具
+try:
+    from . import network
+except ImportError:
+    pass
+
+# 签名工具
+try:
+    from . import signature
+except ImportError:
+    pass
+
+# 匹配工具
+try:
+    from . import matchTool
+except ImportError:
+    pass
+
+# 类工具
+try:
+    from . import clsTool
+except ImportError:
+    pass
+
+# 转换工具
+try:
+    from .convert import Converter, MemoryCompiler
+except ImportError:
+    # 如果导入失败，创建占位符避免 __all__ 报错
+    Converter = None
+    MemoryCompiler = None
+
+# 异常处理
+try:
+    from . import exceptions
+except ImportError:
+    pass
+
+# 工作日常量
+try:
+    from . import workday_constants
+except ImportError:
+    pass
+
+# 配置相关
+try:
+    from . import config
+except ImportError:
+    pass
+
+# 定义 __all__ 列表，控制 from jit_utils import * 的行为
+__all__ = [
+    # 版本信息
+    '__version__',
+    '__author__',
+    
+    # 装饰器
+    'forward',
+    
+    # 时间工具
+    'time_utils',
+    'now', 'today', 'get', 'dayShift',
+    'monday', 'weekShift', 'monthStart', 'monthShift',
+    'quarterStart', 'quarterShift', 'yearStart', 'yearShift',
+    'getTimestamp', 'timeStampToDateTime', 'strToTimestamp',
+    'formatNow', 'datetime2string', 'string2datetime',
+    
+    # 字符串工具
+    'string_utils',
+    'randomString', 'randomNum', 'getUuidStr',
+    'md5Bytes', 'md5Str', 'getFileMd5',
+    'renderTemplateString',
+    
+    # 二维码和条形码
+    'Qrcode', 'Barcode',
+    
+    # 验证工具
+    'ParamsValidator',
+    
+    # 其他模块
+    'network', 'signature', 'matchTool',
+    'clsTool', 'exceptions', 'workday_constants',
+    'config', 'Converter', 'MemoryCompiler'
+]

jit_utils/apiAuthSign.py

@@ -0,0 +1,73 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2024/11/09
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+
+import base64
+import hashlib
+import json
+import time
+
+from jit.commons.utils.logger import log
+
+
+class Sign(object):
+    """
+    这个签名算法用于认证服务和api授权元素
+    """
+
+    EXPIRE_TIME = 5 * 60 * 1000
+    # 签名返回的错误信息，如果是错误信息，返回空tuple，兼容原来通过bool方法校验签名是否通过的写法
+    TIME_OUT_ERROR = []
+    SIGN_CHECK_ERROR = []
+    SIGN_CHECK_SUCCESS = [0]
+
+    def __init__(self, secret):
+        self.secret = secret
+
+    def encode(self, args, timestamp, debug=False):
+        return self.getSign({**args, "timestamp": timestamp, "secret": self.secret}, debug=debug)
+
+    @staticmethod
+    def getSign(args, debug=False):
+        nArgs = {}
+        for k, v in args.items():
+            nArgs[k.lower()] = v
+        sortedKeys = sorted(nArgs.keys())
+        params = []
+        for key in sortedKeys:
+            value = nArgs[key]
+            if not isinstance(value, str):
+                value = json.dumps(value, sort_keys=True, separators=(",", ":"), ensure_ascii=False)
+            params.append(f"{key}={value}")
+        if debug:
+            # 隐藏secret
+            for idx, param in enumerate(params):
+                if param.split("=")[0] == "secret":
+                    params[idx] = "secret=*********************"
+
+            paramStr = "&".join(params)
+
+            apiAuthDebug = {
+                "paramStr": paramStr,
+            }
+            log.debug(",".join("{k}:{v}".format(k=k, v=v) for k, v in apiAuthDebug.items()))
+            if hasattr(app.request, "respExtraData"):
+                app.request.respExtraData["apiAuthDebug"] = apiAuthDebug
+        return hashlib.sha1(base64.b64encode("&".join(params).encode("utf-8"))).hexdigest()
+
+    def verify(self, args):
+        args = args.copy()
+        timestamp = args.pop("timestamp")
+        if abs(int(time.time() * 1000) - int(timestamp)) > self.EXPIRE_TIME:
+            return self.TIME_OUT_ERROR
+        signature = args.pop("accessSign")
+        debug = app.request.headers.get("debug") == "1"
+        if signature == self.encode(args, timestamp, debug=debug):
+            return self.SIGN_CHECK_SUCCESS
+        else:
+            return self.SIGN_CHECK_ERROR

jit_utils/barcode.py

@@ -0,0 +1,50 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2025/02/10
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+import base64
+import io
+
+import barcode
+from barcode.errors import BarcodeError
+from barcode.writer import ImageWriter
+
+
+class Barcode(object):
+    """
+    二维码模块，暂用于文件渲染
+    """
+
+    def __init__(self, value: str, codeType="code128"):
+        self.value = value
+        self.codeType = codeType
+
+    def toByte(self):
+        file = self.toFile()
+        data = file.read()
+        return data
+
+    def toFile(self):
+        obj = barcode.get(self.codeType, self.value, writer=ImageWriter())
+        # 保存条形码为图像文件
+        imageBuffer = io.BytesIO()
+        obj.write(fp=imageBuffer)
+        imageBuffer.seek(0)
+        return imageBuffer
+
+    def toStr(self):
+        if not self.value:
+            return ""
+        try:
+            b64Code = base64.b64encode(self.toByte()).decode("utf-8")
+        except BarcodeError as e:
+            return "ERROR:{}".format(str(e))
+
+        return "<image:{}>".format(b64Code)
+
+    def __str__(self):
+        return self.toStr()

jit_utils/clsTool.py

@@ -0,0 +1,71 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2024/09/29
+
+@author: 臧韬
+
+@desc: 因为框架打包不重启的时候会出现isinstance方法和issubclass函数出现问题，
+       所以重新实现这两个方法，通过类名来确定是否为子类，而不是通过对象ID。
+"""
+
+
+def issubclassByName(cls, class_or_tuple: type | tuple):
+    if isinstance(class_or_tuple, tuple):
+        for cls_name in class_or_tuple:
+            if issubclassByName(cls, cls_name):
+                return True
+        else:
+            return False
+
+    if not isinstance(cls, type):
+        raise TypeError("issubclassByName() arg 0 must be a class")
+
+    if not isinstance(class_or_tuple, type):
+        raise TypeError("isinstanceByName() arg 1 must be a class or tuple with class")
+
+    __className = class_or_tuple.__name__
+    if cls is type:
+        # 特殊情况
+        mroNames = [item.__name__ for item in type.mro(type)]
+    else:
+        mroNames = [item.__name__ for item in cls.mro()]
+    if __className in mroNames:
+        return True
+    else:
+        return False
+
+
+def isinstanceByName(obj, class_or_tuple: type | tuple):
+    if isinstance(class_or_tuple, tuple):
+        for cls_name in class_or_tuple:
+            if isinstanceByName(obj, cls_name):
+                return True
+        else:
+            return False
+
+    if not isinstance(obj, object):
+        raise TypeError("isinstanceByName() arg 0 must be an object")
+
+    if not isinstance(class_or_tuple, type):
+        raise TypeError("isinstanceByName() arg 1 must be a class or tuple with class")
+
+    cls = type(obj)
+    if cls.__name__ == class_or_tuple.__name__:
+        return True
+    return issubclassByName(cls, class_or_tuple)
+
+
+if __name__ == "__main__":
+    A = type("A", (object,), {})
+    B = type("B", (A,), {})
+
+    a = A()
+    b = B()
+
+    print("class B is subclass of A: ", issubclassByName(B, A))
+    print("object b is instance of A: ", isinstanceByName(b, A))
+    print("object b is instance of B: ", isinstanceByName(b, B))
+    print("object b is instance of B or A: ", isinstanceByName(b, (B, A)))
+    print("object a is instance of object: ", isinstanceByName(a, object))
+    print("class A is instance of type: ", isinstanceByName(A, type))
+    print("object a is not instance of type: ", not isinstanceByName(a, type))

jit_utils/config/__init__.py

@@ -0,0 +1,11 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2023/10/23
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+
+from commons.utils.config.config import TlConfig
+from commons.utils.config.field import Field, IntField, StringField

jit_utils/config/case.py

@@ -0,0 +1,77 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2023/10/23
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+from commons.utils.config.config import TlConfig
+from commons.utils.config.field import IntField, StringField
+
+
+class TlConfigCase(object):
+    def normal(self):
+        """这是一个普通使用的例子"""
+
+        class IDCardConfig(TlConfig):
+            name = StringField(maxLen=8, minLen=2, required=True)
+            age = IntField(maxNum=200, minNum=0, default=18)
+
+        config = IDCardConfig(name="张三", age=18)
+        print("normal case: config.name -> {}".format(config.name))
+        print("normal case: config.age -> {}".format(config.age))
+        print("normal case: config.toDict -> {}".format(config.value))
+
+        # 如果没有传入会使用默认值
+        config2 = IDCardConfig(name="李四")
+        print("normal case: config2.age -> {}".format(config2.age))
+
+        try:
+            IDCardConfig(age=21)
+        except Exception as e:
+            print("normal case: error -> {}".format(e))
+
+    def transform(self):
+        class IDCardConfig(TlConfig):
+            name = StringField(maxLen=8, minLen=2)
+            age = IntField(maxNum=200, minNum=0)
+
+        config = IDCardConfig(name="张三", age="18")
+        print("transform case: config.age -> {}".format(config.age))
+        print("transform case: config.age type -> {}".format(type(config.age)))
+
+    def customTransform(self):
+        # 通过自定义的字段来自定义转换方式
+        class DoubleIntField(IntField):
+            def __init__(self, *args, **kwargs):
+                super(DoubleIntField, self).__init__(*args, **kwargs)
+
+                self.transformFunc = self.toDouble
+
+            @staticmethod
+            def toDouble(value):
+                return value * 2
+
+        class MyConfig(TlConfig):
+            # 使用自定义的转换方法
+            double = DoubleIntField(maxNum=200)
+
+        config = MyConfig(double=100)
+
+        # 输出的值变成了输入的两倍
+        print("transform case: config.double -> {}".format(config.double))
+
+        config.double = 20
+
+        # 如果是后面赋值，也会及时校验和转换
+        print("transform case: config.double -> {}".format(config.double))
+        # 检测会在转换后进行检测合法性，这里输入101，通过转换后变成202，超过了字段设置的最大值，所以会触发报错
+        try:
+            config.double = 101
+        except Exception as e:
+            print("transform case: errmsg -> {}".format(e))
+
+
+if __name__ == "__main__":
+    TlConfigCase().normal()

jit_utils/config/config.py

@@ -0,0 +1,90 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2023/10/23
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+from commons.utils.config.field import Field, NoneType
+
+__all__ = ["TlConfig"]
+
+
+class TlConfigMeta(type):
+    def __new__(mcs, name, bases, attrs):
+        _fieldMap = {}
+        _newAttrs = {"_fieldMap": _fieldMap}
+
+        for key, value in attrs.items():
+            if isinstance(value, Field):
+                # 字段名写入到字段对象中
+                value.name = key
+                _fieldMap[key] = value
+            else:
+                _newAttrs[key] = value
+
+        _cls = super(TlConfigMeta, mcs).__new__(mcs, name, bases, _newAttrs)
+        return _cls
+
+
+class TlConfig(metaclass=TlConfigMeta):
+    _autoCheck = True
+
+    def __init__(self, **kwargs):
+        self._originData = kwargs
+        self._transformData = {}
+        self._isTransform = False
+        for key, value in self._fieldMap.items():
+            super(TlConfig, self).__setattr__(key, NoneType)
+        if self._autoCheck:
+            self.check()
+
+    def check(self):
+        if not self._isTransform:
+            for fieldKey, field in self._fieldMap.items():
+                value = self._originData.get(fieldKey, NoneType)
+                setattr(self, fieldKey, value)
+            self._isTransform = True
+
+    def checkOne(self, field, value):
+        value = field.transform(value)
+        if value is NoneType and field.default is not NoneType:
+            value = field.default
+        field.check(value)
+        self._transformData[field.name] = value
+        super(TlConfig, self).__setattr__(field.name, value)
+
+        return value
+
+    def toDict(self):
+        if not self._isTransform:
+            print("警告，该配置没有经过校验和转换，请先调用 self.check()")
+        return self._transformData
+
+    def __setattr__(self, key, value):
+        if not self._autoCheck:
+            super(TlConfig, self).__setattr__("_isTransform", False)
+        if key in self._fieldMap:
+            self._originData[key] = value
+            if self._autoCheck:
+                field = self._fieldMap[key]
+                self.checkOne(field, value)
+        else:
+            super(TlConfig, self).__setattr__(key, value)
+
+    @classmethod
+    def getParamInfo(cls):
+        return list(cls._fieldMap.keys())
+
+    def __getattribute__(self, item):
+        """
+        DEBUG 代码排查模式，尽快删除
+        :param item:
+        :return:
+        """
+        value = super(TlConfig, self).__getattribute__(item)
+        if item.startswith("__"):
+            return value
+        # log.debug("DEBUG MODE: CLS:{}, KEY:{}, VALUE:{}".format(self.__class__.__name__, item, str(value)))
+        return value

jit_utils/config/exception.py

@@ -0,0 +1,17 @@
+# -*-coding:utf-8-*-
+"""
+Created on 2023/10/23
+
+@author: 臧韬
+
+@desc: 默认描述
+"""
+
+from jit.errcode import Code
+
+
+class TlConfigException(Code):
+    DEFAULT_RESULT = "配置信息错误"
+
+    def __init__(self, reason=DEFAULT_RESULT, code=-2, msg=None, solution=None):
+        super(TlConfigException, self).__init__(code=code, reason=reason, msg=msg, solution=solution)