Overslaan naar inhoud

Referentie voor hub_sdk/helpers/logger.py

Opmerking

Dit bestand is beschikbaar op https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/helpers/logger .py. Als je een probleem ziet, help het dan oplossen door een Pull Request 🛠️ bij te dragen. Bedankt 🙏!



hub_sdk.helpers.logger.Logger

Vertegenwoordigt een logboekconfiguratie voor het afhandelen van logboekberichten.

Kenmerken:

Naam Type Beschrijving
logger_name str

Naam van de logger. Standaard de naam van de aanroepende module.

log_format str

Formaat voor logberichten. Wordt standaard ingesteld op de waarde van 'LOGGER_FORMAT' omgevingsvariabele of '%(asctime)s - %(name)s - %(levelname)s - %(message)s'.

log_level str

Logniveau voor de logger. Wordt standaard ingesteld op de waarde van de 'LOGGER_LEVEL' omgevingsvariabele of 'INFO'.

logger Logger

De geconfigureerde loggerinstantie.

Broncode in 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)

Initialiseer een Logger instantie.

Parameters:

Naam Type Beschrijving Standaard
logger_name str

Naam van de logger. Als deze niet wordt opgegeven, wordt standaard de rootlogger gebruikt.

None
log_format str

Formaat voor logberichten. Standaard de waarde van de omgevingsvariabele 'LOGGER_FORMAT' of '%(asctime)s - %(levelname)s - %(message)s'. omgevingsvariabele of '%(asctime)s - %(levelname)s - %(message)s'.

None
log_level str

Logniveau voor de logger. Wordt standaard ingesteld op de waarde van de 'LOGGER_LEVEL' omgevingsvariabele of 'INFO'.

None
Broncode in 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()

Verkrijg de geconfigureerde loggerinstantie.

Retourneert:

Type Beschrijving
Logger

De geconfigureerde loggerinstantie.

Broncode in 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