logging基本介紹

先介紹一下我們?yōu)槭裁匆褂萌罩?#xff0c;平常我們編寫(xiě)程序?yàn)榱蓑?yàn)證程序運(yùn)行與debug，通常會(huì)使用print函數(shù)來(lái)對(duì)一些中間結(jié)果進(jìn)行輸出驗(yàn)證，在驗(yàn)證成功后再將print語(yǔ)句注釋或刪除掉。這樣做在小型程序中還比較靈活，但是對(duì)于大型項(xiàng)目來(lái)說(shuō)，就十分繁瑣了----->所以使用日志log就很自然了，日志可以調(diào)整日志級(jí)別，來(lái)決定我們是否輸出對(duì)應(yīng)級(jí)別的日志，同時(shí)還可以將日志導(dǎo)入文件記錄下來(lái)。

再介紹一下logging中的log級(jí)別：

Level

Numeric Value

logging.CRITICAL

50

logging.ERROR

40

logging.WARNING

30

logging.INFO

20

logging.DEBUG

10

實(shí)際上這些level都是整數(shù)值，可由如type(logging.info)驗(yàn)證為int類(lèi)型。

模塊級(jí)的使用方法

實(shí)際上logging是一個(gè)package而不是module，以下對(duì)于源碼的討論都是在logging的__init__.py文件中的。

logging模塊的模塊級(jí)使用方法就是使用一些模塊級(jí)接口函數(shù)。而且還有一個(gè)比較重要的是對(duì)日志的輸出形式和輸出目的地等進(jìn)行設(shè)置。

接口函數(shù)也是對(duì)應(yīng)日志級(jí)別而輸出信息的：

logging.debug(msg)

logging.info(msg)

logging.warning(msg)

logging.error(msg)

logging.critical(msg)

這幾個(gè)函數(shù)除了日志級(jí)別上的區(qū)別，其實(shí)都是使用默認(rèn)的root logger來(lái)對(duì)信息進(jìn)行l(wèi)og的，它是處于日志器層級(jí)關(guān)系最頂層的日志器，且該實(shí)例是以單例模式存在的。見(jiàn)源碼：

def info(msg, *args, **kwargs):

if len(root.handlers) == 0:

basicConfig()

root.info(msg, *args, **kwargs)

這里可以見(jiàn)到在logging模塊的info函數(shù)中：(1)首先進(jìn)行了一個(gè)對(duì)于root logger的handlers屬性的長(zhǎng)度判斷是否調(diào)用basicConfig函數(shù)。(2)之后是調(diào)用root logger的info函數(shù)來(lái)實(shí)現(xiàn)功能的。

這里對(duì)于第(2)點(diǎn)我們進(jìn)一下探尋：

root = RootLogger(WARNING)

在logging的源碼中可以看到如上語(yǔ)句，即我們將logging模塊import后，其實(shí)已經(jīng)默認(rèn)的創(chuàng)建了一個(gè)root logger對(duì)象，并且logging自己維護(hù)有一個(gè)Logger實(shí)例的hierarchy(通過(guò)Manager實(shí)例對(duì)象，它和root logger一樣也是單例的使用模式)，我們自己創(chuàng)建的logger實(shí)例對(duì)象，都是是root logger的孩子。

日志的設(shè)置

對(duì)于日志的設(shè)置，我們是使用logging.basicConfig(**kwargs)函數(shù)，它是對(duì)root logger進(jìn)行設(shè)置的，一般使用較多的關(guān)鍵字參數(shù)如下：

level 決定root logger的日志級(jí)別。

format 它是日志格式字符串，指定日志輸出的字段信息，如日期，日志級(jí)別，文件名，當(dāng)然還有我們的msg信息等等。

datefmt 決定日期字段的輸出格式。

filename 日志信息的輸出目的地文件，不指定時(shí)默認(rèn)輸出到控制臺(tái)。

filemode 目的地文件的打開(kāi)模式，不指定默認(rèn)為"a"。

對(duì)于logging.basicConfig函數(shù)有一點(diǎn)需要注意：我們不能在該函數(shù)前使用任何模塊級(jí)日志輸出函數(shù)如logging.info、logging.error，因?yàn)樗鼈儠?huì)調(diào)用一個(gè)不帶參的basicConfig函數(shù)，使得logging.basicConfig函數(shù)失效。見(jiàn)源碼(由于代碼過(guò)多，建議參考注釋進(jìn)行閱讀)：

def basicConfig(**kwargs):

_acquireLock()

try:

#這里由于不帶參調(diào)用basicConifg，

#而root.handlers默認(rèn)為空列表

#在Logger定義中可見(jiàn)self.handlers被設(shè)為[]，

#而默認(rèn)的root實(shí)例在創(chuàng)建時(shí)只指定了log級(jí)別

#所以if條件必然通過(guò)

if len(root.handlers) == 0:

#由于不帶參，所以handlers必為None

handlers = kwargs.pop("handlers", None)

if handlers is None:

#這里由于不帶參，所以即是handlers為None

#通過(guò)上面的if判斷，但kwargs同樣為None，

#所以該if不通過(guò)

if "stream" in kwargs and "filename" in kwargs:

raise ValueError("'stream' and 'filename' should not be "

"specified together")

else:

if "stream" in kwargs or "filename" in kwargs:

raise ValueError("'stream' or 'filename' should not be "

"specified together with 'handlers'")

#這里由于handlers為None通過(guò)if判斷繼續(xù)執(zhí)行

if handlers is None:

filename = kwargs.pop("filename", None)

mode = kwargs.pop("filemode", 'a')

if filename:

h = FileHandler(filename, mode)

#不帶參，kwargs為None，所以filename

#在上面的執(zhí)行語(yǔ)句的返回值為None，所以

#執(zhí)行這個(gè)else分支

else:

stream = kwargs.pop("stream", None)

h = StreamHandler(stream)

#注意這里，十分重要，可見(jiàn)handlers終于不為None

#被賦予了一個(gè)列表，該列表有一個(gè)元素h

handlers = [h]

dfs = kwargs.pop("datefmt", None)

style = kwargs.pop("style", '%')

if style not in _STYLES:

raise ValueError('Style must be one of: %s' % ','.join(

_STYLES.keys()))

fs = kwargs.pop("format", _STYLES[style][1])

fmt = Formatter(fs, dfs, style)

#再看這里，十分重要

for h in handlers:

#這個(gè)無(wú)所謂，就是對(duì)format進(jìn)行默認(rèn)設(shè)置

if h.formatter is None:

h.setFormatter(fmt)

#這里最為關(guān)鍵，可見(jiàn)root.addHandler(h)函數(shù)

#會(huì)把h添加進(jìn)root.handlers列表中，那么很顯然

#root.handlers不再是一個(gè)空列表

root.addHandler(h)

level = kwargs.pop("level", None)

if level is not None:

root.setLevel(level)

if kwargs:

keys = ', '.join(kwargs.keys())

raise ValueError('Unrecognised argument(s): %s' % keys)

finally:

_releaseLock()

所以即是不帶參調(diào)用basicConfig()，但是經(jīng)過(guò)其函數(shù)體執(zhí)行，root.handlers的列表長(zhǎng)度會(huì)不為0，所以之后再調(diào)用logging.basicConifg函數(shù)時(shí)，對(duì)root.handlers判斷，就會(huì)因此而直接略過(guò)函數(shù)體中try部分(主要部分)，直接執(zhí)行finally，沒(méi)有進(jìn)行任何設(shè)置。(并且很關(guān)鍵的basicConfig函數(shù)就是對(duì)root logger的handlers進(jìn)行設(shè)置)

對(duì)象級(jí)使用

在logging模塊中l(wèi)ogger對(duì)象從來(lái)都不是直接實(shí)例化，而是通過(guò)一個(gè)模塊級(jí)借口完成：logging.getLogger(name=None)，注意我們創(chuàng)建的logger都是root logger的子類(lèi)。而通過(guò)我們自己創(chuàng)建的logger對(duì)象，使用日志記錄也是和模塊級(jí)接口一樣的：

logger.debug(msg)

logger.info(msg)

logger.warning(msg)

logger.error(msg)

logger.critical(msg)

同樣對(duì)于日志格式的設(shè)置也是通過(guò)logging.basicConfig函數(shù)完成的，雖然該函數(shù)是對(duì)root logger實(shí)例對(duì)象的日志格式設(shè)置，但由于Logger類(lèi)方法的特殊實(shí)現(xiàn)，其實(shí)是能夠沿用該設(shè)置的。

并且對(duì)于對(duì)象級(jí)接口，如logger.info函數(shù)：

def info(self, msg, *args, **kwargs):

if self.isEnabledFor(INFO):

self._log(INFO, msg, args, **kwargs)

可見(jiàn)其中沒(méi)有對(duì)basicConfig函數(shù)的調(diào)用，所以也就沒(méi)有修改root.handlers列表，即不會(huì)發(fā)生上文的logging.basciConfig函數(shù)失效的問(wèn)題。

Logger類(lèi)及basicConfig沿用問(wèn)題(無(wú)興趣可略)

上文提到了由于Logger類(lèi)中方法的特殊實(shí)現(xiàn)，使得之后實(shí)例化的logger對(duì)象在進(jìn)行日志輸出記錄時(shí)也能沿用root logger的basicConfig設(shè)定。而這背后的機(jī)制到底是怎樣的呢？先看：

class RootLogger(Logger):

def __init__(self, level):

"""

Initialize the logger with the name "root".

"""

Logger.__init__(self, "root", level)

_loggerClass = Logger

.....

#由上面代碼可見(jiàn)RootLogger其實(shí)就是調(diào)用了Logger類(lèi)

root = RootLogger(WARNING)

#這里是對(duì)Logger類(lèi)綁定兩個(gè)類(lèi)級(jí)屬性

#把root實(shí)例作為L(zhǎng)ogger類(lèi)的一個(gè)root屬性

Logger.root = root

#把root實(shí)例作為參數(shù)傳入Manager類(lèi)，

#并用返回的實(shí)例定義Logger類(lèi)的manager屬性

#并且Manager類(lèi)只會(huì)被實(shí)例化這一次

Logger.manager = Manager(Logger.root)

以上源碼中出現(xiàn)的Manager類(lèi)很重要，在我們的logging.getLogger函數(shù)中：

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:

#結(jié)合上文的代碼，我們使用root實(shí)例作為參數(shù)

#傳入Manager類(lèi)定義了Logger.manager屬性，

#此處使用manager實(shí)例所有的getLogger方法

#來(lái)具體實(shí)現(xiàn)模塊級(jí)的getLogger方法

return Logger.manager.getLogger(name)

else:

return root

小結(jié)：

Logger.manager屬性是Manager(root)的實(shí)例，而logging.getLogger其實(shí)就是由Logger.manager對(duì)象調(diào)用它的getLogger方法。

再轉(zhuǎn)到Manager類(lèi)的定義中，來(lái)分析Manager(Logger.root)創(chuàng)建manager實(shí)例對(duì)象和用logger.getLogger時(shí)具體發(fā)生了什么：

class Manager(object):

"""

holds the hierarchy of loggers.

"""

#Logger.manager = Manager(Logger.root)發(fā)生的事情

def __init__(self, rootnode):

"""

Initialize the manager with the root node of the logger hierarchy.

"""

#結(jié)合上文Logger.manager = Manager(Logger.root)

#可見(jiàn)我們使用root logger作為rootnode，并把它賦予

#Manager類(lèi)的self.root屬性

self.root = rootnode

self.disable = 0

self.emittedNoHandlerWarning = False

#self.loggerDict維護(hù)logger hierarchy中的loggers

self.loggerDict = {}

self.loggerClass = None

self.logRecordFactory = None

#使用logging.getLogger時(shí)發(fā)生的事情，Logger.manager屬性

#也就是使用root logger作為參數(shù)的Manager實(shí)例調(diào)用該實(shí)例

#所屬M(fèi)anager類(lèi)的getLogger方法

def getLogger(self, name):

#這里創(chuàng)建一個(gè)值為None的rv

rv = None

#不用理會(huì)，只是判斷name值是否為str

if not isinstance(name, str):

raise TypeError('A logger name must be a string')

_acquireLock()

try:

#這里由于是使用Logger.manager實(shí)例來(lái)調(diào)用

#getLogger方法，而Logger.manager實(shí)例的

#self.loggerDict初始值為空，所以在第一

#次使用getLogger方法時(shí)，這個(gè)判斷不通過(guò)

#就算之后再次調(diào)用logging.getLogger(name)

#也要看name是否在loggerDict中

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)

#所以直接轉(zhuǎn)到此處

else:

#這里self.loggerClass初始為空，使用

#_loggerClass其實(shí)就是Logger類(lèi)實(shí)例化

#一個(gè)logger對(duì)象附于rv

rv = (self.loggerClass or _loggerClass)(name)

#這里再把self也就是Logger.manager賦予

#rv.manager，并未創(chuàng)建新的Manager實(shí)例

rv.manager = self

#把rv加入loggerDict中，name:rv鍵值對(duì)

self.loggerDict[name] = rv

#設(shè)定當(dāng)前l(fā)ogger實(shí)例的parent

self._fixupParents(rv)

finally:

_releaseLock()

#返回rv，也就是創(chuàng)建的logger實(shí)例對(duì)象

return rv

大概介紹了Manager的部分源碼，我們回到最初的問(wèn)題，為何我們自己創(chuàng)建的logger實(shí)例能沿用root logger的basicConfig設(shè)定，再看logger.info方法的源碼：

#logger實(shí)例的info方法

def info(self, msg, *args, **kwargs):

#對(duì)比INFO日志級(jí)別和當(dāng)前l(fā)ogger實(shí)例的日志級(jí)別來(lái)決定是否進(jìn)行l(wèi)og

if self.isEnabledFor(INFO):

#所以這里其實(shí)是調(diào)用了logger實(shí)例的底層_log方法

self._log(INFO, msg, args, **kwargs)

def _log(self, level, msg, args, exc_info=None, extra=None, stack_info=False):

"""

Low-level logging routine which

creates a LogRecord and then calls

all the handlers of this logger to

handle the record.

"""

#為避免繁瑣，把一些簡(jiǎn)單使用時(shí)不會(huì)碰到的代碼略過(guò)

...

#生成log record

record = self.makeRecord(self.name, level, fn, lno, msg, args,

exc_info, func, extra, sinfo)

#調(diào)用當(dāng)前l(fā)ogger實(shí)例的handle方法來(lái)處理log record

self.handle(record)

def handle(self, record):

if (not self.disabled) and self.filter(record):

#可見(jiàn)logger類(lèi)的handle方法又調(diào)用了該類(lèi)的

#callHandlers方法來(lái)處理record

self.callHandlers(record)

#注意看源碼中自帶注釋對(duì)于callHandlers方法解釋，其中

#很重要的一點(diǎn)就是，該函數(shù)會(huì)loop through該logger乃至

#該logger的parent，parent的parent一直到root logger

#中的handlers，注意我們?cè)谇拔闹姓f(shuō)了，basicConfig其實(shí)

#就是對(duì)root logger的handlers進(jìn)行設(shè)置

def callHandlers(self, record):

"""

Pass a record to all relevant handlers.

Loop through all handlers for this logger

and its parents in the logger hierarchy.

If no handler was found, output a one-off error

message to sys.stderr. Stop searching up

the hierarchy whenever a logger with the

"propagate" attribute set to zero is found - that

will be the last logger whose handlers are called.

"""

#把當(dāng)前l(fā)ogger實(shí)例賦予c

c = self

found = 0

#這個(gè)while一定可以進(jìn)去，因?yàn)閏是一個(gè)logger對(duì)象，不為None

while c:

#對(duì)于我們創(chuàng)建的logger，它的handlers初始值是空列表

#所以這個(gè)for一開(kāi)始進(jìn)不去，對(duì)于我們的簡(jiǎn)單使用場(chǎng)景

#使用了logging.basicConfig(...)，然后創(chuàng)建自己的

#logger=logging.getLogger("mylogger")，當(dāng)前

#logger的parent肯定是root logger，而前面的

#basicConfig對(duì)root logger的handlers設(shè)置了，

#所以root logger的handlers不為空，可以進(jìn)入

for hdlr in c.handlers:

found = found + 1

if record.levelno >= hdlr.level:

#使用handlers中的handler對(duì)

#log record進(jìn)行handle處理

hdlr.handle(record)

#這個(gè)也進(jìn)不去，logger實(shí)例的propagate都是默認(rèn)True

if not c.propagate:

c = None #break out

#只能進(jìn)這里了

else:

#把當(dāng)前l(fā)ogger實(shí)例的parent賦予c

#然后繼續(xù)循環(huán)，如果handlers仍然為空

#則繼續(xù)把parent賦予c直到root logger

c = c.parent

...

簡(jiǎn)而言之，我們自己創(chuàng)建的logger能使用parent(Manager實(shí)例所維持的一個(gè)hierarchy)的handlers對(duì)log信息進(jìn)行handle，而向上追溯的祖先就是root logger，我們已經(jīng)通過(guò)basicConfig的話，實(shí)質(zhì)上就是對(duì)它的handlers進(jìn)行了設(shè)置，所以在這個(gè)hierarchy中的后代便能享用。

總結(jié)

以上是生活随笔為你收集整理的python logging模块的作用及应用场景_Python常用模块功能简介（三）logging的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。