Document autoflushing in packaging.test.support.LoggingCatcher.get_logs.

I’m afraid my docstring is not as clear as it should be, but I can’t
find a concise way of describing what the code does.  Suggestions for
improvements welcome.
This commit is contained in:
Éric Araujo 2011-06-03 17:28:23 +02:00
parent 765e94f80c
commit 5d5bde1df2

View file

@ -65,7 +65,10 @@ class LoggingCatcher:
configured to record all messages logged to the 'packaging' logger. configured to record all messages logged to the 'packaging' logger.
Use get_logs to retrieve messages and self.loghandler.flush to discard Use get_logs to retrieve messages and self.loghandler.flush to discard
them. them. get_logs automatically flushes the logs; if you test code that
generates logging messages but don't use get_logs, you have to flush
manually before doing other checks on logging message, otherwise you
will get irrelevant results. See example in test_command_check.
""" """
def setUp(self): def setUp(self):