Python 第三方打印库介绍 — LK Logger

lk-logger 是一个增强型的打印库, 它被设计为能直接替换 python 内置的 print 函数, 在此之上提供两个对开发者更友好的功能:

下面的两张图直观地说明 print 和 lk-logger 的打印效果区别:

安装和使用

通过 pip 安装, 支持 python 3.8 及以上版本:

pip install lk-logger

使用方法很简单, 在主入口文件添加下面两行代码, 则全部脚本都会生效:

# main.py

# add two lines to import & setup lk-logger
import lk_logger
lk_logger.setup()

# now it effects
print('hello world')
#   ./main.py:8  >  hello world

以上, 几乎就是 lk-logger 的全部用法.

更多用法

显示变量名

import lk_logger
lk_logger.setup(show_varnames=True)
#               ^^^^^^^^^^^^^^^^^^
a = 1
b = 2
print(a, b, a + b)

设置 setup 函数传参 show_varnames=True, lk-logger 会检测源代码中的变量名, 伴随值一同打印出来:

它的效果类似于 print(f'a = {}; b = {}; a + b = {}'.format(a, b, a + b)), 但明显地书写要简洁得多.

美化来自第三方库的打印

假设导入的第三方库 (比如 “site-packages” 目录下的第三方包) 也用了 print 代码, lk-logger 会缩写源文件路径, 并以其他颜色高亮显示库名称:

import lk_logger
lk_logger.setup(quiet=True, show_varnames=True)

import depsland  # pip install depsland
# ^ there are some prints in depsland initial time.
#   let's see the print results.
print(depsland.__version__)

高亮文本

下面是一部分常见的高亮效果示例, 完整的语法标记表在后面的 “标记语法” 一节给出.

import lk_logger
lk_logger.setup(quiet=True)

print('[red]hello[/] [yellow]world[/]', ':r')
# ^ notice ':r' mark, we'll explain later.

print(':d', 'divider line')

# verbosities
print(':v0', 'debug')
print(':v1', 'info (dimmed)')
print(':v2', 'info')
print(':v3', 'success (dimmed)')
print(':v4', 'success')
print(':v5', 'warning (dimmed)')
print(':v6', 'warning')
print(':v7', 'error (dimmed)')
print(':v8', 'error')

异常处理

lk-logger 依赖 rich 库, 后者提供了漂亮的异常信息界面:

import lk_logger
lk_logger.setup(quiet=True)
# try to raise an error
x = 1 / 0

在 IPython 中使用

lk-logger 在 ipython 中对效果进行了一些调整, 减少了信息的干扰, 以适应 ipython 的使用场景.

该功能是自动的, 不需要在代码中额外添加参数.

计时和计数

这里会用到 “标记用法”, 关于标记语法会在后续章节详细说明, 下面仅作效果展示:

import lk_logger
lk_logger.setup(quiet=True)

print(':d', 'indexing')
print(':i', 'aaa')
print(':i', 'bbb')
print(':i', 'ccc')
print(':i0', 'reset counter')
print(':i', 'ddd')
print(':i', 'eee')
print(':i', 'fff')

print(':d', 'timing')
from time import sleep
sleep(0.1)
print(':t', '... in a short delay')
sleep(1)
print(':t', '... in a little long delay')
sleep(5)
print(':t', '... in a long delay')

进阶用法

反射源码层级

默认情况下, lk-logger 打印的是当前的源码所在的文件行号. 有时候我们会想打印源码的上一层级 (frame), 以便了解是谁在调用当前模块.

假设有一个函数叫 “借阅图书”, 当这个函数被调用时, 我们想知道是谁在借阅图书 (也就是打印借阅者所在的文件行号), 可以这样做:

import lk_logger
lk_logger.setup(quiet=True, show_varnames=True)


def borrow_a_book(username: str, bookname: str) -> None:
    # use ':p' to point to the parent frame
    print(username, bookname, ':p')


borrow_a_book('Shawn', 'Python Crash Course')

# after a while...

borrow_a_book('Alice', 'Deep Learning With Python')

将打印输出到其他处理器 (实验性功能)

import atexit
import lk_logger
from lk_logger import parallel_printing

lk_logger.setup(quiet=True)

class MyLogger:
    def __init__(self):
        self._buffer = []
        atexit.register(self.close)
    
    def write(self, msg: str):
        self._buffer.append(msg)
        
    def close(self) -> None:
        with open('log.txt', 'w') as f:
            f.write('\n'.join(self._buffer))

class MyGui:
    def update_ui(self, msg: str) -> None:
        """ send message to GUI log panel. """
        ...

mylogger = MyLogger()
mygui = MyGui()

with parallel_printing(
    mylogger.write,
    mygui.update_ui,
    inherit=True,  # default True. 
    # ^ change to False to prevent default behavior (i.e. printing to console).
):
    print('hello world!')

标记语法

lk-logger 使用 “标记” 来简单快速地实现一些常用的高亮效果或文本格式化处理.

所谓的 “标记”, 是指位于 print 函数的第一个或最后一个参数位置的一个 str 类型的文本, 它以冒号开头, 后跟一个或多个字母和数字, 其形式如下:

print(':i', 'aaa')
print(':d', 'bbb')
print(':v2', 'ccc')
print(':v4t', 'ddd')
print('eee', ':i')
...

完整的标记符号表如下:

每个标记符号后面都可以跟一个数字, 数字范围 0 ~ 9. 如果不加数字, 则使用默认的数字, 如下表所示:

作者：Likianta Me