fxlog 0.2.2

Table of Contents

• About
• Installation
• How-to Use
  • Save Log Files
  • Do Not Save Log Files
  • Set Log Level
  • Set Formatter
• Contact

About

A custom logging module for Python that supports colorized output and log file rotation. Includes features such as configurable log levels, custom formatters, and automatic deletion of old log files.

Installation

The package is available on PyPI and can be installed via pip:

python -m pip install fxlog

How-to Use

You can use the fxlog module in your Python scripts as follows:

Save Log Files

If you want to save the log files ¹, import the fxlog module, and set the log directory where log files will be stored:

from fxlog import fxlogger

fxlogger.set_log_directory('path/to/log/directory')

E.g.,

import os
from pathlib import Path
from fxlog import fxlogger


_PACKAGE_NAME = "package_name"
DATA_DIR = (
    Path(os.getenv("APPDATA")) / _PACKAGE_NAME
    if os.name == "nt"
    else Path.home() / f".{_PACKAGE_NAME}"
)
LOG_DIR = DATA_DIR / "logs"
LOG_DIR.mkdir(parents=True, exist_ok=True)

fxlogger.set_log_directory(LOG_DIR)

[!NOTE] This only needs to be done once in your package.

Then, you can use the fxlog module to create a logger object and log messages to the console and a log file:

from fxlog import fxlogger

logger = fxlogger.configure_logger('my_logger')
logger.debug('This is a debug message')

To delete old log files, you can use the fxlog module as follows:

from fxlog import fxlogger

fxlogger.delete_old_logs(7) # Delete log files older than 7 days

You can also clear all log files in the log directory:

from fxlog import fxlogger

fxlogger.clear_logs()

[!NOTE] ¹ The log files are constructed with the following naming convention: <logger_name>_<year>-<month>-<day>.log.

Do Not Save Log Files

If you don't want to save the log files, you can use the fxlog module as follows:

from fxlog import fxlogger

logger = fxlogger.configure_logger('my_logger', save_to_file=False)
logger.debug('This is a debug message')

Set Log Level

You can set the log level of all loggers by using the set_loggers_level function:

from fxlog import fxlogger

fxlogger.set_loggers_level(fxlogger.DEBUG) # You can also use `logging.DEBUG`

Set Formatter

By default, the output looks like this:

You can enable a colored output by setting the enable_color parameter to True. The messages will be colorized according to their log levels:

from fxlog import fxlogger

logger = fxlogger.configure_logger('my_logger', enable_color=True)
logger.debug('This is a debug message')

[!NOTE] Colors are not saved in log files.

[!WARNING] If enable_color is set to True but the terminal does not support colorized output, the messages will be displayed in their original form.

You can also enable a separator between log messages by setting the enable_separator parameter to True:

from fxlog import fxlogger

logger = fxlogger.configure_logger('my_logger', enable_separator=True)
logger.debug('This is a debug message')

Contact

Project Link: fxlog