انتقل إلى المحتوى

مرجع ل hub_sdk/helpers/logger.py

ملاحظه

هذا الملف متاح في https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/helpers/logger.py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!



hub_sdk.helpers.logger.Logger

يمثل تكوين مسجل لمعالجة رسائل السجل.

سمات:

اسم نوع وصف
logger_name str

اسم المسجل. الإعدادات الافتراضية لاسم وحدة الاتصال.

log_format str

تنسيق رسائل السجل. الإعدادات الافتراضية لقيمة "LOGGER_FORMAT" متغير البيئة أو "٪ (ASCTIME) s - ٪ (الاسم) s - ٪ (اسم المستوى) s - ٪ (الرسالة) s".

log_level str

مستوى السجل للمسجل. الإعدادات الافتراضية لقيمة "LOGGER_LEVEL" متغير البيئة أو "INFO".

logger Logger

مثيل المسجل الذي تم تكوينه.

شفرة المصدر في 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)

تهيئة مثيل المسجل.

البارامترات:

اسم نوع وصف افتراضي
logger_name str

اسم المسجل. إذا لم يتم توفيره ، يتم تعيينه افتراضيا إلى مسجل الجذر.

None
log_format str

تنسيق رسائل السجل. الإعدادات الافتراضية لقيمة "LOGGER_FORMAT" متغير البيئة أو '٪ (ASCTIME) s - ٪ (اسم المستوى) s - ٪ (رسالة) s'.

None
log_level str

مستوى السجل للمسجل. الإعدادات الافتراضية لقيمة "LOGGER_LEVEL" متغير البيئة أو "INFO".

None
شفرة المصدر في 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()

احصل على مثيل المسجل الذي تم تكوينه.

ارجاع:

نوع وصف
Logger

مثيل المسجل الذي تم تكوينه.

شفرة المصدر في 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