From 5d5bde1df2e92fcd545baeef4fb212462982e47e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Fri, 3 Jun 2011 17:28:23 +0200 Subject: Document autoflushing in packaging.test.support.LoggingCatcher.get_logs. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- Lib/packaging/tests/support.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Lib/packaging/tests/support.py b/Lib/packaging/tests/support.py index ae65a1d..501f126 100644 --- a/Lib/packaging/tests/support.py +++ b/Lib/packaging/tests/support.py @@ -65,7 +65,10 @@ class LoggingCatcher: configured to record all messages logged to the 'packaging' logger. 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): -- cgit v0.12