record.log.logger module

A module for log utilities.

It provides consistent log level and format, and always write to logger_name.log file. The project should use this instead of standard logging module.

Differences with logging.getLogger:

1. Multiple level logger is not supported.

2. Exception backtracing stack is fixed.

According to https://stackoverflow.com/questions/47968861/does-python-logging-support-multiprocessing, logging within pipe_size, which is usually 4096 btyes, is atomic. It is big enough for most of the situation, except for backtracing. Have to restrict backtrace level.

class record.log.logger.Logger(name, level=0)

基类：Logger

add_default_handler(name: str, *paths: str, format: str = '') → None

findCaller(stack_info: bool = False, stacklevel: int = 1)

Find the stack frame of the caller so that we can note the source file name, line number and function name.

static format_request(request: HttpRequest) → str

classmethod getLogger(name: str, setup: bool = True)

listener(message: str = '', *, as_view: bool = False, raise_exc: bool | None = None) → Callable[[Exception, Callable, tuple[Any, ...], dict[str, Any]], None]

makeRecord(*args, **kwargs)

A factory method which can be overridden in subclasses to create specialized LogRecords.

on_exception(message: str = '', *, request: HttpRequest | None = None, raise_exc: bool | None = None) → None

Log exception and raise it if needed.

参数:

• message (str, optional) -- 基础日志信息. Defaults to ''.

• request (HttpRequest, optional) -- 记录请求信息. Defaults to None.

• raise_exc (bool, optional) -- 是否抛出异常，不提供则根据debug模式决定

secure_func(message: str = '', *, raise_exc: bool | None = False, fail_value: ~typing.Any | ~typing.Callable[[], ~typing.Any] = None, exc_type: type[Exception] | tuple[type[Exception], ...] = <class 'Exception'>) → Callable[[Callable[[P], T]], Callable[[P], T]]

secure_view(message: str = '', *, raise_exc: bool | None = None, fail_value: ~typing.Any | ~typing.Callable[[], ~typing.Any] = None, exc_type: type[Exception] | tuple[type[Exception], ...] = <class 'Exception'>) → Callable[[Callable[[Concatenate[R, P]], T]], Callable[[Concatenate[R, P]], T]]

setLevel(level: int | str | None = None) → None

Set the logging level of this logger. level must be an int or a str.

set_debug_mode(debug: bool) → None

setup(name: str, handle: bool = True) → None