sportslabkit.logger

Customizable logger based on loguru.

Overview

Classes

LoggerMixin	-
LevelFilter	-

Function

is_interactive()	True if running in a interactive environment/jupyter notebook.
patcher(record)	Customize loguru’s log format.
set_log_level(level)	Set the logging level for the logger.
tqdm(*args, level, **kwargs)	Wrapper for tqdm.tqdm that uses the logger’s level.
inspect(*args, level, **kwargs)	Wrapper for rich.inspect that uses the logger’s level.
show_df(df, theme)	-

Attributes

LOG_LEVEL	-
level_filter	-
config	-

Classes

class sportslabkit.logger.LoggerMixin

class sportslabkit.logger.LevelFilter(level: str = 'INFO')

Functions

sportslabkit.logger.is_interactive() → bool

True if running in a interactive environment/jupyter notebook.

Returns:

True if running in an interactive environment

Return type:

bool

sportslabkit.logger.patcher(record: dict[str, str | dict[str, str]]) → dict[str, str | dict[str, str]]

Customize loguru’s log format.

See the Loguru docs for details on record here, https://loguru.readthedocs.io/en/stable/api/logger.html.

Parameters:

record (Dict) – Loguru record

Returns:

Loguru record

Return type:

Dict

sportslabkit.logger.set_log_level(level: str) → Any

Set the logging level for the logger.

Parameters:

level (str) – Logging level to set

sportslabkit.logger.tqdm(*args, level: str = 'INFO', **kwargs) → collections.abc.Iterable

Wrapper for tqdm.tqdm that uses the logger’s level.

Parameters:

• *args – Arguments to pass to tqdm.tqdm

• **kwargs – Keyword arguments to pass to tqdm.tqdm

• level (str, optional) – Logging level to set. Defaults to “INFO”.

Returns:

Iterable from tqdm progress bar

Return type:

Iterable

sportslabkit.logger.inspect(*args, level: str = 'INFO', **kwargs) → None

Wrapper for rich.inspect that uses the logger’s level.

Parameters:

• *args – Arguments to pass to rich.inspect

• **kwargs – Keyword arguments to pass to rich.inspect

• level (str, optional) – Logging level to set. Defaults to “INFO”.

sportslabkit.logger.show_df(df, theme='dark')

Attributes

sportslabkit.logger.LOG_LEVEL

sportslabkit.logger.level_filter

sportslabkit.logger.config