通过

logging_utilities 模块

用于日志记录的实用工具模块。

函数

function_debug_log_wrapped

在转换器类函数周围添加日志包装器。

function_debug_log_wrapped(log_level: int = 10) -> Callable[[Callable[[...], Any]], Callable[[...], Any]]

参数

名称 说明
log_level
默认值: 10

get_logger

使用遥测挂钩创建记录器。

get_logger(namespace: str | None = None, filename: str | None = None, verbosity: int = 10, extra_handlers: List[Handler] | None = None, component_name: str | None = None) -> Logger

参数

名称 说明
namespace

记录器命名空间

默认值: None
filename

日志文件名称

默认值: None
verbosity

日志记录详细程度

默认值: 10
extra_handlers

要附加到记录器的任何额外处理程序

默认值: None
component_name

组件名称

默认值: None

返回

类型 说明

如果提供了日志文件名称和命名空间，则记录器为 null 记录器

is_exception_stacktrace_loggable 

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed 

is_non_automl_exception_allowed(exception: BaseException) -> bool

参数

名称 说明
exception
必需

is_path_allowed 

is_path_allowed(exception_path: str) -> bool

参数

名称 说明
exception_path
必需

is_stdlib_module

确定这是 Python 随附的模块。

is_stdlib_module(exception_path: str) -> bool

参数

名称 说明
exception_path
必需

log_activity

记录持续时间的活动状态。

log_activity(logger: Logger, activity_name: str, activity_type: str | None = None, custom_dimensions: Dict[str, Any] | None = None) -> Iterator[Any | None]

参数

名称 说明
logger
必需

记录器
activity_name
必需

活动名称
activity_type
必需

活动类型
custom_dimensions
必需

自定义维度

log_system_info

记录 CPU、内存和 OS 信息。

log_system_info(logger: Logger, prefix_message: str = '') -> None

参数

名称 说明
logger
必需

记录器对象
prefix_message
必需

日志中前缀中的字符串

返回

类型 说明

没有

log_traceback

记录异常跟踪。

log_traceback(exception: BaseException, logger: Logger | LoggerAdapter | None, override_error_msg: str | None = None, is_critical: bool | None = True, tb: Any | None = None) -> None

参数

名称 说明
exception
必需

要记录的异常。
logger
必需

要使用的记录器。
override_error_msg

要显示的消息将覆盖当前error_msg。

默认值: None
is_critical

如果is_critical，记录器将使用 log.critical，否则为 log.error。

默认值: True
tb

要用于日志记录的跟踪;如果未提供，则使用附加到异常的异常。

默认值: None

mark_package_exceptions_as_loggable 

mark_package_exceptions_as_loggable(module: module) -> None

参数

名称 说明
module
必需

mark_path_as_loggable 

mark_path_as_loggable(path: str) -> None

参数

名称 说明
path
必需

mark_path_as_not_loggable 

mark_path_as_not_loggable(path: str) -> None

参数

名称 说明
path
必需

remove_blacklisted_logging_keys_from_dict

以递归方式从听写中删除键。

remove_blacklisted_logging_keys_from_dict(dict_obj: Dict[str, Any]) -> None

参数

名称 说明
dict_obj
必需

remove_blacklisted_logging_keys_from_json_str

以递归方式从 json str 中删除密钥并返回 json str。

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

参数

名称 说明
json_str
必需