Salta para o conteúdo

Referência para hub_sdk/helpers/logger.py

Nota

Este ficheiro está disponível em https://github.com/ultralytics/ hub-sdk/blob/main/ hub_sdk/helpers/logger .py. Se detectares um problema, por favor ajuda a corrigi-lo contribuindo com um Pull Request 🛠️. Obrigado 🙏!



hub_sdk.helpers.logger.Logger

Representa uma configuração de registo para tratar mensagens de registo.

Atributos:

Nome Tipo Descrição
logger_name str

Nome do registador. Usa por defeito o nome do módulo de chamada.

log_format str

Formato das mensagens de registo. Usa como padrão o valor da variável de ambiente 'LOGGER_FORMAT' ou '%(asctime)s - %(name)s - %(levelname)s - %(message)s'.

log_level str

Nível de registo para o registador. Usa como padrão o valor da variável de ambiente 'LOGGER_LEVEL' ou 'INFO'. ou 'INFO'.

logger Logger

A instância do registador configurada.

Código fonte em hub_sdk/helpers/logger.py
class Logger:
    """
    Represents a logger configuration for handling log messages.

    Attributes:
        logger_name (str): Name of the logger. Defaults to the name of the calling module.
        log_format (str): Format for log messages. Defaults to the value of 'LOGGER_FORMAT'
                         environment variable or '%(asctime)s - %(name)s - %(levelname)s - %(message)s'.
        log_level (str): Log level for the logger. Defaults to the value of 'LOGGER_LEVEL'
                        environment variable or 'INFO'.
        logger (logging.Logger): The configured logger instance.
    """

    def __init__(self, logger_name=None, log_format=None, log_level=None):
        """
        Initialize a Logger instance.

        Args:
            logger_name (str): Name of the logger. If not provided, defaults to the root logger.
            log_format (str): Format for log messages. Defaults to the value of 'LOGGER_FORMAT'
                             environment variable or '%(asctime)s - %(levelname)s - %(message)s'.
            log_level (str): Log level for the logger. Defaults to the value of 'LOGGER_LEVEL'
                            environment variable or 'INFO'.
        """
        self.log_format = log_format or os.environ.get(
            "LOGGER_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        )
        self.log_level = log_level or os.environ.get("LOGGER_LEVEL", "INFO")
        self.logger_name = logger_name or __name__

        self.logger = self._configure_logger()

    def _configure_logger(self) -> logging.Logger:
        """
        Configure the logger with the provided settings.

        Returns:
            (logging.Logger): A configured logger instance.
        """
        logger = logging.getLogger(self.logger_name)
        logger.setLevel(self.log_level)

        formatter = logging.Formatter(self.log_format)

        handler = logging.StreamHandler()
        handler.setFormatter(formatter)

        logger.addHandler(handler)
        return logger

    def get_logger(self) -> logging.Logger:
        """
        Get the configured logger instance.

        Returns:
            (logging.Logger): The configured logger instance.
        """
        return self.logger

__init__(logger_name=None, log_format=None, log_level=None)

Inicializa uma instância do Logger.

Parâmetros:

Nome Tipo Descrição Predefinição
logger_name str

Nome do registador. Se não for fornecido, utiliza por defeito o registador de raiz.

None
log_format str

Formato das mensagens de registo. Usa como padrão o valor da variável de ambiente 'LOGGER_FORMAT' ou '%(asctime)s - %(levelname)s - %(message)s'.

None
log_level str

Nível de registo para o registador. Usa como padrão o valor da variável de ambiente 'LOGGER_LEVEL' ou 'INFO'. ou 'INFO'.

None
Código fonte em hub_sdk/helpers/logger.py
def __init__(self, logger_name=None, log_format=None, log_level=None):
    """
    Initialize a Logger instance.

    Args:
        logger_name (str): Name of the logger. If not provided, defaults to the root logger.
        log_format (str): Format for log messages. Defaults to the value of 'LOGGER_FORMAT'
                         environment variable or '%(asctime)s - %(levelname)s - %(message)s'.
        log_level (str): Log level for the logger. Defaults to the value of 'LOGGER_LEVEL'
                        environment variable or 'INFO'.
    """
    self.log_format = log_format or os.environ.get(
        "LOGGER_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    )
    self.log_level = log_level or os.environ.get("LOGGER_LEVEL", "INFO")
    self.logger_name = logger_name or __name__

    self.logger = self._configure_logger()

get_logger()

Obtém a instância do registador configurado.

Devolve:

Tipo Descrição
Logger

A instância do registador configurada.

Código fonte em hub_sdk/helpers/logger.py
def get_logger(self) -> logging.Logger:
    """
    Get the configured logger instance.

    Returns:
        (logging.Logger): The configured logger instance.
    """
    return self.logger