Distfit modifies the root logger globally

[JulianFerry]

Description

Importing distfit modifies all logs in our project, this does not happen with any other packages. This happens because distfit modifies the root logger globally: https://github.com/erdogant/distfit/blob/master/distfit/distfit.py#L26

Since distfit is a library it should at least use a local logger with logger = logging.getLogger(__name__), and ideally it should not be configuring logs for its downstream applications.

Minimal reproducible example

import logging

logging.basicConfig(
    format="%(asctime)s %(name)-12s %(levelname)-8s %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S",
    level=logging.INFO,
)

logger = logging.getLogger(__name__)

logger.info("This uses the basic configuration")

from distfit import distfit

logger.info("This is modified by distfit")

Output:

2025-02-26 17:24:55 __main__     INFO     This uses the configuration
[distfit] >INFO> This is modified by distfit

Expected behaviour

Importing distfit should not modify existing logger

[JulianFerry]

The workaround I have for this at the moment is:

from contextlib import contextmanager

@contextmanager
def preserve_root_logger():
    """Preserve the root logger when executing code.

    This is to stop distlib from modifying the root logger:
    https://github.com/erdogant/distfit/issues/51
    """
    # Save original logger state
    root_logger = logging.getLogger()
    original_handlers = root_logger.handlers[:]
    original_level = root_logger.level

    try:
        yield  # Allow code to run inside the context
    finally:
        # Restore original handlers
        root_logger.handlers.clear()
        for handler in original_handlers:
            root_logger.addHandler(handler)
        root_logger.setLevel(original_level)

with preserve_root_logger():
    import distfit

[erdogant]

Thank you for the feedback.
When I take over your example, the logger name also seems not to change when using another library.
So I created a few adjustments on your example:

logger = logging.getLogger('')
[logger.removeHandler(handler) for handler in logger.handlers[:]]
logging.basicConfig(
    format="%(asctime)s [%(name)-12s] >%(levelname)-8s %(message)s",
    datefmt="%d-%m-%y %H:%M:%S",
    level=logging.INFO)
logger = logging.getLogger(__name__)

I first set the logger to <empty>, then I remove previous handles, and finally set it to the new __name__ again.
Would this scenario also work in your case? In my examples, this works now.

[erdogant]

pip install git+https://github.com/erdogant/distfit

It should be version >= 1.8.2

[ahowe42]

Where can we get 1.8.2? Pip can't find it, and I don't see a tag or release 1.8.2. Thanks.

[erdogant]

Ah I see. Typo. Should be 1.8.1 If you can install from github source you will get the latest version.

[ahowe42]

Thanks.

[gospodima]

Hello,

i think it might be also affected by recent changes in pypickle dependency.
Besides having changed log format in our project, we also started getting ValueError: unsupported format character ']' (0x5d) at index 20 on any logger call attempts, which does not happen if we manually specify pypickle version as 1.1.1

[erdogant]

Thank you for pointing this out! it was a syntax error in the logger. I released a new version.
Can you check whether this solves your issue?

pip install - U pypickle

[gospodima]

@erdogant

Thank you for a quick fix and response. It solves the issue with logging error indeed, but it still causes log format changes in our project. With 1.1.0 it is not the case, probably because we are using older distfit version (distfit==1.4.5)

[erdogant]

I changed the logging. It should keep other logging intact now. Can you check?
pip install -U distfit
The version should be >= 1.8.2