Skip to content

log

Class info

🛈 DocStrings

Logging configuration for pyt3client.

get_logger

get_logger(name: str, log_level: LogLevel | None = None) -> Logger

Get a logger for the given name.

Parameters:

Name Type Description Default
name str

The name of the logger. Will be prefixed with 'pyt3client'

required
log_level LogLevel | None

The logging level to set for the logger

None

Returns:

Type Description
Logger

A logger instance

Source code in src/pyt3client/log.py
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def get_logger(name: str, log_level: LogLevel | None = None) -> logging.Logger:
    """Get a logger for the given name.

    Args:
        name: The name of the logger.
              Will be prefixed with 'pyt3client'
        log_level: The logging level to set for the logger

    Returns:
        A logger instance
    """
    logger = logging.getLogger(f"pyt3client.{name}")
    if log_level is not None:
        logger.setLevel(log_level)
    return logger