Skip to content

Module omnipy.config.root_log

Overview

View Source
from dataclasses import dataclass, field

import locale as pkg_locale

import logging

from pathlib import Path

from omnipy.api.typedefs import LocaleType

def _get_log_dir_path() -> str:

    return str(Path.cwd().joinpath(Path('logs')))

@dataclass

class RootLogConfig:

    log_format_str: str = '{engine} {asctime} - {levelname}: {message} [{name}]'

    locale: LocaleType = pkg_locale.getlocale()

    log_to_stdout: bool = True

    log_to_stderr: bool = True

    log_to_file: bool = True

    stdout_log_min_level: int = logging.INFO

    stderr_log_min_level: int = logging.ERROR

    file_log_min_level: int = logging.WARNING

    file_log_dir_path: str = field(default_factory=_get_log_dir_path)

Classes

RootLogConfig

class RootLogConfig(
    log_format_str: str = '{engine} {asctime} - {levelname}: {message} [{name}]',
    locale: str | tuple[str | None, str | None] = (None, None),
    log_to_stdout: bool = True,
    log_to_stderr: bool = True,
    log_to_file: bool = True,
    stdout_log_min_level: int = 20,
    stderr_log_min_level: int = 40,
    file_log_min_level: int = 30,
    file_log_dir_path: str = <factory>
)

RootLogConfig(log_format_str: str = '{engine} {asctime} - {levelname}: {message} [{name}]', locale: str | tuple[str | None, str | None] = (None, None), log_to_stdout: bool = True, log_to_stderr: bool = True, log_to_file: bool = True, stdout_log_min_level: int = 20, stderr_log_min_level: int = 40, file_log_min_level: int = 30, file_log_dir_path: str = )

View Source
@dataclass

class RootLogConfig:

    log_format_str: str = '{engine} {asctime} - {levelname}: {message} [{name}]'

    locale: LocaleType = pkg_locale.getlocale()

    log_to_stdout: bool = True

    log_to_stderr: bool = True

    log_to_file: bool = True

    stdout_log_min_level: int = logging.INFO

    stderr_log_min_level: int = logging.ERROR

    file_log_min_level: int = logging.WARNING

    file_log_dir_path: str = field(default_factory=_get_log_dir_path)

Class variables

file_log_min_level
locale
log_format_str
log_to_file
log_to_stderr
log_to_stdout
stderr_log_min_level
stdout_log_min_level

Methods

eq
def __eq__(
    self,
    other
)

Return self==value.

Parameters:

Name Type Description Default
other