logot.logged

Log pattern matching API.

See also

See Log pattern matching usage guide.

API reference

logot.logged.log(level: str | int, msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at the given level with the given msg.

Parameters:

• level – A log level name (e.g. "DEBUG") or numeric level (e.g. logging.DEBUG).

• msg – A log message pattern.

• matchers – Additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.

logot.logged.debug(msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at DEBUG level with the given msg.

Parameters:

• msg – A log message pattern.

• matchers – Optional additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.

logot.logged.info(msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at INFO level with the given msg.

Parameters:

• msg – A log message pattern.

• matchers – Optional additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.

logot.logged.warning(msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at WARNING level with the given msg.

Parameters:

• msg – A log message pattern.

• matchers – Optional additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.

logot.logged.error(msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at ERROR level with the given msg.

Parameters:

• msg – A log message pattern.

• matchers – Optional additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.

logot.logged.critical(msg: str, *matchers: Matcher, exc_info: bool | BaseException | None = ..., name: str | None = ...) → Logged

Creates a log pattern representing a log record at CRITICAL level with the given msg.

Parameters:

• msg – A log message pattern.

• matchers – Optional additional custom logot.Matcher instances.

• exc_info – An optional exception to match. If True, matches any exception. If False or None, matches no exception.

• name – An optional logger name.