/msgfy

msgfy is a Python library for convert Exception instance to a human-readable error message.

Primary LanguagePythonMIT LicenseMIT

msgfy

Summary

msgfy is a Python library for convert Exception instance to a human-readable error message.

PyPI package version Supported Python versions CI status of Linux/macOS/Windows Test coverage CodeQL

Usage

Convert from Exception instance to an error message

Sample Code:
import msgfy

def error_message_example():
    try:
        raise ValueError("example message")
    except ValueError as e:
        print(msgfy.to_error_message(e))

error_message_example()
Output:
ValueError: example error message

Specify message format

Sample Code:
import msgfy

def error_message_format_example():
    try:
        raise ValueError("example error message")
    except ValueError as e:
        print(msgfy.to_error_message(e, "{exception} {func_name}: {error_msg}"))

error_message_format_example()
Output:
ValueError error_message_format_example: example error message

Convert from Exception instance to a debug message

Sample Code:
import msgfy

def debug_message_example():
    try:
        raise ValueError("example debug message")
    except ValueError as e:
        print(msgfy.to_debug_message(e))

debug_message_example()
Output:
ValueError <ipython-input-4-bdd569af197b>(5) debug_message_example: example debug message

Available keywords for message formats

Keyword Replaced to
"{exception}" Exception class name
"{file_name}" File name that exception raised
"{line_no}" Line number where the exception raised
"{func_name}" Function name that exception raised
"{error_msg}" Message that passed to the exception instance

Installation

Install from PyPI

pip install msgfy

Install from PPA (for Ubuntu)

sudo add-apt-repository ppa:thombashi/ppa
sudo apt update
sudo apt install python3-msgfy

Dependencies

Python 3.7+ No external dependencies.

Test dependencies