diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-18 05:38:43 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-18 05:38:43 +0000 |
| commit | 0e767ecbb34906f8cfab07444507d0d2fa895941 (patch) | |
| tree | 77e5b144cd97b63763a642bba0f025f7b35dde31 | |
| parent | 33023de548dd72bfb540fb227e8f88f03594e0f1 (diff) | |
automatic import of python-exceptionite
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-exceptionite.spec | 1606 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 1608 insertions, 0 deletions
@@ -0,0 +1 @@ +/exceptionite-2.2.5.tar.gz diff --git a/python-exceptionite.spec b/python-exceptionite.spec new file mode 100644 index 0000000..20ffb03 --- /dev/null +++ b/python-exceptionite.spec @@ -0,0 +1,1606 @@ +%global _empty_manifest_terminate_build 0 +Name: python-exceptionite +Version: 2.2.5 +Release: 1 +Summary: Exception Handling Made Easy +License: MIT license +URL: https://github.com/masoniteframework/exceptionite +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/7e/da/f599dd48cc1ede8b180fafb2f125857a2931b2c7930422a07f1e22be3f03/exceptionite-2.2.5.tar.gz +BuildArch: noarch + +Requires: python3-jinja2 +Requires: python3-requests +Requires: python3-colorama +Requires: python3-dotty-dict +Requires: python3-typing-extensions +Requires: python3-mock +Requires: python3-black +Requires: python3-flake8 +Requires: python3-coverage +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-twine +Requires: python3-wheel + +%description + +# 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). + + + + +%package -n python3-exceptionite +Summary: Exception Handling Made Easy +Provides: python-exceptionite +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-exceptionite + +# 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). + + + + +%package help +Summary: Development documents and examples for exceptionite +Provides: python3-exceptionite-doc +%description help + +# 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). + + + + +%prep +%autosetup -n exceptionite-2.2.5 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-exceptionite -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 2.2.5-1 +- Package Spec generated @@ -0,0 +1 @@ +ed01be96ab430e4fa465cd639cdc2232 exceptionite-2.2.5.tar.gz |
