Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HallerPatrick/frosch
🐸 Debug faster than a frog catches a fly
https://github.com/HallerPatrick/frosch
debugging utility utility-library
Last synced: about 1 month ago
JSON representation
🐸 Debug faster than a frog catches a fly
- Host: GitHub
- URL: https://github.com/HallerPatrick/frosch
- Owner: HallerPatrick
- License: mit
- Created: 2020-10-25T21:38:51.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-02T19:06:00.000Z (almost 2 years ago)
- Last Synced: 2024-11-06T22:52:44.230Z (about 2 months ago)
- Topics: debugging, utility, utility-library
- Language: Python
- Homepage: https://hallerpatrick.github.io/frosch/
- Size: 956 KB
- Stars: 200
- Watchers: 3
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# frosch - Runtime Error Debugger
[](https://badge.fury.io/py/frosch)
Better runtime error messages
Are you also constantly seeing the runtime error message the
python interpreter is giving you?
It lacks some color and more debug information!
Get some good looking error tracebacks and beautifuly formatted
last line with all its last values *before* you crashed the program.
## Installation
```bash
$ pip install frosch
```
## Usage
Call the hook function at the beginning of your program.
```python
from frosch import hook
hook()
x = 3 + "String"
```
### Print Exceptions
You can also easily print your catched exceptions to stdout
```python
from frosch import print_exception
try:
x = [0, 1]
x[3]
except IndexError as error:
print_exception(error)
```
# Configuration
## Themes
frosch allows to use different themes for styling the output:
| Themes | | | | | |
|----------|----------|----------|---------------|-------------|------|
| abap | bw | igor | native | rrt | trac |
| algol | colorful | inkpot | paraiso_dark | sas | vim |
| algol_nu | default | lovelace | paraiso_light | solarized | vs |
| arduino | emacs | manni | pastie | stata_dark | xcode |
| autumn | friendly | monokai | perldoc | stata_light | |
| borland | fruity | murphy | rainbow_dash | tango | |
Usage:
```python
from frosch import hook
hook(theme="vim")
```
### Custom Themes
You can also define custom themes by by subclassing Style (which is just a thin wrapper
around pygments styles) and pass it to the hook.
For more information please use the [pygments docs](https://pygments.org/docs/styles/#creating-own-styles).
```python
from frosch import hook
from frosch.style import Style
from frosch.style.token import Keyword, Name, Comment, String, Error, \
Number, Operator, Generic
class CustomStyle(Style):
default_style = ""
styles = {
Comment: 'italic #888',
Keyword: 'bold #005',
Name: '#f00',
Name.Function: '#0f0',
Name.Class: 'bold #0f0',
String: 'bg:#eee #111'
}
hook(theme=CustomStyle)
```
## OS Notifications
But wait there is more!
Running longer scripts in the background?
Just add a title and/or message to the hook and it will you give a notification when your program
is crashing.
```python
from frosch import hook
hook(
theme="vs", # VSCode Theme
title="I crashed!",
message="Run Number #1444 is also crashing..."
)
```
This works on MacOS (`osascript`), Linux (`notify-send`) and Windows (`powershell`).
# Contribution
`frosch` uses [poetry](https://github.com/python-poetry/poetry) for build and dependency
management, so please install beforehand.
## Setup
```bash
$ git clone https://github.com/HallerPatrick/frosch.git
$ poetry install
```
## Run tests
```python
$ python -m pytest tests
```