A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
from __future__ import annotations
import logging
import os
from logging.handlers import TimedRotatingFileHandler
from pathlib import Path
from unittest.mock import patch
import pytest
from marimo._loggers import (
_LOG_LEVEL,
_LOGGERS,
WindowsSafeRotatingFileHandler,
get_log_directory,
get_logger,
make_log_directory,
marimo_logger,
set_level,
)
from marimo._utils.log_formatter import LogFormatter
def test_error_format_without_log_prefix():
record = logging.LogRecord(
"marimo",
logging.ERROR,
__file__,
1,
"Invalid config: %s\nDetails",
("test",),
None,
)
record.omit_log_prefix = True
formatter = LogFormatter(
color=False,
without_log_prefix_fmt=LogFormatter.WITHOUT_LOG_PREFIX_FORMAT,
)
assert formatter.format(record) == (
"Error: Invalid config: test\nDetails\n"
)
formatter._colors = {logging.ERROR: "\033[31m"}
formatter._normal = "\033[0m"
assert formatter.format(record) == (
"\033[31mError: Invalid config: test\nDetails\033[0m\n"
)
assert "[E " in LogFormatter(color=False).format(record)
record.omit_log_prefix = False
assert "[E " in formatter.format(record)
def test_set_level():
original_level = _LOG_LEVEL
# Test with integer levels
set_level(logging.DEBUG)
logger = get_logger("test1")
assert logger.level == logging.DEBUG
assert logger.handlers[0].level == logging.DEBUG
set_level(logging.INFO)
assert logger.level == logging.INFO
assert logger.handlers[0].level == logging.INFO
# Test with string levels
for level in ["WARNING", "WARN", "DEBUG", "INFO", "ERROR", "CRITICAL"]:
set_level(level)
assert logger.level == min(logging._nameToLevel[level], logging.INFO)
assert logger.handlers[0].level == logging._nameToLevel[level]
# Test invalid levels
with pytest.raises(ValueError):
set_level("INVALID")
with pytest.raises(ValueError):
set_level(999)
# Reset the log level
set_level(original_level)
def test_get_logger():
# Test basic logger creation
logger1 = get_logger("test2")
assert logger1.name == "test2"
assert not logger1.propagate
assert len(logger1.handlers) == 1
# Test logger caching
logger2 = get_logger("test2")
assert logger1 is logger2 # Same logger instance
# Test custom level
logger3 = get_logger("test3", level=logging.DEBUG)
assert logger3.level == logging.DEBUG
# Test handlers
handler = logger3.handlers[0]
assert isinstance(handler, logging.StreamHandler)
def test_marimo_logger():
logger = marimo_logger()
assert logger.name == "marimo"
first_handler = logger.handlers[0]
assert isinstance(first_handler, logging.StreamHandler)
second_handler = logger.handlers[1]
assert isinstance(second_handler, logging.FileHandler)
# Test file handler
file_handler = next(
h for h in logger.handlers if isinstance(h, logging.FileHandler)
)
assert isinstance(file_handler, TimedRotatingFileHandler)
def test_log_directory():
# Test default directory
default_dir = Path.home() / ".cache" / "marimo" / "logs"
assert get_log_directory() == default_dir
def test_make_log_directory(tmp_path: Path):
test_dir = tmp_path / "marimo_test_logs"
with patch.dict(os.environ, {"XDG_CACHE_HOME": str(test_dir)}):
make_log_directory()
assert test_dir.exists()
assert test_dir.is_dir()
def test_handler_levels():
logger = marimo_logger()
stream_handler = logger.handlers[0]
file_handler = logger.handlers[1]
assert isinstance(stream_handler, logging.StreamHandler)
assert isinstance(file_handler, logging.FileHandler)
# Test level changes affect stream handler but not file handler
set_level(logging.WARNING)
assert stream_handler.level == logging.WARNING
assert file_handler.level == logging.INFO
set_level(logging.DEBUG)
assert stream_handler.level == logging.DEBUG
assert file_handler.level == logging.DEBUG
def test_windows_safe_handler(tmp_path: Path):
"""Test that WindowsSafeRotatingFileHandler handles rotation gracefully."""
log_file = tmp_path / "test.log"
# Create handler
handler = WindowsSafeRotatingFileHandler(
log_file,
when="S", # Rotate every second for testing
interval=1,
backupCount=3,
encoding="utf-8",
)
# Write some logs
logger = logging.getLogger("test_windows")
logger.addHandler(handler)
logger.setLevel(logging.INFO)
logger.info("Test message 1")
logger.info("Test message 2")
# Test that doRollover doesn't crash even with PermissionError
try:
handler.doRollover()
# Should succeed or gracefully handle errors
assert True
except PermissionError:
# Should not raise PermissionError
pytest.fail("WindowsSafeRotatingFileHandler raised PermissionError")
finally:
handler.close()
logger.removeHandler(handler)
def test_file_handler_uses_windows_safe_on_windows(tmp_path: Path):
"""Test that _file_handler uses WindowsSafeRotatingFileHandler on Windows."""
from marimo._loggers import _file_handler
# Test on Windows
with patch("sys.platform", "win32"):
with patch("marimo._loggers.get_log_directory", return_value=tmp_path):
handler = _file_handler()
assert isinstance(handler, WindowsSafeRotatingFileHandler)
handler.close()
# Test on non-Windows
with patch("sys.platform", "linux"):
with patch("marimo._loggers.get_log_directory", return_value=tmp_path):
handler = _file_handler()
assert isinstance(handler, TimedRotatingFileHandler)
# Should not be the Windows-safe subclass on non-Windows
assert not isinstance(handler, WindowsSafeRotatingFileHandler)
handler.close()
@pytest.fixture(autouse=True)
def clear_loggers():
# Clear the logger cache before each test
_LOGGERS.clear()