Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alex-oleshkevich/starception
Beautiful exception page for Starlette apps.
https://github.com/alex-oleshkevich/starception
debugger error-handler exceptions-handling fastapi starlette
Last synced: 20 days ago
JSON representation
Beautiful exception page for Starlette apps.
- Host: GitHub
- URL: https://github.com/alex-oleshkevich/starception
- Owner: alex-oleshkevich
- License: mit
- Created: 2022-08-09T18:26:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T22:34:28.000Z (2 months ago)
- Last Synced: 2024-11-16T20:16:40.699Z (27 days ago)
- Topics: debugger, error-handler, exceptions-handling, fastapi, starlette
- Language: CSS
- Homepage:
- Size: 892 KB
- Stars: 97
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# Starception
Beautiful exception page for Starlette and FastAPI apps.
## Installation
Install `starception` using PIP or poetry:
```bash
pip install starception
# or
poetry add starception
```
### With syntax highlight support
If you want to colorize code snippets, install `pygments` library.
```bash
pip install starception[pygments]
# or
poetry add starception -E pygments
```
## Screenshot
Dark theme
## Features
* secrets masking
* solution hints
* code snippets
* display request info: query, body, headers, cookies
* session contents
* request and app state
* platform information
* environment variables
* syntax highlight
* open paths in editor (vscode only)
* exception chains
* dark theme
Starception automatically masks any value which key contains `key`, `secret`, `token`, `password`.
## Quick start
See example application in [examples/](examples/) directory of this repository.
## Usage
Starception will work only in debug mode so don't forget to set `Starlette.debug=True`.
To replace built-in debug exception handler call `install_error_handler` before you create Starlette instance.
```python
from starception import install_error_handler
from starlette.applications import Starlette
install_error_handler()
app = Starlette()
```
### Integration with other frameworks
`starception` exports `starception.exception_handler(request, exc)` function, which you can use in your
framework.
But keep in mind, Starlette will [not call](https://github.com/encode/starlette/issues/1802) any custom exception
handler
in debug mode (it always uses built-in one).
The snipped below will not work as you expect (unfortunately).
```python
from starlette.applications import Starlette
from starception import exception_handler
app = Starlette(
debug=True,
exception_handlers={Exception: exception_handler}
)
```
## Solution hints
If exception class has `solution` attribute then its content will be used as a solution hint.
```python
class WithHintError(Exception):
solution = (
'The connection to the database cannot be established. '
'Either the database server is down or connection credentials are invalid.'
)
```
## Opening files in editor
Set your current editor to open paths in your editor/IDE.
```python
from starception import set_editor
set_editor('vscode')
```
> Note, currently only VSCode supported. If you know how to integrate other editors - please PR
### Registering link templates
If your editor is not supported, you can add it by calling `add_link_template` and then selecting it with `set_editor`.
```python
from starception import set_editor, add_link_template
add_link_template('vscode', 'vscode://file/{path}:{lineno}')
set_editor('vscode')
```
## Credentials
* Look and feel inspired by [Phoenix Framework](https://www.phoenixframework.org/).
* Icons by [Tabler Icons](https://tabler-icons.io/).