Log类

#coding:utf-8

import logging
from logging import handlers
from datetime import datetime
import threading
import os

'''
logging模块简介

Python的logging模块提供了通用的日志系统，可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别，并可以采用不同的方式记录日志，比如文件，HTTP GET/POST，SMTP，Socket等，甚至可以自己实现具体的日志记录方式。
logging模块与log4j的机制是一样的，只是具体的实现细节不同。模块提供logger，handler，filter，formatter。

logger：提供日志接口，供应用代码使用。logger最长用的操作有两类：配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象，如果不指定name则返回root对象，多次使用相同的name调用getLogger方法返回同一个logger对象。
handler：将日志记录（log record）发送到合适的目的地（destination），比如文件，socket等。一个logger对象可以通过addHandler方法添加0到多个handler，每个handler又可以定义不同日志级别，以实现日志分级过滤显示。
 filter：提供一种优雅的方式决定一个日志记录是否发送到handler。
 formatter：指定日志记录输出的具体格式。formatter的构造方法需要两个参数：消息的格式字符串和日期字符串，这两个参数都是可选的。
与log4j类似，logger，handler和日志消息的调用可以有具体的日志级别（Level），只有在日志消息的级别大于logger和handler的级别。

logging用法解析

1. 初始化 logger = logging.getLogger("endlesscode")，getLogger()方法后面最好加上所要日志记录的模块名字，后面的日志格式中的%(name)s 对应的是这里的模块名字
2. 设置级别 logger.setLevel(logging.DEBUG),Logging中有NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL这几种级别，日志会记录设置级别以上的日志
3. Handler，常用的是StreamHandler和FileHandler，windows下你可以简单理解为一个是console和文件日志，一个打印在CMD窗口上，一个记录在一个文件上
4. formatter，定义了最终log信息的顺序,结构和内容，我喜欢用这样的格式 '[%(asctime)s] [%(levelname)s] %(message)s', '%Y-%m-%d %H:%M:%S'，
%(name)s Logger的名字
%(levelname)s 文本形式的日志级别
%(message)s 用户输出的消息
%(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(levelno)s 数字形式的日志级别
%(pathname)s 调用日志输出函数的模块的完整路径名，可能没有
%(filename)s 调用日志输出函数的模块的文件名
%(module)s  调用日志输出函数的模块名
%(funcName)s 调用日志输出函数的函数名
%(lineno)d 调用日志输出函数的语句所在的代码行
%(created)f 当前时间，用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d 输出日志信息时的，自Logger创建以 来的毫秒数
%(thread)d 线程ID。可能没有
%(threadName)s 线程名。可能没有
%(process)d 进程ID。可能没有

'''


LOG_FILE_NAME = "haigeekAssistant.log"

def getLogger():
    """
    :brief  日志记录
    :param log_filename: 日志名称
    :param level: 日志等级
    :param when: 间隔时间:
        S:秒
        M:分
        H:小时
        D:天
        W:每星期（interval==0时代表星期一）
        midnight: 每天凌晨
    :param back_count: 备份文件的个数，若超过该值，就会自动删除
    :return: logger
    """

    logger = logging.getLogger(LOG_FILE_NAME)
    level = logging.INFO
    logger.setLevel(level)


    # log输出格式
    formatter = logging.Formatter('%(asctime)s - %(levelname)s - [%(filename)s:%(lineno)d] - %(message)s')
    # 输出到控制台
    ch = logging.StreamHandler()
    ch.setLevel(level)

    #方式1：输出到文件,按时间切割
    # fh = logging.handlers.TimedRotatingFileHandler(
    #     filename=log_file_path,
    #     when='D',
    #     backupCount=10,
    #     encoding='utf-8')
    #

    # 方式2输出到文件,按文件大小切割
    fh = logging.handlers.RotatingFileHandler(
        filename= getLogPath(),
        maxBytes=104857600,
        backupCount=20,
        encoding="utf-8")

    '''
    RotatingFileHandler函数参数说明：
    log_path     日志路径，程序可自动创建
    maxBytess    单个日志文件的大小
    backupCount  最多保留几个日志文件
    encoding     指定日志文件的编码格式
    '''

    fh.setLevel(level)

    # 设置日志输出格式
    fh.setFormatter(formatter)
    ch.setFormatter(formatter)
    # 添加到logger对象里
    if  not  logger.handlers:
        logger.addHandler(fh)
        logger.addHandler(ch)
    return logger

def getLogPath():
    LOG_PATH = os.path.dirname(os.getcwd()) + '\Log'
    if not os.path.exists(LOG_PATH):
        os.mkdir(LOG_PATH)
    LOG_FILE_PATH = os.path.join(LOG_PATH, LOG_FILE_NAME)
    return LOG_FILE_PATH
猜你喜欢
