refactor: decorators to work from inside the readylog package

Author: fleetingbytes

ruff.toml

@@ -42,10 +42,15 @@ select = [
 "tests/test_log.py" = [
     "N813",  # camelcase-imported-as-lowercase
 ]
+"tests/test_decorators.py" = [
+    "N813",    # camelcase-imported-as-lowercase
+    "PLR917",  # too-many-positional-arguments
+]
 "src/readylog/__init__.py" = [
     "PLR0913",  # too-many-arguments
     "PLR0914",  # too-many-local-variables
     "PLR0917",  # too-many-positional-arguments
+    "PLC2701",  # import-private-name
 ]
 
 extend-safe-fixes = [

src/readylog/__init__.py

@@ -1,6 +1,7 @@
 from collections.abc import Callable
-from logging import FileHandler, StreamHandler, getLevelName, getLevelNamesMapping
+from logging import FileHandler, StreamHandler, _checkLevel, getLevelName
 from pathlib import Path
+from sys import modules
 
 
 def create_dict_config(
@@ -11,10 +12,9 @@ def create_dict_config(
     console_handler_factory: Callable = StreamHandler,
     file_handler_factory: Callable = FileHandler,
 ) -> dict[str, str]:
-    level_names = getLevelNamesMapping().keys()
-    assert console_log_level in level_names
-    assert file_log_level in level_names
-    min_level = getLevelName(min(getLevelName(console_log_level), getLevelName(file_log_level)))
+    console_log_level = _checkLevel(console_log_level)
+    file_log_level = _checkLevel(file_log_level)
+    min_level = getLevelName(min(console_log_level, file_log_level))
 
     custom_file_formatter_conf = {
         "format": "{message:<50s} {levelname:>9s} {asctime}.{msecs:03.0f} {module}({lineno}) {funcName}",
@@ -100,6 +100,7 @@ def create_dict_config(
     loggers_dict = {
         app_name: custom_logger_conf,
         "__main__": custom_logger_conf,
+        f"{modules[__name__].__spec__.parent}.decorators": custom_logger_conf,
     }
 
     dict_config = {

src/readylog/decorators.py

@@ -1,6 +1,7 @@
 from functools import wraps
 from itertools import product
-from logging import DEBUG, getLevelName, getLevelNameMapping, getLogger
+from logging import DEBUG, getLevelName, getLevelNamesMapping, getLogger
+from sys import modules
 
 logger = getLogger(__name__)
 
@@ -48,7 +49,7 @@ def wrapper(*args, **kwargs):
     return decorator
 
 
-level_names = getLevelNameMapping().values()
+level_names = getLevelNamesMapping().keys()
 
 for level, direction in product(level_names, ("_in", "_out", "")):
     if direction == "_in":
@@ -61,7 +62,7 @@ def wrapper(*args, **kwargs):
         enter = True
         exit = True
     setattr(
-        __name__,
+        modules[__name__],
         f"{level.lower()}{direction}",
         log_io(getLevelName(level), enter=enter, exit=exit),
     )

tests/conftest.py

@@ -1,17 +1,21 @@
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any
+
 from pytest import FixtureRequest, fixture
 from watchdog.events import FileModifiedEvent, FileSystemEventHandler
 from watchdog.observers import Observer
 
 
 @fixture
-def tmp_log_file(tmp_path):
+def tmp_log_file(tmp_path) -> Path:
     path = tmp_path / "log" / "debug.log"
     path.parent.mkdir(parents=True, exist_ok=False)
     return path
 
 
 @fixture
-def app_name():
+def app_name() -> str:
     return "test_app"
 
 
@@ -39,3 +43,14 @@ def on_modified(event: FileModifiedEvent):
 
     observer.stop()
     observer.join()
+
+
+def function_under_test(*args, **kwargs) -> tuple[tuple[Any, ...], dict[Any, Any]]:
+    return args, kwargs
+
+
+@fixture
+def decorated_function(request: FixtureRequest) -> Callable:
+    decorator = request.param
+    decorated_func = decorator(function_under_test)
+    return decorated_func

tests/test_decorators.py

@@ -0,0 +1,85 @@
+from collections.abc import Callable
+from logging import DEBUG
+from logging.config import dictConfig as configure_logging
+from pathlib import Path
+
+from pytest import CaptureFixture, mark, param
+
+from readylog import create_dict_config
+from readylog.decorators import (
+    critical,
+    critical_in,
+    critical_out,
+    debug,
+    debug_in,
+    debug_out,
+    error,
+    error_in,
+    error_out,
+    info,
+    info_in,
+    info_out,
+    warning,
+    warning_in,
+    warning_out,
+)
+
+decorators = {
+    "debug": debug,
+    "debug_in": debug_in,
+    "debug_out": debug_out,
+    "info": info,
+    "info_in": info_in,
+    "info_out": info_out,
+    "warning": warning,
+    "warning_in": warning_in,
+    "warning_out": warning_out,
+    "error": error,
+    "error_in": error_in,
+    "error_out": error_out,
+    "critical": critical,
+    "critical_in": critical_in,
+    "critical_out": critical_out,
+}
+
+
+@mark.parametrize(
+    "decorated_function, expect_function_entry_logged, expect_function_return_logged",
+    (
+        *(
+            param(
+                decorator,
+                not decorator_name.endswith("_out"),
+                not decorator_name.endswith("_in"),
+                id=decorator_name,
+            )
+            for decorator_name, decorator in decorators.items()
+        ),
+    ),
+    indirect=["decorated_function"],
+)
+def test_decorators(
+    tmp_log_file: Path,
+    app_name: str,
+    decorated_function: Callable,
+    expect_function_entry_logged: bool,
+    expect_function_return_logged: bool,
+    capsys: CaptureFixture,
+) -> None:
+    config = create_dict_config(tmp_log_file, app_name, console_log_level=DEBUG)
+    configure_logging(config)
+
+    decorated_function("some_arg", some_kwarg="some_value")
+
+    captured = capsys.readouterr()
+    lines = captured.err.strip()
+
+    if expect_function_entry_logged:
+        assert "Calling function_under_test" in lines
+        if not expect_function_return_logged:
+            assert "function_under_test returned" not in lines
+
+    if expect_function_return_logged:
+        assert "function_under_test returned" in lines
+        if not expect_function_entry_logged:
+            assert "Calling function_under_test" not in lines

tests/test_general.py

@@ -16,7 +16,7 @@ def test_config_creation(tmp_log_file, app_name):
     ),
 )
 def test_config_creation_with_wrong_level(tmp_log_file, app_name, kwargs):
-    with raises(AssertionError):
+    with raises(ValueError):
         _ = create_dict_config(tmp_log_file, app_name, **kwargs)