Python 中的调试与错误处理-try、assert断言语句与logging打印日志到控制台与文件详解

try… except… finally 语句块

使用try来处理错误语句以及可能出现的异常情况，格式：

try:
    …
except ErrorType as e:
    …
except OtherErrorType as e:
    …
finally:
    …

代码会尝试运行try中的内容，如果正常就继续运行，跳过（多个）except直接运行finally的代码，如果出现了except中期望的错误，不会被打断，而是进入对应的except代码块，最后依然进入运行finally的代码，即finally的代码是一定会执行的。

一个例子：

try:
    print("in try statement")
    a = 10 / 0
except ZeroDivisionError as e:
    print("error: ", e)
except ValueError as e:
    print("error: ", e)
finally:
    print("in finally statement")

assert 语句

assert 断言语句的意思是，断定后边的句子是对的，否则就会有 AssertionError 抛出，并且给出逗号后边的信息，注意断言会抛出错误、打断程序，但是相比于print来输出信息的好处是可以自定义一些更详细的错误信息，往往在为了保证某些通常应该成立的条件时使用，比如一个卷积神经网络的输入矩阵的大小，可以在传入前使用assert确保正确。格式：

assert statement, otherwise-information

一个例子：

def my_print(n):
    assert n != 0, "N equals to 0!"
    print(n)

my_print(0)  # AssertionError: N equals to 0!

在运行Python程序时，使用 -O 参数可以关闭断言，使用后，所有的assert会被作为pass处理：

python -O main.py

logging语句

使用logging可以打印一些信息，使用时需要引入 logging 模块（import logging），他和print相比的好处在于：

  • 可以限制打印信息的级别，一共有五个级别，从低到高为：debug、info、warning、error、critical，通过 logging.basicConfig(level=loggin.CONFIG) 来设置，其中CONFIG替换为需要设置的级别（使用对应的大写字母，上边五个分别对应：DEBUG、INFO、WARNING、ERROR、CRITICAL），默认为WARNING，设置级别后，该级别以下的信息会被忽略，比如设置WARNING，这样info和debug的信息不会在被显示。
  • 可以打印信息到控制台，对应于上边的五个级别，使用logging打印信息到控制台分别对应着如下的语句：
  • logging.debug("debug logs")
  • logging.info("info logs")
  • logging.warning("warning logs")
  • logging.error("error logs")
  • logging.critical("critical logs") 同时可以使用 logging.basicConfig(format = "YOUR FORMAT") 自定义打印信息的格式，比如（官方文档中的例子）：'%(asctime)s - %(name)s - %(levelname)s: - %(message)s'
  • 可以把信息输出到文件，以便保存，使用 logging.basicConfig(filename='FILENAME',filemode='a') 来设置，其中filename即存储信息的文件，filemode指定写文件的模式，可选'a'：追加，或者'w'：每次重写两种。同样可以使用format参数指定打印内容的格式。如果设置了这两个参数，就不会再打印到控制台，只会打印到文件中。

通过使用Handler设置logging同时输出到控制台和文件

这里直接给出示例代码：

import logging

logger = logging.getLogger()  # 不加名称设置root logger
logger.setLevel(logging.DEBUG)  # 设置打印信息的全局级别
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s: - %(message)s',
                              datefmt='%Y-%m-%d %H:%M:%S')  # 设置打印信息格式

# 使用FileHandler输出到文件
fh = logging.FileHandler('log.txt')  # 文件位置
fh.setLevel(logging.DEBUG)  # 文件内信息级别
fh.setFormatter(formatter)  # 设置打印格式

# 使用StreamHandler输出到屏幕
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)  # 打印到屏幕的信息级别
ch.setFormatter(formatter)  # 设置打印格式

# 添加两个Handler
logger.addHandler(ch)
logger.addHandler(fh)