Bỏ để qua phần nội dung

Tài liệu tham khảo cho hub_sdk/helpers/logger.py

Ghi

Tệp này có sẵn tại https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/helpers/logger.py. Nếu bạn phát hiện ra một vấn đề, vui lòng giúp khắc phục nó bằng cách đóng góp Yêu cầu 🛠️ kéo. Cảm ơn bạn 🙏 !



hub_sdk.helpers.logger.Logger

Đại diện cho cấu hình logger để xử lý thông báo nhật ký.

Thuộc tính:

Tên Kiểu Sự miêu tả
logger_name str

Tên của người khai thác gỗ. Mặc định là tên của mô-đun gọi.

log_format str

Định dạng cho thông báo nhật ký. Mặc định giá trị của 'LOGGER_FORMAT' biến môi trường hoặc '%(asctime)s - %(name)s - %(levelname)s - %(message)s'.

log_level str

Mức nhật ký cho logger. Mặc định giá trị của 'LOGGER_LEVEL' biến môi trường hoặc 'THÔNG TIN'.

logger Logger

Phiên bản ghi nhật ký đã cấu hình.

Mã nguồn trong 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)

Khởi tạo phiên bản Logger.

Thông số:

Tên Kiểu Sự miêu tả Mặc định
logger_name str

Tên của người khai thác gỗ. Nếu không được cung cấp, mặc định cho root logger.

None
log_format str

Định dạng cho thông báo nhật ký. Mặc định giá trị của 'LOGGER_FORMAT' biến môi trường hoặc '%(asctime)s - %(levelname)s - %(message)s'.

None
log_level str

Mức nhật ký cho logger. Mặc định giá trị của 'LOGGER_LEVEL' biến môi trường hoặc 'THÔNG TIN'.

None
Mã nguồn trong 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()

Tải phiên bản ghi nhật ký đã cấu hình.

Trở lại:

Kiểu Sự miêu tả
Logger

Phiên bản ghi nhật ký đã cấu hình.

Mã nguồn trong 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