AstropyLogger#

class astropy.logger.AstropyLogger(name, level=0)[源代码]#

基类:Logger

这个类用于设置Astropy日志记录。

此类在内置的基础上添加的主要功能日志记录。记录器类是跟踪消息来源的能力,启用日志记录的能力警告。警告调用和异常,以及添加彩色输出和上下文管理器,以便轻松地将消息捕获到文件或列表中。

使用名称和可选级别初始化记录器。

方法总结

disable_color \()

禁用彩色输出。

disable_exception_logging \()

禁用异常记录。

disable_warnings_logging \()

禁用warnings.warn()调用的日志记录。

enable_color \()

启用彩色输出。

enable_exception_logging \()

启用异常记录。

enable_warnings_logging \()

启用warnings.warn()调用的日志记录。

exception_logging_enabled \()

确定是否启用异常日志记录机制。

log_to_file(filename[, filter_level, ...])

上下文管理器将消息临时记录到文件中。

log_to_list([filter_level, filter_origin])

上下文管理器将消息临时记录到列表中。

makeRecord(name, level, pathname, lineno, ...)

可以在子类中重写以创建专用日志记录的工厂方法。

warnings_logging_enabled \()

方法文件

disable_color()[源代码]#

禁用彩色输出。

disable_exception_logging()[源代码]#

禁用异常记录。

调用后,此记录器将不再发出任何未捕获的异常。

这可以用重新启用 enable_exception_logging .

disable_warnings_logging()[源代码]#

禁用warnings.warn()调用的日志记录。

调用后,任何后续调用 warnings.warn() 不再重定向到此记录器。

这可以用重新启用 enable_warnings_logging .

enable_color()[源代码]#

启用彩色输出。

enable_exception_logging()[源代码]#

启用异常记录。

一旦调用,任何未捕获的异常都将以level发出 ERROR 在被提升之前。

这可以用禁用 disable_exception_logging .

enable_warnings_logging()[源代码]#

启用warnings.warn()调用的日志记录。

调用后,任何后续调用 warnings.warn() 重定向到此记录器并使用级别 WARN . 请注意,这将替换 warnings.warn .

这可以用禁用 disable_warnings_logging .

exception_logging_enabled()[源代码]#

确定是否启用异常日志记录机制。

返回:
exclog : bool布尔

如果启用异常日志记录,则为True;如果未启用,则为False。

log_to_file(filename, filter_level=None, filter_origin=None)[源代码]#

上下文管理器将消息临时记录到文件中。

参数:
filename : strPython :字符串

要将消息记录到的文件。

filter_level : strPython :字符串

如果设置,则任何日志消息的重要性低于 filter_level 不会输出到文件。请注意,这是对记录器的顶级过滤的补充,因此如果记录器具有级别“INFO”,则设置 filter_levelINFODEBUG 将不起作用,因为这些消息已被过滤掉。

filter_origin : strPython :字符串

如果已设置,则只记录以开头的源的消息 filter_origin 将被输出到文件。

笔记

默认情况下,记录器已经将日志消息输出到Astropy配置文件中的文件集。使用此上下文管理器不会阻止日志消息输出到该文件,也不会阻止日志消息打印到标准输出。

实例

上下文管理器用作:

with logger.log_to_file('myfile.log'):
    # your code here
log_to_list(filter_level=None, filter_origin=None)[源代码]#

上下文管理器将消息临时记录到列表中。

参数:
filename : strPython :字符串

要将消息记录到的文件。

filter_level : strPython :字符串

如果设置,则任何日志消息的重要性低于 filter_level 不会输出到文件。请注意,这是对记录器的顶级过滤的补充,因此如果记录器具有级别“INFO”,则设置 filter_levelINFODEBUG 将不起作用,因为这些消息已被过滤掉。

filter_origin : strPython :字符串

如果已设置,则只记录以开头的源的消息 filter_origin 将被输出到文件。

笔记

使用此上下文管理器不会阻止日志消息输出到标准输出。

实例

上下文管理器用作:

with logger.log_to_list() as log_list:
    # your code here
makeRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, extra=None, sinfo=None)[源代码]#

可以在子类中重写以创建专用日志记录的工厂方法。

warnings_logging_enabled()[源代码]#