# Exceptionite
<p align="center">
<a href="https://docs.masoniteproject.com">
<img alt="Masonite Package" src="https://img.shields.io/static/v1?label=Masonite&message=package&labelColor=grey&color=blue&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAA6gAwAEAAAAAQAAAA4AAAAATspU+QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAnxJREFUKBVNUl1IVEEUPjPObdd1VdxWM0rMIl3bzbVWLSofVm3th0AhMakHHyqRiNSHEAq5b2HSVvoQRUiEECQUQkkPbRslRGigG8auoon2oPSjpev+3PWeZq7eaC5nDt93vplz5txDQJYpNxX4st4JFiwj9aCqmswUFQNS/A2YskrZJPYefkECC2GhQwAqvLYybwXrwBvq8HSNOXRO92+aH7nW8vc/wS2Z9TqneYt2KHjlf9Iv+43wFJMExzO0YE5OKe60N+AOW6OmE+WJTBrg23jjzWxMBauOlfyycsV24F+cH+zAXYUOGl+DaiDxfl245/W9OnVrSY+O2eqPkyz4sVvHoKp9gOihf5KoAVv3hkQgbj/ihG9fI3RixKcUVx7lJVaEc0vnyf2FFll+ny80ZHZiGhIKowWJBCEAKr+FSuNDLt+lxybSF51lo74arqs113dOZqwsptxNs5bwi7Q3q8npSC2AWmvjTncZf1l61e5DEizNn5mtufpsqk5+CZTuq00sP1wkNPv8jeEikVVlJso+GEwRtNs3QeBt2YP2V2ZI3Tx0e+7T89zK5tNASOLEytJAryGtkLc2PcBM5byyUWYkMQpMioYcDcchC6xN220Iv36Ot8pV0454RHLEwmmD7UWfIdX0zq3GjMPG5NKBtv5qiPEPekK2U51j1451BZoc3i+1ohSQ/UzzG5uYFFn2mwVUnO4O3JblXA91T51l3pB3QweDl7sNXMyEjbguSjrPcQNmwDkNc8CbCvDd0+xCC7RFi9wFulD3mJeXqxQevB4prrqgc0TmQ85NG/K43e2UwnMVAJIEBNfWRYR3HfnvivrIzMyo4Hgy+hfscvLo53jItAAAAABJRU5ErkJggg==">
</a>
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/MasoniteFramework/exceptionite/Test%20Application">
<img src="https://img.shields.io/badge/python-3.7+-blue.svg" alt="Python Version">
<img alt="PyPI" src="https://img.shields.io/pypi/v/exceptionite">
<img alt="License" src="https://img.shields.io/github/license/MasoniteFramework/exceptionite">
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
A Python exception library designed to make handling and displaying exceptions a cinch.
Exceptions can be rendered into a beautiful HTML exception page!
or in your terminal:
# Getting Started
First install the package:
```bash
pip install exceptionite
```
Then you can follow instruction for your use case:
- [Masonite](#usage-for-masonite)
- [Flask](#usage-for-flask)
- [Django](#usage-for-django)
- [Django REST framework](#usage-for-django-rest-framework)
- [Pyramid](#usage-for-pyramid)
- [Basic Python](#usage-for-python)
## Usage for Masonite
Masonite 4 is already using `exceptionite` for its default error page so you don't have anything
to set up.
If you are using `Masonite < 4.0`, please use `exceptionite < 2.0`.
## Usage for Flask
If you are using `Flask` you can also use this package! Here is an example for a flask application:
```python
from flask import Flask, request
from exceptionite.flask import ExceptioniteReporter
app = Flask(__name__)
@app.errorhandler(Exception)
def handle_exception(exception):
handler = ExceptioniteReporter(exception, request)
# display exception stack trace nicely in console
handler.terminal()
return handler.html()
@app.route("/<world>")
def hello(world):
test = "Hello World"
return 2 / 0
if __name__ == "__main__":
app.run(debug=True)
```
You'll now see this beautiful exception page:
## Usage for Django
You can customize error reports in Django in `DEBUG` mode as explained in the [docs](https://docs.djangoproject.com/en/3.2/howto/error-reporting/#custom-error-reports).
Install the package if you haven't done so yet
```python
# settings.py
$ pip install exceptionite
```
Then simple set a default exception reporter to the exceptionite one. Be careful this reporter
should only be used for local development with `DEBUG=True`:
```python
# myapp/settings.py
if DEBUG:
DEFAULT_EXCEPTION_REPORTER = "exceptionite.django.ExceptioniteReporter"
```
If you want Django 404 to be also handled by exceptionite you should add an other reporter:
```python
# myapp/settings.py
if DEBUG:
# handle 404 errors
from exceptionite.django import Exceptionite404Reporter
Exceptionite404Reporter()
# handle all other errors
DEFAULT_EXCEPTION_REPORTER = "exceptionite.django.ExceptioniteReporter"
```
## Usage for Django REST framework
You can also customize error reports when using Django REST framework package in `DEBUG` mode as explained in the [docs](https://www.django-rest-framework.org/api-guide/exceptions/).
Install the package if you haven't done so yet
```python
# settings.py
$ pip install exceptionite
```
Then simple set the REST default exception reporter to the exceptionite one:
```python
# myapp/settings.py
if DEBUG:
REST_FRAMEWORK = {
"EXCEPTION_HANDLER": "exceptionite.django.drf_exception_handler"
}
```
Now when doing API requests accepting `application/json` a JSON debug error page
will be returned. When using the Django REST framework browsable API or accessing a GET endpoint from your browser (`text/html`) the HTML exceptionite page will be
displayed !
:warning: Note that this handler will change exception handling behaviour and should be only used when DEBUG mode is enabled.
If you want to customize exception handling for other cases you can do:
```python
# app/exception_handler.py
from exceptionite.django import drf_exception_handler
def custom_handler(exc, context):
# do what you want here
response = drf_exception_handler(exc, context)
# do what you want here
return response
```
```python
# myapp/settings.py
REST_FRAMEWORK = {
"EXCEPTION_HANDLER": "myapp.exception_handler.custom_handler"
}
```
## Usage for Pyramid
If you are using `Pyramid` you can also use this package! You just need to register two handlers
function to handle 404 and any other errors.
Here is an example for a simple pyramid application:
```python
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import exception_view_config, notfound_view_config
from exceptionite import Handler
handler = Handler()
@exception_view_config(Exception)
def handle_all_exceptions(exc, request):
handler.start(exc)
handler.render("terminal")
response = Response(handler.render("web"))
response.status_int = 500
return response
@notfound_view_config()
def handle_404(exc, request):
handler.start(exc)
handler.render("terminal")
response = Response(handler.render("web"))
response.status_int = 404
return response
def hello_world(request):
1 / 0
return Response("Hello World!")
if __name__ == "__main__":
with Configurator() as config:
config.add_route("hello", "/")
config.add_view(hello_world, route_name="hello")
# this line below is very important to scan our decorated error handlers
config.scan()
app = config.make_wsgi_app()
server = make_server("127.0.0.1", 8000, app)
server.serve_forever()
```
## Usage for Python
If you are not using a specific framework you can still use this library. You just have to get
an instance of the `Handler` class and use the `start()` method to start handling the exception.
Then you can get useful information easily and also define how you want to render the error. You
can even add your own renderer.
```python
from exceptionite import Handler
try:
2/0
except Exception as e:
handler = Handler()
handler.start(e)
```
Once you have the handler class theres a whole bunch of things we can now do!
### Getting Exception Details
Getting the exception name:
```python
handler.exception() #== ZeroDivisionError
```
Getting the exception message:
```python
handler.message() #== cannot divide by 0
```
Getting the exception namespace:
```python
handler.namespace() #== builtins.ZeroDivisionError
```
### Rendering an HTML page
You can render an elegant exception page by using the `render` method with the [WebRenderer](#renderers):
```python
handler.render("web") #== <html> ... </html>
```
If you have a framework or an application you can swap the exception handler out with this handler
and then call this method.
### Adding Context
Sometimes you will need to add more information to the exception page. This is where contexts come into play. Contexts are the ability to add any information you need to help you debug information.
If you use a framework like Masonite you might want to see information related to your Service Providers. If you use a framework like django you might want to see a list of your installed apps.
On the left side of the page below the stack trace you will find the context menu. Context is organised into blocks.
1. You can register new contexts quickly by supplying a dictionary or a callable providing a dictionary:
```python
import sys
handler.renderer("web").context("System Variables", {"sys argv": sys.argv})
```
2. Or you [can create custom blocks](#block) and add them to the `Context` tab:
```python
import sys
from exceptionite import Block
class SystemVarsBlock(Block):
id = "system_vars"
name= "System Variables"
def build(self):
return {
"sys argv": sys.argv
}
handler.renderer("web").tab("context").add_blocks(SystemVarsBlock)
```
The second method allows to customize the block.
### Hiding Sensitive Data
Exceptionite is configured by default to scrub data displayed in tab and blocks. This allows hiding sensitive data, by replacing it with `*****`.
Hiding sensitive data can be disabled globally in handler options with `options.hide_sensitive_data`.
It can also be disabled per block by setting `disable_scrubbing = True` in [block class](#block).
The keywords defined to find sensitive data can be edited:
```python
# define a new set of keywords
handler.set_scrub_keywords(["app_secret", "pwd"])
# add new keywords
handler.add_scrub_keywords(["app_secret", "pwd"])
```
You can see the default keywords by accessing `handler.scrub_keywords`.
# Configuration
## Options
The `exceptionite` handler comes with the default options below:
```python
{
"options": {
"editor": "vscode",
"search_url": "https://www.google.com/search?q=",
"links": {
"doc": "https://docs.masoniteproject.com",
"repo": "https://github.com/MasoniteFramework/masonite",
},
"stack": {"offset": 8, "shorten": True},
"hide_sensitive_data": True
},
"handlers": {
"context": True,
"solutions": {"stackoverflow": False, "possible_solutions": True},
"recommendations": {"packages_updates": {"list": ["exceptionite"]}},
},
}
```
You can configure it by using `set_options(options)` method:
```python
from exceptionite import Handler, DefaultOptions
handler = Handler()
options = DefaultOptions
options.get("options").update({"search_url": "https://duckduckgo.com/?q="})
handler.set_options(options)
```
For Masonite, options are defined in `exceptions.py` configuration file.
## Renderers
When an error is caught by Exceptionite, it can be rendered in many ways through configured renderers. Available renderers are:
- WebRenderer: renders the exception as a beautiful HTML error page
- TerminalRenderer: renders the exception nicely in the console
- JSONRenderer: renders the exception as a JSON payload (useful for API errors handling)
A renderer is a simple Python class with `build()` and `render()` methods. Feel free to create
your own one if needed !
```python
class CustomRenderer:
def __init__(self, handler: "Handler"):
self.handler = handler
self.data = None
def build(self):
exception = self.handler.exception()
stack = self.handler.stacktrace()
# build data from exception here...
data = ...
return data
def render(self) -> str:
self.data = self.build()
# render the data as you want
return
```
To add a renderer:
```python
handler.add_renderer("json", JSONRenderer)
```
Then to render the exception using the renderer:
```python
handler.render("json") #== [{"exception": ...}]
```
## Web Renderer Specific Options
The HTML exception page created with the WebRenderer is highly configurable:
- Search engine used to search the error message on the web:
```python
"options": {
"search_url": "https://www.google.com/search?q="
# ...
}
```
- Editor used to open the line on the stack trace at click:
```python
"options": {
"editor": "sublime"
# ...
}
```
Available editors are `vscode`, `pycharm`, `idea`, `sublime`, `atom`, `textmate`, `emacs`, `macvim`, `vscodium`.
- Navbar links to documentation and repository can be customized:
```python
"options": {
"links": {
"doc": "https://docs.masoniteproject.com",
"repo": "https://github.com/MasoniteFramework/exceptionite",
},
}
```
- Tabs can be disabled. To disable `solutions` tab:
```python
"handlers": {
"solutions": False
}
```
- New tabs can be added:
```python
handler.renderer("web").add_tabs(DumpsTab)
```
### Blocks and Tabs API
#### Tab
A tab is defined with the following attributes:
- `id (str)`: slug of the tab that should be unique, and used to access it from handler
- `name (str)`: name of the tab displayed in the error page
- `icon (str)`: icon of the tab displayed in the error page (available icons are defined [here](https://heroicons.com/). The name should be converted to UpperCamelCase.)
- `advertise_content (bool)`: if `True` a animated dot will be displayed in error page navbar, if `has_content()` method returns `True`
- `disable_scrubbing (bool)`: if `True`, data won't be scrubbed, meaning that [sensitive data](#hiding-sensitive-data) won't be hidden.
and with the following methods (that can be overriden):
- `has_content()`: should returns a `bool` that indicates if tab has content.
#### Block
A block is located in a tab. A tab can have many blocks. Blocks are added to tab in the following manner:
```python
class ContextTab(Tab):
name = "Context"
id = "context"
icon = "ViewListIcon"
def __init__(self, handler):
super().__init__(handler)
self.add_blocks(Environment, Packages, Git)
# OR
handler.renderer("web").tab("context").add_blocks(Environment, Packages, Git)
```
A block is defined with the following attributes:
- `id (str)`: slug of the block that should be unique, and used to access it from handler
- `name (str)`: name of the block displayed in the error page
- `icon (str)`: icon of the block displayed in the error page (available icons are defined [here](https://heroicons.com/). The name should be converted to UpperCamelCase.)
- `disable_scrubbing (bool)`: if `True`, data won't be scrubbed, meaning that [sensitive data](#hiding-sensitive-data) won't be hidden.
- `empty_msg (str)`: message that will be displayed if block data is empty.
- `has_sections (bool)`: enable this to render dict as sections, where each root key is a section title and value is a nested dict.
and with the following methods:
- `build()`: must be implemented and should returns data that can be serialized. This data will be provided to the Vue block component.
- `has_content()`: should returns a `bool` that indicates if tab has content.
# Contributing
Please read the [Contributing Documentation](CONTRIBUTING.md) here.
# Maintainers
- [Joseph Mancuso](https://github.com/josephmancuso)
- [Samuel Girardin](https://www.github.com/girardinsamuel)
# License
Exceptionite is open-sourced software licensed under the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/masoniteframework/exceptionite",
"name": "exceptionite",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Masonite,Python,Development,Framework",
"author": "The Masonite Community",
"author_email": "joe@masoniteproject.com",
"download_url": "https://files.pythonhosted.org/packages/7e/da/f599dd48cc1ede8b180fafb2f125857a2931b2c7930422a07f1e22be3f03/exceptionite-2.2.5.tar.gz",
"platform": null,
"description": "\n# Exceptionite\n\n<p align=\"center\">\n <a href=\"https://docs.masoniteproject.com\">\n <img alt=\"Masonite Package\" src=\"https://img.shields.io/static/v1?label=Masonite&message=package&labelColor=grey&color=blue&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAA6gAwAEAAAAAQAAAA4AAAAATspU+QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAnxJREFUKBVNUl1IVEEUPjPObdd1VdxWM0rMIl3bzbVWLSofVm3th0AhMakHHyqRiNSHEAq5b2HSVvoQRUiEECQUQkkPbRslRGigG8auoon2oPSjpev+3PWeZq7eaC5nDt93vplz5txDQJYpNxX4st4JFiwj9aCqmswUFQNS/A2YskrZJPYefkECC2GhQwAqvLYybwXrwBvq8HSNOXRO92+aH7nW8vc/wS2Z9TqneYt2KHjlf9Iv+43wFJMExzO0YE5OKe60N+AOW6OmE+WJTBrg23jjzWxMBauOlfyycsV24F+cH+zAXYUOGl+DaiDxfl245/W9OnVrSY+O2eqPkyz4sVvHoKp9gOihf5KoAVv3hkQgbj/ihG9fI3RixKcUVx7lJVaEc0vnyf2FFll+ny80ZHZiGhIKowWJBCEAKr+FSuNDLt+lxybSF51lo74arqs113dOZqwsptxNs5bwi7Q3q8npSC2AWmvjTncZf1l61e5DEizNn5mtufpsqk5+CZTuq00sP1wkNPv8jeEikVVlJso+GEwRtNs3QeBt2YP2V2ZI3Tx0e+7T89zK5tNASOLEytJAryGtkLc2PcBM5byyUWYkMQpMioYcDcchC6xN220Iv36Ot8pV0454RHLEwmmD7UWfIdX0zq3GjMPG5NKBtv5qiPEPekK2U51j1451BZoc3i+1ohSQ/UzzG5uYFFn2mwVUnO4O3JblXA91T51l3pB3QweDl7sNXMyEjbguSjrPcQNmwDkNc8CbCvDd0+xCC7RFi9wFulD3mJeXqxQevB4prrqgc0TmQ85NG/K43e2UwnMVAJIEBNfWRYR3HfnvivrIzMyo4Hgy+hfscvLo53jItAAAAABJRU5ErkJggg==\">\n </a>\n <img alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/workflow/status/MasoniteFramework/exceptionite/Test%20Application\">\n <img src=\"https://img.shields.io/badge/python-3.7+-blue.svg\" alt=\"Python Version\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/exceptionite\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/MasoniteFramework/exceptionite\">\n <a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n</p>\n\nA Python exception library designed to make handling and displaying exceptions a cinch.\n\nExceptions can be rendered into a beautiful HTML exception page!\n\n\n\n\nor in your terminal:\n\n\n\n\n# Getting Started\n\nFirst install the package:\n\n```bash\npip install exceptionite\n```\n\nThen you can follow instruction for your use case:\n\n- [Masonite](#usage-for-masonite)\n- [Flask](#usage-for-flask)\n- [Django](#usage-for-django)\n- [Django REST framework](#usage-for-django-rest-framework)\n- [Pyramid](#usage-for-pyramid)\n- [Basic Python](#usage-for-python)\n\n## Usage for Masonite\n\nMasonite 4 is already using `exceptionite` for its default error page so you don't have anything\nto set up.\nIf you are using `Masonite < 4.0`, please use `exceptionite < 2.0`.\n\n## Usage for Flask\n\nIf you are using `Flask` you can also use this package! Here is an example for a flask application:\n\n```python\nfrom flask import Flask, request\nfrom exceptionite.flask import ExceptioniteReporter\n\napp = Flask(__name__)\n\n\n@app.errorhandler(Exception)\ndef handle_exception(exception):\n handler = ExceptioniteReporter(exception, request)\n # display exception stack trace nicely in console\n handler.terminal()\n return handler.html()\n\n\n@app.route(\"/<world>\")\ndef hello(world):\n test = \"Hello World\"\n return 2 / 0\n\n\nif __name__ == \"__main__\":\n app.run(debug=True)\n```\n\nYou'll now see this beautiful exception page:\n\n\n\n\n## Usage for Django\n\nYou can customize error reports in Django in `DEBUG` mode as explained in the [docs](https://docs.djangoproject.com/en/3.2/howto/error-reporting/#custom-error-reports).\n\nInstall the package if you haven't done so yet\n\n```python\n# settings.py\n$ pip install exceptionite\n```\n\nThen simple set a default exception reporter to the exceptionite one. Be careful this reporter\nshould only be used for local development with `DEBUG=True`:\n\n```python\n# myapp/settings.py\nif DEBUG:\n DEFAULT_EXCEPTION_REPORTER = \"exceptionite.django.ExceptioniteReporter\"\n```\n\nIf you want Django 404 to be also handled by exceptionite you should add an other reporter:\n\n```python\n# myapp/settings.py\nif DEBUG:\n # handle 404 errors\n from exceptionite.django import Exceptionite404Reporter\n\n Exceptionite404Reporter()\n\n # handle all other errors\n DEFAULT_EXCEPTION_REPORTER = \"exceptionite.django.ExceptioniteReporter\"\n```\n\n## Usage for Django REST framework\n\nYou can also customize error reports when using Django REST framework package in `DEBUG` mode as explained in the [docs](https://www.django-rest-framework.org/api-guide/exceptions/).\n\nInstall the package if you haven't done so yet\n\n```python\n# settings.py\n$ pip install exceptionite\n```\n\nThen simple set the REST default exception reporter to the exceptionite one:\n\n```python\n# myapp/settings.py\nif DEBUG:\n REST_FRAMEWORK = {\n \"EXCEPTION_HANDLER\": \"exceptionite.django.drf_exception_handler\"\n }\n```\n\nNow when doing API requests accepting `application/json` a JSON debug error page\nwill be returned. When using the Django REST framework browsable API or accessing a GET endpoint from your browser (`text/html`) the HTML exceptionite page will be\ndisplayed !\n\n:warning: Note that this handler will change exception handling behaviour and should be only used when DEBUG mode is enabled.\n\nIf you want to customize exception handling for other cases you can do:\n\n```python\n# app/exception_handler.py\nfrom exceptionite.django import drf_exception_handler\n\ndef custom_handler(exc, context):\n # do what you want here\n\n response = drf_exception_handler(exc, context)\n\n # do what you want here\n return response\n```\n\n```python\n# myapp/settings.py\n\nREST_FRAMEWORK = {\n \"EXCEPTION_HANDLER\": \"myapp.exception_handler.custom_handler\"\n}\n```\n\n## Usage for Pyramid\n\nIf you are using `Pyramid` you can also use this package! You just need to register two handlers\nfunction to handle 404 and any other errors.\n\nHere is an example for a simple pyramid application:\n\n```python\nfrom wsgiref.simple_server import make_server\nfrom pyramid.config import Configurator\nfrom pyramid.response import Response\nfrom pyramid.view import exception_view_config, notfound_view_config\n\nfrom exceptionite import Handler\n\nhandler = Handler()\n\n\n@exception_view_config(Exception)\ndef handle_all_exceptions(exc, request):\n handler.start(exc)\n handler.render(\"terminal\")\n response = Response(handler.render(\"web\"))\n response.status_int = 500\n return response\n\n\n@notfound_view_config()\ndef handle_404(exc, request):\n handler.start(exc)\n handler.render(\"terminal\")\n response = Response(handler.render(\"web\"))\n response.status_int = 404\n return response\n\ndef hello_world(request):\n 1 / 0\n return Response(\"Hello World!\")\n\n\nif __name__ == \"__main__\":\n with Configurator() as config:\n config.add_route(\"hello\", \"/\")\n config.add_view(hello_world, route_name=\"hello\")\n # this line below is very important to scan our decorated error handlers\n config.scan()\n app = config.make_wsgi_app()\n server = make_server(\"127.0.0.1\", 8000, app)\n server.serve_forever()\n```\n\n## Usage for Python\n\nIf you are not using a specific framework you can still use this library. You just have to get\nan instance of the `Handler` class and use the `start()` method to start handling the exception.\n\nThen you can get useful information easily and also define how you want to render the error. You\ncan even add your own renderer.\n\n```python\nfrom exceptionite import Handler\n\ntry:\n 2/0\nexcept Exception as e:\n handler = Handler()\n handler.start(e)\n```\n\nOnce you have the handler class theres a whole bunch of things we can now do!\n\n### Getting Exception Details\n\nGetting the exception name:\n\n```python\nhandler.exception() #== ZeroDivisionError\n```\n\nGetting the exception message:\n\n```python\nhandler.message() #== cannot divide by 0\n```\n\nGetting the exception namespace:\n\n```python\nhandler.namespace() #== builtins.ZeroDivisionError\n```\n\n### Rendering an HTML page\n\nYou can render an elegant exception page by using the `render` method with the [WebRenderer](#renderers):\n\n```python\nhandler.render(\"web\") #== <html> ... </html>\n```\n\nIf you have a framework or an application you can swap the exception handler out with this handler\nand then call this method.\n\n### Adding Context\n\nSometimes you will need to add more information to the exception page. This is where contexts come into play. Contexts are the ability to add any information you need to help you debug information.\n\nIf you use a framework like Masonite you might want to see information related to your Service Providers. If you use a framework like django you might want to see a list of your installed apps.\n\nOn the left side of the page below the stack trace you will find the context menu. Context is organised into blocks.\n\n1. You can register new contexts quickly by supplying a dictionary or a callable providing a dictionary:\n\n```python\nimport sys\n\nhandler.renderer(\"web\").context(\"System Variables\", {\"sys argv\": sys.argv})\n```\n\n2. Or you [can create custom blocks](#block) and add them to the `Context` tab:\n\n```python\nimport sys\nfrom exceptionite import Block\n\nclass SystemVarsBlock(Block):\n id = \"system_vars\"\n name= \"System Variables\"\n\n def build(self):\n return {\n \"sys argv\": sys.argv\n }\n\nhandler.renderer(\"web\").tab(\"context\").add_blocks(SystemVarsBlock)\n```\n\nThe second method allows to customize the block.\n\n### Hiding Sensitive Data\n\nExceptionite is configured by default to scrub data displayed in tab and blocks. This allows hiding sensitive data, by replacing it with `*****`.\n\nHiding sensitive data can be disabled globally in handler options with `options.hide_sensitive_data`.\n\nIt can also be disabled per block by setting `disable_scrubbing = True` in [block class](#block).\n\nThe keywords defined to find sensitive data can be edited:\n\n```python\n# define a new set of keywords\nhandler.set_scrub_keywords([\"app_secret\", \"pwd\"])\n# add new keywords\nhandler.add_scrub_keywords([\"app_secret\", \"pwd\"])\n```\n\nYou can see the default keywords by accessing `handler.scrub_keywords`.\n\n\n# Configuration\n\n## Options\n\nThe `exceptionite` handler comes with the default options below:\n```python\n{\n \"options\": {\n \"editor\": \"vscode\",\n \"search_url\": \"https://www.google.com/search?q=\",\n \"links\": {\n \"doc\": \"https://docs.masoniteproject.com\",\n \"repo\": \"https://github.com/MasoniteFramework/masonite\",\n },\n \"stack\": {\"offset\": 8, \"shorten\": True},\n \"hide_sensitive_data\": True\n },\n \"handlers\": {\n \"context\": True,\n \"solutions\": {\"stackoverflow\": False, \"possible_solutions\": True},\n \"recommendations\": {\"packages_updates\": {\"list\": [\"exceptionite\"]}},\n },\n}\n```\n\nYou can configure it by using `set_options(options)` method:\n```python\nfrom exceptionite import Handler, DefaultOptions\n\nhandler = Handler()\noptions = DefaultOptions\noptions.get(\"options\").update({\"search_url\": \"https://duckduckgo.com/?q=\"})\nhandler.set_options(options)\n```\n\nFor Masonite, options are defined in `exceptions.py` configuration file.\n\n## Renderers\n\nWhen an error is caught by Exceptionite, it can be rendered in many ways through configured renderers. Available renderers are:\n- WebRenderer: renders the exception as a beautiful HTML error page\n- TerminalRenderer: renders the exception nicely in the console\n- JSONRenderer: renders the exception as a JSON payload (useful for API errors handling)\n\nA renderer is a simple Python class with `build()` and `render()` methods. Feel free to create\nyour own one if needed !\n```python\nclass CustomRenderer:\n def __init__(self, handler: \"Handler\"):\n self.handler = handler\n self.data = None\n\n def build(self):\n exception = self.handler.exception()\n stack = self.handler.stacktrace()\n # build data from exception here...\n data = ...\n return data\n\n def render(self) -> str:\n self.data = self.build()\n # render the data as you want\n return\n```\n\nTo add a renderer:\n```python\nhandler.add_renderer(\"json\", JSONRenderer)\n```\n\nThen to render the exception using the renderer:\n```python\nhandler.render(\"json\") #== [{\"exception\": ...}]\n```\n\n\n## Web Renderer Specific Options\n\nThe HTML exception page created with the WebRenderer is highly configurable:\n\n- Search engine used to search the error message on the web:\n```python\n\"options\": {\n \"search_url\": \"https://www.google.com/search?q=\"\n # ...\n}\n```\n- Editor used to open the line on the stack trace at click:\n\n```python\n\"options\": {\n \"editor\": \"sublime\"\n # ...\n}\n```\n\nAvailable editors are `vscode`, `pycharm`, `idea`, `sublime`, `atom`, `textmate`, `emacs`, `macvim`, `vscodium`.\n\n- Navbar links to documentation and repository can be customized:\n\n```python\n\"options\": {\n \"links\": {\n \"doc\": \"https://docs.masoniteproject.com\",\n \"repo\": \"https://github.com/MasoniteFramework/exceptionite\",\n },\n}\n```\n\n- Tabs can be disabled. To disable `solutions` tab:\n```python\n\"handlers\": {\n \"solutions\": False\n}\n```\n\n- New tabs can be added:\n```python\nhandler.renderer(\"web\").add_tabs(DumpsTab)\n```\n\n\n### Blocks and Tabs API\n\n#### Tab\n\nA tab is defined with the following attributes:\n- `id (str)`: slug of the tab that should be unique, and used to access it from handler\n- `name (str)`: name of the tab displayed in the error page\n- `icon (str)`: icon of the tab displayed in the error page (available icons are defined [here](https://heroicons.com/). The name should be converted to UpperCamelCase.)\n- `advertise_content (bool)`: if `True` a animated dot will be displayed in error page navbar, if `has_content()` method returns `True`\n- `disable_scrubbing (bool)`: if `True`, data won't be scrubbed, meaning that [sensitive data](#hiding-sensitive-data) won't be hidden.\n\nand with the following methods (that can be overriden):\n- `has_content()`: should returns a `bool` that indicates if tab has content.\n\n\n#### Block\n\nA block is located in a tab. A tab can have many blocks. Blocks are added to tab in the following manner:\n```python\nclass ContextTab(Tab):\n\n name = \"Context\"\n id = \"context\"\n icon = \"ViewListIcon\"\n\n def __init__(self, handler):\n super().__init__(handler)\n self.add_blocks(Environment, Packages, Git)\n# OR\nhandler.renderer(\"web\").tab(\"context\").add_blocks(Environment, Packages, Git)\n```\n\nA block is defined with the following attributes:\n- `id (str)`: slug of the block that should be unique, and used to access it from handler\n- `name (str)`: name of the block displayed in the error page\n- `icon (str)`: icon of the block displayed in the error page (available icons are defined [here](https://heroicons.com/). The name should be converted to UpperCamelCase.)\n- `disable_scrubbing (bool)`: if `True`, data won't be scrubbed, meaning that [sensitive data](#hiding-sensitive-data) won't be hidden.\n- `empty_msg (str)`: message that will be displayed if block data is empty.\n- `has_sections (bool)`: enable this to render dict as sections, where each root key is a section title and value is a nested dict.\n\nand with the following methods:\n\n- `build()`: must be implemented and should returns data that can be serialized. This data will be provided to the Vue block component.\n- `has_content()`: should returns a `bool` that indicates if tab has content.\n\n\n# Contributing\n\nPlease read the [Contributing Documentation](CONTRIBUTING.md) here.\n\n# Maintainers\n\n- [Joseph Mancuso](https://github.com/josephmancuso)\n- [Samuel Girardin](https://www.github.com/girardinsamuel)\n\n# License\n\nExceptionite is open-sourced software licensed under the [MIT license](LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Exception Handling Made Easy",
"version": "2.2.5",
"split_keywords": [
"masonite",
"python",
"development",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e76982c59cd7eac3cba0d738fa4e2e39",
"sha256": "f6a4ee8a527f972a1cdc4930176fa5b786a362208e96a663a272067abef09d66"
},
"downloads": -1,
"filename": "exceptionite-2.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e76982c59cd7eac3cba0d738fa4e2e39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 484359,
"upload_time": "2022-05-17T11:44:27",
"upload_time_iso_8601": "2022-05-17T11:44:27.533228Z",
"url": "https://files.pythonhosted.org/packages/aa/32/dd0f8d5994c685b0609f698744512078dc75172405b389200464d120b077/exceptionite-2.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ed01be96ab430e4fa465cd639cdc2232",
"sha256": "3f76eede3eebc3c50e2ed8897609ef7c09bee176fc71ebe3fbe99f6822060dd0"
},
"downloads": -1,
"filename": "exceptionite-2.2.5.tar.gz",
"has_sig": false,
"md5_digest": "ed01be96ab430e4fa465cd639cdc2232",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1159872,
"upload_time": "2022-05-17T11:44:29",
"upload_time_iso_8601": "2022-05-17T11:44:29.648394Z",
"url": "https://files.pythonhosted.org/packages/7e/da/f599dd48cc1ede8b180fafb2f125857a2931b2c7930422a07f1e22be3f03/exceptionite-2.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-17 11:44:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "masoniteframework",
"github_project": "exceptionite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "flake8",
"specs": []
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "exceptionite"
}
JSON
