IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7327 from tk0miya/suppress_logging

Browse Source 
Add suppress_logging()
This commit is contained in:
Jakob Lykke Andersen 2020-03-17 18:33:37 +01:00 committed by GitHub
commit cb0f33eb8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
sphinx/util/logging.py
View File

@ -220,16 +220,15 @@ def pending_warnings() -> Generator[logging.Handler, None, None]:
@contextmanager @contextmanager
def pending_logging() -> Generator[MemoryHandler, None, None]: def suppress_logging() -> Generator[MemoryHandler, None, None]:
"""Contextmanager to pend logging all logs temporary. """Contextmanager to suppress logging all logs temporary.
For example:: For example::
>>> with pending_logging(): >>> with suppress_logging():
>>> logger.warning('Warning message!') # not flushed yet >>> logger.warning('Warning message!') # suppressed
>>> some_long_process() >>> some_long_process()
>>> >>>
Warning message! # the warning is flushed here
""" """
logger = logging.getLogger(NAMESPACE) logger = logging.getLogger(NAMESPACE)
memhandler = MemoryHandler() memhandler = MemoryHandler()
@ -248,6 +247,24 @@ def pending_logging() -> Generator[MemoryHandler, None, None]:
for handler in handlers: for handler in handlers:
logger.addHandler(handler) logger.addHandler(handler)
@contextmanager
def pending_logging() -> Generator[MemoryHandler, None, None]:
"""Contextmanager to pend logging all logs temporary.
For example::
>>> with pending_logging():
>>> logger.warning('Warning message!') # not flushed yet
>>> some_long_process()
>>>
Warning message! # the warning is flushed here
"""
logger = logging.getLogger(NAMESPACE)
try:
with suppress_logging() as memhandler:
yield memhandler
finally:
memhandler.flushTo(logger) memhandler.flushTo(logger)

14
tests/test_util_logging.py
View File

@ -233,6 +233,20 @@ def test_warning_location(app, status, warning):
assert colorize('red', 'WARNING: message7') in warning.getvalue() assert colorize('red', 'WARNING: message7') in warning.getvalue()
def test_suppress_logging(app, status, warning):
logging.setup(app, status, warning)
logger = logging.getLogger(__name__)
logger.warning('message1')
with logging.suppress_logging():
logger.warning('message2')
assert 'WARNING: message1' in warning.getvalue()
assert 'WARNING: message2' not in warning.getvalue()
assert 'WARNING: message1' in warning.getvalue()
assert 'WARNING: message2' not in warning.getvalue()
def test_pending_warnings(app, status, warning): def test_pending_warnings(app, status, warning):
logging.setup(app, status, warning) logging.setup(app, status, warning)
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)