mirror of
https://github.com/python/cpython.git
synced 2025-09-26 18:29:57 +00:00
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:
parent
765e94f80c
commit
5d5bde1df2
1 changed files with 4 additions and 1 deletions
|
@ -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):
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue