PyDev單元測試：如何捕獲記錄到「捕獲的輸出」中的logging.Logger的文本

Question

我正在使用PyDev進行Python應用程序的開發和單元測試。 至於單元測試，一切工作都代表了內容記錄到任何日誌記錄的事實。記錄器不被PyDev的「捕獲輸出」捕獲。

我已經着一切記錄到這樣的標準輸出：

import sys 
logger = logging.getLogger() 
logger.level = logging.DEBUG 
logger.addHandler(logging.StreamHandler(sys.stdout)) 

儘管如此，「捕獲輸出」不顯示的東西記錄到記錄器。

這裏的示例單元測試腳本：test.py

import sys 
import unittest 
import logging 

logger = logging.getLogger() 
logger.level = logging.DEBUG 
logger.addHandler(logging.StreamHandler(sys.stdout)) 

class TestCase(unittest.TestCase): 
    def testSimpleMsg(self): 
     print("AA") 
     logging.getLogger().info("BB") 

控制檯輸出是：

Finding files... done. 
Importing test modules ... done. 

testSimpleMsg (itf.lowlevel.tests.hl7.TestCase) ... AA 
2011-09-19 16:48:00,755 - root - INFO - BB 
BB 
ok 

---------------------------------------------------------------------- 
Ran 1 test in 0.001s 

OK 

但是CAPTURED OUTPUT用於測試的是：

======================== CAPTURED OUTPUT ========================= 
AA 

有沒有人知道如何在執行這個測試期間捕獲所有記錄到logging.Logger？

Answer 1

的問題是，unittest亞軍取代sys.stdout/sys.stderr測試開始之前，以及StreamHandler還在寫原來的sys.stdout。

如果您將'當前'sys.stdout分配給處理程序，它應該可以工作（請參閱下面的代碼）。

import sys 
import unittest 
import logging 

logger = logging.getLogger() 
logger.level = logging.DEBUG 
stream_handler = logging.StreamHandler(sys.stdout) 
logger.addHandler(stream_handler) 

class TestCase(unittest.TestCase): 
    def testSimpleMsg(self): 
     stream_handler.stream = sys.stdout 
     print("AA") 
     logging.getLogger().info("BB") 

雖然，一個更好的辦法是添加/測試期間移除處理程序：

import sys 
import unittest 
import logging 

logger = logging.getLogger() 
logger.level = logging.DEBUG 

class TestCase(unittest.TestCase): 
    def testSimpleMsg(self): 
     stream_handler = logging.StreamHandler(sys.stdout) 
     logger.addHandler(stream_handler) 
     try: 
      print("AA") 
      logging.getLogger().info("BB") 
     finally: 
      logger.removeHandler(stream_handler) 

Answer 2

我從小厭倦了手動添加Fabio's great code所有setUp S的，所以我子類unittest.TestCase與一些__metaclass__ ing：

class LoggedTestCase(unittest.TestCase): 
    __metaclass__ = LogThisTestCase 
    logger = logging.getLogger("unittestLogger") 
    logger.setLevel(logging.DEBUG) # or whatever you prefer 

class LogThisTestCase(type): 
    def __new__(cls, name, bases, dct): 
     # if the TestCase already provides setUp, wrap it 
     if 'setUp' in dct: 
      setUp = dct['setUp'] 
     else: 
      setUp = lambda self: None 
      print "creating setUp..." 

     def wrappedSetUp(self): 
      # for hdlr in self.logger.handlers: 
      # self.logger.removeHandler(hdlr) 
      self.hdlr = logging.StreamHandler(sys.stdout) 
      self.logger.addHandler(self.hdlr) 
      setUp(self) 
     dct['setUp'] = wrappedSetUp 

     # same for tearDown 
     if 'tearDown' in dct: 
      tearDown = dct['tearDown'] 
     else: 
      tearDown = lambda self: None 

     def wrappedTearDown(self): 
      tearDown(self) 
      self.logger.removeHandler(self.hdlr) 
     dct['tearDown'] = wrappedTearDown 

     # return the class instance with the replaced setUp/tearDown 
     return type.__new__(cls, name, bases, dct) 

Now您的測試用例可以簡單地繼承LoggedTestCase，即class TestCase(LoggedTestCase)而不是class TestCase(unittest.TestCase)，您就完成了。或者，您可以添加__metaclass__行，並在測試中定義logger或者稍微修改LogThisTestCase。

Answer 3

我建議使用一個LogCapture和測試，你真的是記錄你所期望的要記錄：

http://testfixtures.readthedocs.org/en/latest/logging.html

Answer 4

我碰到這個問題也來了。我結束了StreamHandler的子類化，並使用一個獲取sys.stdout的屬性覆蓋了stream屬性。這樣，處理程序將使用unittest.TestCase已交換到sys的流。標準輸出：

class CapturableHandler(logging.StreamHandler): 

    @property 
    def stream(self): 
     return sys.stdout 

    @stream.setter 
    def stream(self, value): 
     pass 

然後，您可以設置運行測試，像這樣前的日誌處理程序（這將定製的處理程序添加到根logger）：

def setup_capturable_logging(): 
    if not logging.getLogger().handlers: 
     logging.getLogger().addHandler(CapturableHandler()) 

如果像我一樣，你有你的測試在單獨的模塊，你可以把每個單元測試模塊的進口，這將確保日誌記錄設置後線測試運行之前：

import logutil 

logutil.setup_capturable_logging() 

這可能不是最乾淨的APPR噢，但它非常簡單，對我來說效果很好。