Python日志打印里logging.getLogger源码分析详解


Posted in Python onJanuary 17, 2021

实践环境

WIN 10

Python 3.6.5

函数说明

logging.getLogger(name=None)

getLogger函数位于logging/__init__.py脚本

源码分析

_loggerClass = Logger
# ...略
 
root = RootLogger(WARNING)
Logger.root = root
Logger.manager = Manager(Logger.root)
 
# ...略
 
def getLogger(name=None):
  """
  Return a logger with the specified name, creating it if necessary.
 
  If no name is specified, return the root logger.
  """
  if name:
    return Logger.manager.getLogger(name)
  else:
    return root

结论:如函数注释所述,如果调用getLogger时,如果没有指定函数参数(即要获取的日志打印器名称)或者参数值不为真,则默认返回root打印器

Logger.manager.getLogger(self, name)源码分析

该函数位于logging/__init__.py脚本

class Manager(object):
  """
  There is [under normal circumstances] just one Manager instance, which
  holds the hierarchy of loggers.
  """
  def __init__(self, rootnode):
    """
    Initialize the manager with the root node of the logger hierarchy.
    """
    self.root = rootnode
    self.disable = 0
    self.emittedNoHandlerWarning = False
    self.loggerDict = {}
    self.loggerClass = None
    self.logRecordFactory = None
 
  def getLogger(self, name):
    """
    Get a logger with the specified name (channel name), creating it
    if it doesn't yet exist. This name is a dot-separated hierarchical
    name, such as "a", "a.b", "a.b.c" or similar.
 
    If a PlaceHolder existed for the specified name [i.e. the logger
    didn't exist but a child of it did], replace it with the created
    logger and fix up the parent/child references which pointed to the
    placeholder to now point to the logger.
    """
    rv = None
    if not isinstance(name, str):
      raise TypeError('A logger name must be a string')
    _acquireLock()
    try:
      if name in self.loggerDict:
        rv = self.loggerDict[name]
        if isinstance(rv, PlaceHolder):
          ph = rv
          rv = (self.loggerClass or _loggerClass)(name)
          rv.manager = self
          self.loggerDict[name] = rv
          self._fixupChildren(ph, rv)
          self._fixupParents(rv)
      else:
        rv = (self.loggerClass or _loggerClass)(name) # _loggerClass = Logger
        rv.manager = self
        self.loggerDict[name] = rv
        self._fixupParents(rv)
    finally:
      _releaseLock()
    return rv

Logger源码分析

_nameToLevel = {
  'CRITICAL': CRITICAL,
  'FATAL': FATAL,
  'ERROR': ERROR,
  'WARN': WARNING,
  'WARNING': WARNING,
  'INFO': INFO,
  'DEBUG': DEBUG,
  'NOTSET': NOTSET,
}
 
# ...略
 
def _checkLevel(level):
  if isinstance(level, int):
    rv = level
  elif str(level) == level:
    if level not in _nameToLevel:
      raise ValueError("Unknown level: %r" % level)
    rv = _nameToLevel[level]
  else:
    raise TypeError("Level not an integer or a valid string: %r" % level)
  return rv
 
# ...略
class PlaceHolder(object):
  """
  PlaceHolder instances are used in the Manager logger hierarchy to take
  the place of nodes for which no loggers have been defined. This class is
  intended for internal use only and not as part of the public API.
  """
  def __init__(self, alogger):
    """
    Initialize with the specified logger being a child of this placeholder.
    """
    self.loggerMap = { alogger : None }
 
  def append(self, alogger):
    """
    Add the specified logger as a child of this placeholder.
    """
    if alogger not in self.loggerMap:
      self.loggerMap[alogger] = None
 
 
 
class Logger(Filterer):
  """
  Instances of the Logger class represent a single logging channel. A
  "logging channel" indicates an area of an application. Exactly how an
  "area" is defined is up to the application developer. Since an
  application can have any number of areas, logging channels are identified
  by a unique string. Application areas can be nested (e.g. an area
  of "input processing" might include sub-areas "read CSV files", "read
  XLS files" and "read Gnumeric files"). To cater for this natural nesting,
  channel names are organized into a namespace hierarchy where levels are
  separated by periods, much like the Java or Python package namespace. So
  in the instance given above, channel names might be "input" for the upper
  level, and "input.csv", "input.xls" and "input.gnu" for the sub-levels.
  There is no arbitrary limit to the depth of nesting.
  """
  def __init__(self, name, level=NOTSET):
    """
    Initialize the logger with a name and an optional level.
    """
    Filterer.__init__(self)
    self.name = name
    self.level = _checkLevel(level)
    self.parent = None
    self.propagate = True
    self.handlers = []
    self.disabled = False
 
  # ... 略

结论:如果调用logging.getLogger()时,有指定日志打印器名称,且名称为真(不为空字符串,0,False等False值),

1)如果名称为不存在的日志打印器名称,则,且参数值为真,但是即要获取的日志打印器名称)或者参数值不为真,则创建一个名为给定参数值的日志打印器,该日志打印器,默认级别默认为NOTSET,disable_existing_loggers配置为False,propagate配置为True。然后在日志打印器字典中记录该名称和日志打印器的映射关系,接着调用 _fixupParents(创建的日志打印器实例)类实例方法--为日志打印器设置上级日志打印器,最后返回该日志打印器。

2)如果名称已存在日志打印器名称,则获取该日志打印器,然后判断日志打印器是否为PlaceHolder类实例,如果是,则创建一个名为所给参数值的日志打印器,同第1)点,该日志打印器,默认级别默认为NOTSET,disable_existing_loggers配置为False,propagate配置为True。然后在日志打印器字典中记录该名称和日志打印器的映射关系,接着调用 _fixupParents(创建的打印器实例)类实例方法,_fixupChildren(PlaceHolder类实例--根据名称获取的日志打印器,新建的日志打印器实例)--为新建日志打印器设置上级日志打印器,为PlaceHolder类实例现有下级PlaceHolder日志打印器实例重新设置上级日志打印器,最后返回该日志打印器。

_fixupParents及_fixupChildren函数源码分析

# _fixupParents
 
# ...略
class Manager(object):
  # ...略
  def _fixupParents(self, alogger):
    """
    Ensure that there are either loggers or placeholders all the way
    from the specified logger to the root of the logger hierarchy.
    """
    name = alogger.name # 获取日志打印器名称
    i = name.rfind(".")
    rv = None # 存放alogger日志打印器的上级日志打印器
    while (i > 0) and not rv: # 如果名称中存在英文的点,并且找到上级日志打印器
      substr = name[:i] # 获取名称中位于最后一个英文的点的左侧字符串(暂且称至为 点分上级)
      if substr not in self.loggerDict: # 如果 点分上级 不存在日志打印器字典中
        self.loggerDict[substr] = PlaceHolder(alogger) # 创建PlaceHolder实例作为 点分上级 对应的日志打印器 # 继续查找点分上级日志打印器 # 注意,这里的PlaceHolder仅是占位用,不是真的打印器,这里为了方便描述,暂且称之为PlaceHolder日志打印器
      else: # 否则
        obj = self.loggerDict[substr] # 获取 点分上级 对应的日志打印器
        if isinstance(obj, Logger): # 如果为Logger实例,如果是,则跳出循环,执行 # 为日志打印器设置上级
          rv = obj
        else: # 否则
          assert isinstance(obj, PlaceHolder) # 断言它为PlaceHolder的实例
          obj.append(alogger) # 把日志打印器添加为点分上级对应的PlaceHolder日志打印器实例的下级日志打印器 执行 # 继续查找点分上级日志打印器
      i = name.rfind(".", 0, i - 1) # 继续查找点分上级日志打印器
    if not rv: # 找不到点分上级、或者遍历完所有点分上级,都没找到上级日志打印器
      rv = self.root # 则 把root日志打印器设置为alogger日志打印器的上级日志打印器
    alogger.parent = rv # 为日志打印器设置上级
 
 
 
  def _fixupChildren(self, ph, alogger):
    """
    Ensure that children of the placeholder ph are connected to the
    specified logger.
    """
    name = alogger.name # 获取日志打印器名称
    namelen = len(name) # 获取日志打印器名称长度
    for c in ph.loggerMap.keys(): # 遍历获取的PlaceHolder日志打印器实例的子级日志打印器
      #The if means ... if not c.parent.name.startswith(nm)
      if c.parent.name[:namelen] != name: # 如果PlaceHolder日志打印器实例名称不以alogger日志打印器名称为前缀,
        alogger.parent = c.parent # 那么,设置alogger日志打印器的上级日志打印器为PlaceHolder日志打印器
        c.parent = alogger # 设置alogger日志打印器为PlaceHolder日志打印器原有下级PlaceHolder日志打印器的上级

结论:日志打印器都是分父子级的,这个父子层级是怎么形成的,参见上述函数代码注解

到此这篇关于Python日志打印里logging.getLogger源码分析详解的文章就介绍到这了,更多相关Python logging.getLogger源码分析内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python通过PIL获取图片主要颜色并和颜色库进行对比的方法
Mar 19 Python
python批量提取word内信息
Aug 09 Python
用Python抢过年的火车票附源码
Dec 07 Python
Python升级导致yum、pip报错的解决方法
Sep 06 Python
python实现守护进程、守护线程、守护非守护并行
May 05 Python
python使用参数对嵌套字典进行取值的方法
Apr 26 Python
利用pyinstaller打包exe文件的基本教程
May 02 Python
Django-Model数据库操作(增删改查、连表结构)详解
Jul 17 Python
Django配置MySQL数据库的完整步骤
Sep 07 Python
Python 中@property的用法详解
Jan 15 Python
python list的index()和find()的实现
Nov 16 Python
python 爬取腾讯视频评论的实现步骤
Feb 18 Python
Python中的面向接口编程示例详解
Jan 17 #Python
Python学习之time模块的基本使用
Jan 17 #Python
python中re模块知识点总结
Jan 17 #Python
史上最详细的Python打包成exe文件教程
Jan 17 #Python
python制作微博图片爬取工具
Jan 16 #Python
python工具——Mimesis的简单使用教程
Jan 16 #Python
Python 内存管理机制全面分析
Jan 16 #Python
You might like
PHP实现CSV文件的导入和导出类
2015/03/24 PHP
PHP删除数组中指定值的元素常用方法实例分析【4种方法】
2018/08/21 PHP
详解PHP实现支付宝小程序用户授权的工具类
2018/12/25 PHP
详解PHP 二维数组排序保持键名不变
2019/03/06 PHP
extjs grid设置某列背景颜色和字体颜色的实现方法
2010/09/06 Javascript
jQuery 1.5最新版本的改进细节分析
2011/01/19 Javascript
Js 导出table内容到Excel的简单实例
2013/11/19 Javascript
jquery禁止回车触发表单提交
2014/12/12 Javascript
js中 javascript:void(0) 用法详解
2015/08/11 Javascript
jQuery动态添加
2016/04/07 Javascript
JS简单实现仿百度控制台输出信息效果
2016/09/04 Javascript
原生js简单实现放大镜特效
2017/05/16 Javascript
React Native中导航组件react-navigation跨tab路由处理详解
2017/10/31 Javascript
react 创建单例组件的方法
2018/04/26 Javascript
Python简单获取自身外网IP的方法
2016/09/18 Python
Python中的连接符(+、+=)示例详解
2017/01/13 Python
Python实现中文数字转换为阿拉伯数字的方法示例
2017/05/26 Python
python内置函数:lambda、map、filter简单介绍
2017/11/16 Python
Python中浅拷贝copy与深拷贝deepcopy的简单理解
2018/10/26 Python
解决python多行注释引发缩进错误的问题
2019/08/23 Python
python实现七段数码管和倒计时效果
2019/11/23 Python
如何基于python实现归一化处理
2020/01/20 Python
python 从list中随机取值的方法
2020/11/16 Python
巴西最大的巴士票务门户:Quero Passagem
2020/11/21 全球购物
Vrbo西班牙:预订您的度假公寓(公寓、乡村房屋…)
2020/04/27 全球购物
文言文形式的学生求职信
2013/12/03 职场文书
销售演讲稿范文
2014/01/08 职场文书
学校先进集体事迹材料
2014/05/31 职场文书
医疗专业毕业生求职信
2014/08/28 职场文书
2014年车间工作总结
2014/11/21 职场文书
2015年清明节网上祭英烈留言寄语
2015/03/04 职场文书
遗愿清单观后感
2015/06/09 职场文书
2019个人年度目标制定攻略!
2019/07/12 职场文书
学会用Python实现滑雪小游戏,再也不用去北海道啦
2021/05/20 Python
Java中PriorityQueue实现最小堆和最大堆的用法
2021/06/27 Java/Android
零基础学java之方法的定义与调用详解
2022/04/10 Java/Android