py-exceptions 1.0.2

A simple python exception reporter

py-exceptions

A simple python exception reporter

Description

This library provides great stacktrace and web request information like Django does It can save it to html, return html to your code or even response in AWS lambda format

The library nicely covers all your secret variables and request data in its report

Screenshots

Quickstart

Installation

pip install py-exception

Simple example

Add decorator to function

from pyexceptions import handle_exceptions


def divide(a, b):
    return a / b


@handle_exceptions
def main():
    i = 5
    j = 0
    c = divide(i, j)
    print(c)


if __name__ == '__main__':
    main()

You can also override folder for exception reports

from pyexceptions import handle_exceptions


def divide(a, b):
    return a / b


@handle_exceptions(exceptions_folder=f'./SomeFolderPath')
def main():
    i = 5
    j = 0
    c = divide(i, j)
    print(c)


if __name__ == '__main__':
    main()

AWS Lambda example

It is hard to determine what's went wrong when you are using AWS lambda. So you can use the example not only to get full stacktrace but to get lambda event and context information:

from pyexceptions import handle_exceptions


@handle_exceptions(is_lambda=True)
def lambda_handler(event, context):  # noqa
    message = f"Hello {event['first_name']} {event['last_name']}!"
    return {
        'message': message
    }

Other functions

You can also want to use these functions:

Make function that returns HTML:

from pyexceptions import handle_exceptions


@handle_exceptions(return_html=True)
def main():
    ...

Or you may want to write your own logic To do so you need to import the ExceptionHandler class

from pyexceptions import ExceptionHandler  # noqa

To be clear here how it looks like:

class ExceptionHandler:
    """Organize and coordinate reporting on exceptions."""

    def __init__(self, lambda_event: dict = None, context: object = None, exclude: str = None):
        """Exception reporter initializer
        
        Args:
            lambda_event (dict, optional): AWS lambda event. Defaults to None.
            context (object, optional): AWS lambda context. Defaults to None.
            exclude (str, optional): Function to exclude Defaults to None.
        
        """
        self.__reporter = ExceptionReporter(lambda_event, context, exclude)  # noqa

    def get_traceback_html(self):
        """Return HTML version of debug 500 HTTP error page."""
        return self.__reporter.get_traceback_html()

    def get_traceback_lambda(self):
        """Return AWS lambda version of debug 500 HTTP error page."""
        return self.__reporter.get_lambda_response()

Attribution

This implementation draws upon work from:

• Django

• vercel-python-wsgi