sphinx.util.logging

module documentation
(source)

Logging utility functions for Sphinx.

Class ColorizeFormatter Undocumented
Class DisableWarningIsErrorFilter Disable WarningIsErrorFilter if this filter installed.
Class InfoFilter Filter error and warning messages.
Class InfoLogRecordTranslator LogRecordTranslator for INFO level log records.
Class LastMessagesWriter Stream writer storing last 10 messages in memory to save trackback
Class LogCollector Undocumented
Class MemoryHandler Handler buffering all logs.
Class MessagePrefixFilter Prepend prefix to all log records.
Class NewLineStreamHandler StreamHandler which switches line terminator by record.nonl flag.
Class OnceFilter Show the message only once.
Class SafeEncodingWriter Stream writer which ignores UnicodeEncodeError silently
Class SphinxInfoLogRecord Info log record class supporting location
Class SphinxLoggerAdapter LoggerAdapter allowing ``type`` and ``subtype`` keywords.
Class SphinxLogRecord Log record class supporting location
Class SphinxLogRecordTranslator Converts a log record to one Sphinx expects
Class SphinxWarningLogRecord Warning log record class supporting location
Class WarningIsErrorFilter Raise exception if warning emitted.
Class WarningLogRecordTranslator LogRecordTranslator for WARNING level log records.
Class WarningStreamHandler StreamHandler for warnings.
Class WarningSuppressor Filter logs by `suppress_warnings`.
Function convert_serializable Convert LogRecord serializable.
Function get_node_location Undocumented
Function getLogger Get logger wrapped by :class:`sphinx.util.logging.SphinxLoggerAdapter`.
Function is_suppressed_warning Check whether the warning is suppressed or not.
Function pending_logging Context manager to postpone logging all logs temporarily.
Function pending_warnings Context manager to postpone logging warnings temporarily.
Function prefixed_warnings Context manager to prepend prefix to all warning log records temporarily.
Function setup Setup root logger for Sphinx
Function skip_warningiserror Context manager to skip WarningIsErrorFilter temporarily.
Function suppress_logging Context manager to suppress logging all logs temporarily.
Constant COLOR_MAP Undocumented
Constant LEVEL_NAMES Undocumented
Constant NAMESPACE Undocumented
Constant VERBOSE Undocumented
Constant VERBOSITY_MAP Undocumented
def convert_serializable(records): (source)

Convert LogRecord serializable.

Parameters
records:list[logging.LogRecord]Undocumented
def get_node_location(node): (source)

Undocumented

Parameters
node:NodeUndocumented
Returns
str|NoneUndocumented
def getLogger(name): (source)

Get logger wrapped by :class:`sphinx.util.logging.SphinxLoggerAdapter`. Sphinx logger always uses ``sphinx.*`` namespace to be independent from settings of root logger. It ensures logging is consistent even if a third-party extension or imported application resets logger settings. Example usage:: >>> from sphinx.util import logging >>> logger = logging.getLogger(__name__) >>> logger.info('Hello, this is an extension!') Hello, this is an extension!

Parameters
name:strUndocumented
Returns
SphinxLoggerAdapterUndocumented
def is_suppressed_warning(type, subtype, suppress_warnings): (source)

Check whether the warning is suppressed or not.

Parameters
type:strUndocumented
subtype:strUndocumented
suppress_warnings:list[str]Undocumented
Returns
boolUndocumented
@contextmanager
def pending_logging(): (source)

Context manager to postpone logging all logs temporarily. For example:: >>> with pending_logging(): >>> logger.warning('Warning message!') # not flushed yet >>> some_long_process() >>> Warning message! # the warning is flushed here

Returns
Generator[MemoryHandler, None, None]Undocumented
@contextmanager
def pending_warnings(): (source)

Context manager to postpone logging warnings temporarily. Similar to :func:`pending_logging`.

Returns
Generator[logging.Handler, None, None]Undocumented
@contextmanager
def prefixed_warnings(prefix): (source)

Context manager to prepend prefix to all warning log records temporarily. For example:: >>> with prefixed_warnings("prefix:"): >>> logger.warning('Warning message!') # => prefix: Warning message! .. versionadded:: 2.0

Parameters
prefix:strUndocumented
Returns
Generator[None, None, None]Undocumented
def setup(app, status, warning): (source)

Setup root logger for Sphinx

Parameters
app:SphinxUndocumented
status:IOUndocumented
warning:IOUndocumented
@contextmanager
def skip_warningiserror(skip=True): (source)

Context manager to skip WarningIsErrorFilter temporarily.

Parameters
skip:boolUndocumented
Returns
Generator[None, None, None]Undocumented
@contextmanager
def suppress_logging(): (source)

Context manager to suppress logging all logs temporarily. For example:: >>> with suppress_logging(): >>> logger.warning('Warning message!') # suppressed >>> some_long_process() >>>

Returns
Generator[MemoryHandler, None, None]Undocumented
COLOR_MAP = (source)

Undocumented

Value
defaultdict((lambda : 'blue'),
            {logging.ERROR: 'darkred',
             logging.WARNING: 'red',
             logging.DEBUG: 'darkgray'})
LEVEL_NAMES: dict[str, int] = (source)

Undocumented

Value
defaultdict((lambda : logging.WARNING))
NAMESPACE: str = (source)

Undocumented

Value
'sphinx'
VERBOSE: int = (source)

Undocumented

Value
15
VERBOSITY_MAP: dict[int, int] = (source)

Undocumented

Value
defaultdict((lambda : 0))