Skip to content

Logger

get_csv_logger(remove_handlers=True, logfile=None, **kw)

Calls a treefile logger formatted for files output, no colors but timestamps

.. code:: python

logging.basicConfig(level=logging.INFO)
log = get_csv_logger()
Source code in gdutils/utils/logger.py
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def get_csv_logger(remove_handlers: bool = True, logfile: Optional[str] = None, **kw) -> logging.Logger:
    """
    Calls a treefile logger formatted for files output, no colors but timestamps

    .. code:: python

        logging.basicConfig(level=logging.INFO)
        log = get_csv_logger()

    """
    return get_logger(
        remove_handlers=remove_handlers,
        default=False,
        handlers=[stream_csv_handler(**kw)],
        logfile=logfile,
    )

get_logger(remove_handlers=True, default=True, handlers=None, origin=True, logfile=None)

Format the root logger to remove default handlers and add a default StreamHandler with custom formatter SimpleFormatter.

Usage example, place this in your main module

.. code:: python

logging.basicConfig(level=logging.INFO)
log = gd.get_logger()
Source code in gdutils/utils/logger.py
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def get_logger(
    remove_handlers: bool = True,
    default: bool = True,
    handlers: Optional[List[logging.Handler]] = None,
    origin: bool = True,
    logfile: Optional[str] = None,
) -> logging.Logger:
    """
    Format the root logger to remove default handlers and add a default `StreamHandler` with custom formatter `SimpleFormatter`.

    Usage example, place this in your main module

    .. code:: python

        logging.basicConfig(level=logging.INFO)
        log = gd.get_logger()

    """
    logger = logging.getLogger()
    # Removed side effect: logging.getLogger("matplotlib").setLevel(logging.ERROR)

    if remove_handlers:
        for hdlr in list(logger.handlers):
            logger.removeHandler(hdlr)

    if default:
        console_handler = logging.StreamHandler(sys.stdout)
        console_handler.setFormatter(SimpleFormatter(origin))
        logger.addHandler(console_handler)

    if handlers is not None:
        for x in handlers:
            logger.addHandler(x)

    if logfile:
        if str(logfile).endswith(".py"):
            logfile = logfile[:-3] + ".log"
        # 1MB max, 5 backups
        x = RotatingFileHandler(logfile, maxBytes=int(1e6), backupCount=5)
        x.setFormatter(CSVFormatter())
        logger.addHandler(x)

    return logger