DToolslib 2.5.0

A simple and miscellaneous utility library containing multiple utility scripts. 一个简单且杂的工具库, 包含多个工具脚本

DToolslib

A simple and miscellaneous utility library containing multiple utility scripts. 一个简单且杂的工具库, 包含多个工具脚本

StaticEnum

An enumeration library, supported 一个枚举类库, 支持:

• Unique variables (not repetitively named) 唯一变量(不可重复命名)
• Value cannot be modified 值不可修改
• Custom properties 自定义属性
• Keep the original type (except None, Boolean), you can use isinstance to judge 保留原类型(None, Boolean 除外), 可以使用 isinstance 判断
• It can be read directly, and there is no need to use its value property. Of course, it can also use value 可以直接读取, 不需要使用其 value 属性, 当然也可以使用 value
• For members of type int, if no value is specified, a unique value will be assigned automatically, starting from 0 and incrementing, avoiding conflicts with existing values in the library. 对于Int 类型, 如果没有指定值, 则自动赋值, 从 0 开始, 依次递增, 且不会与库中其他枚举值重复

How to use | 使用方法

[Parameters]:
- enable_repeatable: 
    Whether enum values are allowed to be repeated. 是否允许枚举值重复
- enable_member_attribute: 
    Whether to allow enum members to have attributes. 是否允许枚举成员可以带属性
- enable_member_extension: 
    Whether to allow enum members to extend outside the definition of the enum class. 是否允许枚举成员在枚举类的定义外部扩展
- enum_value_mode: 
      Enum values replace the assignment pattern. 枚举值替换赋值模式
        0: (Default) Do not replace  (默认) 不替换
        1: Replace with integer enumeration value 替换为整数型枚举值
        2: Replace with integer string 替换为整数字符串

class TestEnum(StaticEnum, enable_member_attribute=True):
    A = '#ff0000'
    A.color_name = 'Red'
    A.ansi_font = 31
    A.ansi_background = 41
    B: int
    C: int
    D = None

    class TestEnum2(StaticEnum):
        a = 1
        b = 3
        AA = '#ff00ff'
        BB: int
        CC: int

    class TestEnum3:
        AAA = '#00ff00'
        BBB: int

print(TestEnum.A)  # output: #ff0000
print(TestEnum.A.name)  # output: A
print(TestEnum.A.color_name)  # output: Red
print(TestEnum.A.ansi_font)  # output: 31
print(type(TestEnum.A))  # output: <class '__main__._SEString'>
print(type(TestEnum.TestEnum2.AA))  # output: <class 'str'>
print(isinstance(TestEnum.A, str))  # output: True
print('#ff0000' in TestEnum)  # output: True
print(TestEnum.B, TestEnum.C)  # output: 0 1
print(TestEnum.TestEnum2.BB, TestEnum.TestEnum2.CC, TestEnum.TestEnum3.BBB)  # output: 0 2 0

EventSignal

Imitating the mechanism of Qt's signal and slot, custom signals, this signal can be used out of the Qt framework. There is currently no thread locking and asynchronous mechanism, which supports: 模仿于 Qt 的信号和槽的机制, 自定义的信号, 该信号可以脱离 Qt 框架使用, 目前没有线程锁和异步的机制, 支持:

• Instance signal (default) 实例信号(默认)
• Class signals 类信号
• Attribute protection, the signal cannot be assigned 属性保护, 信号不可被赋值

How to use | 使用方法

class Test:
    signal_instance_a = EventSignal(str)  # Instance Signal
    signal_instance_b = EventSignal(str, int)  # Instance Signal
    signal_class = EventSignal(str, int, signal_scope='class')  # Class Signal
a = Test()
b = Test()
b.signal_instance_a.connect(print)
a.signal_instance_b.connect(b.signal_instance_a)
b.signal_instance_a.emit('This is a test message')
a.signal_instance_a.disconnect(b.signal_instance_a)
# output: This is a test message
print(a.signal_class is b.signal_class)  # output: True
print(a.signal_instance_a is b.signal_instance_a)  # output: False
print(type(a.signal_class))  # output: <class '__main__.EventSignal'>
print(a.__signals__)  # output: {...} a dict with 2 keys, the values are signal instances. You can also see the slots of the signal.
print(a.__class_signals__)  # output: {...} a dict with 1 keys, the values are signal instances. You can also see the slots of the signal.

Logger

Logger, see docstring for details, support: 日志器, 详见 docstring, 支持:

• Clean old logs before startup to define the total number of retained 启动前清理旧日志, 可定义保留总数

• Size splitting 大小分割

• Days segmentation 天数分割

• Function traceability exclusion, class traceability exclusion, module traceability exclusion, for example: Exclude func1 function under ClassA class (assuming the relationship chain is: ClassA->func3->func2->func1), then log positioning will be located to func2

  函数追溯排除, 类追溯排除, 模块追溯排除, 例如: 排除 ClassA 类下的 func1 函数(假设关系链为: ClassA->func3->func2->func1 ), 则日志定位将定位到func2

• Output highlight styles and terminal color styles. After setting, you can obtain HTML style information through the signal. 输出高亮样式, 终端彩色样式. 设置后, 可以通过信号获取 HTML 样式的信息

• Can track logging output 可跟踪 logging 输出

• Can be output with a signal 可通过信号针对性输出

How to use | 使用方法

Log = Logger('test', os.path.dirname(__file__), log_level='info')
Log.signal_debug_message.connect(print)
logging.debug('hello world from logging debug') # logging tracking example
Log.trace('This is a trace message.')
Log.debug('This is a debug message.')
Log.info('This is a info message.')
Log.warning('This is a warning message.')
Log.error('This is a error message.')
Log.critical('This is a critical message.')

LoggerGroup

Logger group, see docstring for details, support 日志器组, 详见 docstring, 支持

• Size splitting 大小分割
• Days segmentation 天数分割
• All Logger information is automatically collected by default, and it can also be manually changed to specify a few Loggers. 默认自动收集所有 Logger 信息, 也可以手动更改为指定某几个 Logger
• Output highlight style, same Logger 输出高亮样式, 同 Logger
• Can be output with a signal 可通过信号针对性输出
• Singleton mode 单例模式

How to use | 使用方法

Log = Logger('test', os.path.dirname(__file__), log_level='info')
Log_1 = Logger('tests', os.path.dirname(__file__), log_sub_folder_name='test_folder', log_level='trace')
Logger_group = LoggerGroup(os.path.dirname(__file__))
Log.info('This is a info message.')
Log_1.warning('This is a warning message.')
Log.error('This is a error message.')
Log_1.critical('This is a critical message.')

Inner_Decorators

Interior Decorators 内部装饰器

• try_except_log: Capture errors and output them to logs. The function needs to be improved and is not recommended 捕捉报错并输出给日志, 功能有待完善, 不推荐使用
• boundary_check: Function/method boundary check, not tested 函数/方法边界检查, 未测试
• time_counter: Calculate the function/method run time and print it 计算函数/方法运行时间, 并打印
• who_called_me: Get the call tree 获取调用树

版本信息 Version Info

v2.4.17

• Improve the StaticEnum non-repeatable assignment, and improve the assignment duplication check when quoting a value 完善 StaticEnum 不可重复赋值, 完善引用赋值时的赋值重复检查

v1.0.0.0

• Refactored the StaticEnum class and added setting function 重构了 StaticEnum 类, 增加了设置功能
• The class names Logger and LoggerGroup are deprecated and have been replaced with JFLogger and JFLoggerGroup, respectively. 弃用了 Logger 和 LoggerGroup 类名, 改为 JFLogger 和 JFLoggerGroup

v0.0.2.3

• 增加信号的线程安全, 完善Logger的函数, 并更名为JFLogger, 以区分于logging的Logger, 修改注释为英文

v0.0.2.1

• 增加信号的异步执行, 但无线程锁, 不保证线程安全

v0.0.1.7

• Added support for Python 3.8 增加对Python 3.8的支持

v0.0.1.6

• Fixed the bug where the Logger would crash when writing to a file if the folder/file did not exist. 修复Logger写入文件时, 文件夹/文件不存在时崩溃的Bug
• Fixed the bug where the Logger would crash when sys.stdout was optimized to None. 修复Logger中sys.stdout被优化时为None而导致崩溃的bug
• Fixed the bug where LoggerGroup would automatically create a folder during initialization even if no file output was specified. 修复LoggerGroup中初始化时即使不输出文件但仍会自动建立文件夹的bug
• Added name and folder_path attributes to the Logger. 增加Logger的name和folder_path属性
• Try to fix the issue where the Logger did not automatically remove its own data from class attributes when it is destroyed. 尝试修复Logger被删除时未能自动删除类属性中的自身数据

v0.0.1.5

• Fixed the error message of EventSignal signal class 修正 EventSignal 信号类的报错信息
• Fixed the issue where numerical values and in-class flags were mixed in iter of StaticEnum 修复StaticEnum中数值和类内标志混合在iter中的问题
• Fixed a bug where disconnecting an EventSignal signal failed when the slot was another signal 修改 EventSignal 信号断开连接时, slot 为信号时无法断开的 bug
• Modified the actual connection signal class name in EventSignal 修改 EventSignal 实际连接信号类名
• Added the display of the number of slot functions when printing EventSignal signals. It will be easier to debug 增加打印EventSignal 信号时对槽函数数量的显示, 便于调试
• Modified the highlight enumeration class LogHighlightType to public access 更改高亮枚举类 LogHighlightType 为公共访问
• Added a check in Logger and LoggerGroup to verify whether the log folder exists before writing to a file, preventing errors when the log folder is deleted during runtime 增加 Logger 和 LoggerGroup 写入文件前对文件夹是否存在进行检查, 保证运行时日志文件夹被删除时不会发生报错
• Added an exclusion setting in LoggerGroup to prevent listening to certain loggers 增加 LoggerGroup 排除对某些日志器监听的设置
• Added the remove_listen_logging method to Logger 新增 Logger 的 remove_listen_logging 方法
• Added the __repr__ method to Logger 增加 Logger 的 __repr__方法
• Fixed incorrect line breaks when the highlighting type is set to HTML 修复高亮类型为 HTML 时, 换行符不对的 bug
• Fixed list and connection errors when adding or removing logger listeners in LoggerGroup 修复 LoggerGroup 增加日志器监听和移除监听时, 列表和连接的错误
• Fixed a logic bug in LoggerGroup's remove_log method 修复 LoggerGroup 的 remove_log 逻辑 bug
• Fixed an issue where Logger was not removed from the logger list upon destruction 修改 Logger 销毁时没有移除Logger列表中的自身元素
• Removed the singleton mode of listeners in Logger 取消 Logger 中监听器的单例模式
• Refactored Logger and LoggerGroup parameters to follow the Qt-style approach. Some initialization parameters are retained, while others must be explicitly set via method calls 对 Logger 和 LoggerGroup 参数传入参考qt风格进行重构, 保留部分初始化参数, 其余参数需显示调用方法进行设置
• Separated Logger's logging listener. If logging needs to be listened to, the method must be explicitly called to enable it 分离 Logger 对 logging 的监听, 如需监听则需显示调用方法进行设置

v0.0.1.4

• The new logger supports the exclusion of combined function names (such as ClassA.func1). Currently, only first-level combinations are supported, that is, the most recent class to which the method belongs must be consistent with the current class at the time of call. 新增日志器支持对组合函数名(如 ClassA.func1)的排除. 目前仅支持一级组合, 即方法所属的最近一级类必须与调用时的当前类一致.
• Fixed the issue that StaticEnum could add new properties outside, as well as the bug in data type errors in multi-layer nested classes inside. 修复 StaticEnum 可在外部新增属性的问题, 以及内部多层嵌套类的数据类型错误的 bug.
• Modified the way data types are converted in the StaticEnum metaclass, changed from the previous eval to created with the class. 更改了 StaticEnum 元类中转换数据类型的方式, 从之前的eval更改为用类创建.