python 日志和调试

python 日志模块使用

---

在调试中，往往使用的是printf来作为输出，通过logging结合coloredlogs可以完美的输出程序运行的日志相关信息。

0x01 Installation

通过终端

$ pip install coloredlogs

安装后，可以通过coloredlogs –demo来查看实际的安装情况以及样例

0x02 Usage

可以参考该样例进行使用

# Create a logger object.
import logging
logger = logging.getLogger(__name__)

# Initialize coloredlogs.
import coloredlogs
coloredlogs.install(level='DEBUG')

# Some examples.
logger.debug("this is a debugging message")
logger.info("this is an informational message")
logger.warn("this is a warning message")
logger.error("this is an error message")
logger.critical("this is a critical message")

0x03 Modify default config

通过修改环境变量可以得到自定义的日志格式

export COLOREDLOGS_LOG_FORMAT='[%(hostname)s] %(asctime)s %(message)s'

## the official examples
%(asctime)s %(hostname)s %(name)s[%(process)d] %(levelname)s %(message)s

python PDB调试模块使用

---

0x01 命令行调试

通过在命令行动态的调试，可以通过python -m pdb file.py可调试

 pdb命令行：
    1）进入命令行Debug模式，python -m pdb xxx.py
    2）h：（help）帮助
    3）w：（where）打印当前执行堆栈
    4）d：（down）执行跳转到在当前堆栈的深一层（个人没觉得有什么用处）
    5）u：（up）执行跳转到当前堆栈的上一层
    6）b：（break）添加断点
                 b 列出当前所有断点，和断点执行到统计次数
                 b line_no：当前脚本的line_no行添加断点
                 b filename:line_no：脚本filename的line_no行添加断点
                 b function：在函数function的第一条可执行语句处添加断点
    7）tbreak：（temporary break）临时断点
                 在第一次执行到这个断点之后，就自动删除这个断点，用法和b一样
    8）cl：（clear）清除断点
                cl 清除所有断点
                cl bpnumber1 bpnumber2... 清除断点号为bpnumber1,bpnumber2...的断点
                cl lineno 清除当前脚本lineno行的断点
                cl filename:line_no 清除脚本filename的line_no行的断点
    9）disable：停用断点，参数为bpnumber，和cl的区别是，断点依然存在，只是不启用
    10）enable：激活断点，参数为bpnumber
    11）s：（step）执行下一条命令
                如果本句是函数调用，则s会执行到函数的第一句
    12）n：（next）执行下一条语句
                如果本句是函数调用，则执行函数，接着执行当前执行语句的下一条。
    13）r：（return）执行当前运行函数到结束
    14）c：（continue）继续执行，直到遇到下一条断点
    15）l：（list）列出源码
                 l 列出当前执行语句周围11条代码
                 l first 列出first行周围11条代码
                 l first second 列出first--second范围的代码，如果second<first，second将被解析为行数
    16）a：（args）列出当前执行函数的函数
    17）p expression：（print）输出expression的值
    18）pp expression：好看一点的p expression
    19）run：重新启动debug，相当于restart
    20）q：（quit）退出debug
    21）j lineno：（jump）设置下条执行的语句函数
                只能在堆栈的最底层跳转，向后重新执行，向前可直接执行到行号
    22）unt：（until）执行到下一行（跳出循环），或者当前堆栈结束
    23）condition bpnumber conditon，给断点设置条件，当参数condition返回True的时候bpnumber断点有效，否则bpnumber断点无效
 
注意：
    1：直接输入Enter，会执行上一条命令；
    2：输入PDB不认识的命令，PDB会把他当做Python语句在当前环境下执行；

0x02 动态调试

---

pdb单步执行太麻烦了，所以第二种方法是import pdb 之后，直接在代码里需要调试的地方放一个pdb.set_trace()，就可以设置一个断点， 程序会在pdb.set_trace()暂停并进入pdb调试环境，可以用pdb 变量名查看变量，或者c继续运行修改下上面的实例如下，import pdb, 添加了pdb.set_trace()到可能出错的代码前面

# test1.py
import pdb
s = '0'
n = int(s)
pdb.set_trace() #运行到这里会自动暂停
print(10/n)

Reference

• https://pypi.org/project/coloredlogs/