Skip to main content

Custom messages for errors

Project description


This is a project aimed at tool developers who want to create custom error checks provide better messages with improved location, accuracy and message quality for different errors in Python.

Some checks for syntax errors are provided out of the box.

Currently available checks can be found in error-explainer/


To install this package use pip install error-explainer


Check a Python file for possible errors

from error_explainer.check_runner import run_checks

messages = run_checks("path/to/file")

Messages will be a list of strings containing the generated messages.

Add a new custom check

Custom checks can be added to the list of checks ran while calling run_checks(). To add a new check use @add_check(force: bool, level=99) annotation. Force parameter defines if the check is ran only if the code does not compile (False) or always (True) Checks are also run in multiple levels from 0 to 99. Current layers are the following:

  • 0 - docstring errors, quote errors
  • 1 - miss match bracket errors, missing bracket errors, python 2 style print usage error
  • 2 - invalid function definition errors
  • 3 - missing colon errors, invalid assignment errors
  • 99 - indentation errors, coma used instead of a period in an assignment error
from error_explainer.check_runner import add_check, add_message

def custom_check(filename):
    # code for the check  
    if error_in_file:
        # To add a message to the list of messages returned when calling run_checks() use 
        add_message("code_for_the_message", argument1="foo", argument2="bar")
        # Custom arguments can be used in the message text to make messages more dynamic

Manage messages

Messages used in checks can be:


from error_explainer.messages import create_message

# message text can contain arguments in curly brackets these can be later given values using kwargs
create_message("code_for_the_message", "Message text with {dynamic_arguments}")


from error_explainer.messages import remove_message



from error_explainer.messages import overwrite_message

overwrite_message("code_for_the_message", "Message text with {dynamic_arguments}")

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

error-explainer-0.14.tar.gz (23.1 kB view hashes)

Uploaded source

Built Distribution

error_explainer-0.14-py3.6.egg (44.0 kB view hashes)

Uploaded 3 6

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page