记录API

sphinx.util.logging.getLogger(name)

获取记录器包装 sphinx.util.logging.SphinxLoggerAdapter 。

Sphinx记录器总是使用 sphinx.* 命名空间独立于root logger的设置。即使第三方扩展或导入的应用程序重置记录器设置，它也可确保记录一致。

用法示例:

>>> from sphinx.util import logging
>>> logger = logging.getLogger(__name__)
>>> logger.info('Hello, this is an extension!')
Hello, this is an extension!

class sphinx.util.logging.SphinxLoggerAdapter(logging.LoggerAdapter)

LoggerAdapter允许 type 和 subtype 关键字。

error(msg, *args, **kwargs)

critical(msg, *args, **kwargs)

warning(msg, *args, **kwargs)

使用指定的级别在此记录器上记录消息。基本上，参数与python的日志记录模块一样。

此外，Sphinx记录器支持以下关键字参数:

type, *subtype*

警告日志的类别。它用于通过以下方式抑制警告 suppress_warnings 设置。

location

发生警告的地方。它用于包括每个日志中的路径和行号。它允许docname，docname和行号和节点的元组:

logger = sphinx.util.logging.getLogger(__name__)
logger.warning('Warning happened!', location='index')
logger.warning('Warning happened!', location=('chapter1/index', 10))
logger.warning('Warning happened!', location=some_node)

color

日志的颜色。默认情况下，错误级别日志的颜色为“黑色”，“关键级别”没有着色，警告级别日志的颜色为“红色”“红色”。

log(level, msg, *args, **kwargs)

info(msg, *args, **kwargs)

verbose(msg, *args, **kwargs)

debug(msg, *args, **kwargs)

使用指定的级别将消息记录到此记录器。基本上，参数与python的日志记录模块一样。

此外，Sphinx记录器支持以下关键字参数:

nonl

如果为true，则记录器不会在日志消息的末尾折叠行。默认为 False 。

location

发出消息的地方。有关更多详细信息，请参阅 SphinxLoggerAdapter.warning() 。

color

日志的颜色。默认情况下，信息和详细级别日志不会着色，调试级别日志会显示为 "darkgray" 。

sphinx.util.logging.pending_logging()

Contextmanager挂起临时记录所有日志。

例如:

>>> with pending_logging():
>>>     logger.warning('Warning message!')  # not flushed yet
>>>     some_long_process()
>>>
Warning message!  # the warning is flushed here

sphinx.util.logging.pending_warnings()

Contextmanager暂时挂起日志记录警告。

类似于 pending_logging() 。

sphinx.util.logging.prefixed_warnings()

将前缀添加到所有记录一段时间。

例如:

>>> with prefixed_warnings("prefix:"):
>>>     logger.warning('Warning message!')  # => prefix: Warning message!

2.0 新版功能.