Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/core_concepts/outputs_and_inspection.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,9 @@ Preprocessor(numerical_method="ple", verbose=1).fit(df, y)
fit complete: 2 numerical (ple) + 1 categorical (int) feature(s) -> 15 output columns in 0.02s
```

Levels are cumulative, and a value above `3` logs like `3` (`set_verbosity` and
`configure_logging` clamp a level into `0`-`3`).

Each fit applies its own level, so a later `verbose=2` fit in the same process or notebook logs
the table even after a `verbose=1` fit. PreTab attaches its own stream handler only when no host
handler receives its records. A handler on the `"pretab"` logger, or on an ancestor such as the
Expand Down
6 changes: 4 additions & 2 deletions pretab/core/logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@ def set_verbosity(level: int = 1) -> None:
level : int, default=1
Verbosity level ``0``-``3`` (``0`` = WARNING, ``1`` = INFO, ``2``/``3`` =
DEBUG). ``bool`` is accepted and coerced (``True`` -> ``1``, ``False`` ->
``0``).
``0``). A value outside that range is clamped into it, so verbosity never
decreases as the level grows: a negative level is as quiet as ``0`` and a
level above ``3`` is as verbose as ``3``.
"""
_LOGGER.setLevel(_LEVELS.get(int(level), logging.INFO))
_LOGGER.setLevel(_LEVELS[min(max(int(level), min(_LEVELS)), max(_LEVELS))])


def configure_logging(level: int = 1, handler: "logging.Handler | None" = None) -> None:
Expand Down
2 changes: 2 additions & 0 deletions pretab/preprocessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,8 @@ class Preprocessor(TransformerMixin, BaseEstimator):
- ``2`` -- the per-feature table that :meth:`get_feature_info` builds.
- ``3`` -- internal decisions (fitted bins / knots / centers).

A value above ``3`` logs like ``3``.

Stored verbatim and forwarded by ``get_params`` / ``clone``, so an embedding host
(e.g. DeepTab) can pass it straight through ``Preprocessor(**kwargs)``. PreTab never
configures the root logger or attaches a handler when the host already owns one (on
Expand Down
41 changes: 41 additions & 0 deletions tests/integration/test_verbosity.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,47 @@ def test_set_verbosity_sets_logger_level():
assert logger.level == logging.INFO


@pytest.mark.parametrize(
("level", "expected"),
[
(-1, logging.WARNING),
(0, logging.WARNING),
(3, logging.DEBUG),
(4, logging.DEBUG),
(10, logging.DEBUG),
(True, logging.INFO),
(False, logging.WARNING),
],
)
def test_set_verbosity_clamps_out_of_range_levels(level, expected):
"""A level outside 0-3 fell back to INFO: 4 logged less than 3, and -1 more than 0."""
set_verbosity(level)
assert logging.getLogger("pretab").level == expected


def test_configure_logging_clamps_out_of_range_levels():
with _root_handlers():
configure_logging(7)
assert logging.getLogger("pretab").level == logging.DEBUG
configure_logging(-3)
assert logging.getLogger("pretab").level == logging.WARNING


def test_verbose_above_three_logs_like_three(caplog, sample_data):
"""Preprocessor(verbose=4) dropped the level-2 table and level-3 details."""
X, y = sample_data

def records(verbose):
caplog.clear()
with caplog.at_level(logging.DEBUG, logger="pretab"):
Preprocessor(verbose=verbose).fit(X, y)
return [(record.levelno, record.getMessage().split(" in ")[0]) for record in caplog.records]

level_three = records(3)
assert any(level == logging.DEBUG for level, _ in level_three)
assert records(4) == level_three


@contextlib.contextmanager
def _root_handlers(*handlers):
"""Run with exactly ``handlers`` on the root logger (none: a plain Python process).
Expand Down