vaaaaanquish / xontrib-readable-traceback Goto Github PK

View Code? Open in Web Editor NEW

10.0 4.0 3.0 306 KB

xonsh readable traceback

License: MIT License

Python 21.67% Xonsh 78.33%

xontrib xonsh shell

xontrib-readable-traceback's Introduction

xontrib-readable-traceback

Make traceback easier to see for xonsh.

Python work very often with large libraries like pandas, or matplotlib. This means that exceptions often produce long stack traces. Since we don't need to see the library detail in the vast majority of cases. Especially with a shell like xonsh.

This xontrib making readable and short traceback.

example: Simple division by zero error.

example: This simple pandas error produces a stacktrace containing 28 lines. But xontrib load...

Install

Install using pip

pip install xontrib-readable-traceback

Write .xonshrc

xontrib load readable-traceback

Usage

This xontrib use backtrace package.

For the main usage, please refer to the following.

https://github.com/nir0s/backtrace#usage

Example xonshrc

xonshrc sample.

~~~
xontrib load readable-traceback
$READABLE_TRACE_STRIP_PATH_ENV=True
$READABLE_TRACE_REVERSE=True
~~~

Setting backtrace

The correspondence with the variable of backtrace is as follows.

backtrace	xontrib-readable-traceback	Type
reverse	$READABLE_TRACE_REVERSE	bool
align	$READABLE_TRACE_ALIGN	bool
strip_path	$READABLE_TRACE_STRIP_PATH_ENV	bool
enable_on_envvar_only	$READABLE_TRACE_ENVVAR_ONLY	bool
on_tty	$READABLE_TRACE_ON_TTY	bool
conservative	$READABLE_TRACE_CONSERVATIVE	bool
style	$READABLE_TRACE_STYLES	dict

For details of style please refer to backtrace#style and colorama.

Switching readable-traceback

If we want to turn trace off, we can use:

$XONSH_READABLE_TRACEBACK=False

If so, the notation of traceback follows xonsh_env($XONSH_SHOW_TRACEBACK).

Xonsh traceback log

Xonsh can keep a log of traceback.
To keep the log, write "ABSOLUTE PATH TO TRACEBACK LOG" below.

$XONSH_TRACEBACK_LOGFILE="PATH"

If it is None, no log is kept. Default is None.

Thanks

I appreciate all Python's assets and xonsh.
If there is something problem, up to github issue.
@vaaaaanquish

xontrib-readable-traceback's People

Contributors

Stargazers

Watchers

Forkers

t184256 neolithera playfloor

xontrib-readable-traceback's Issues

Browser-based approach

Here is my attempt at improving them:

Google Colab standard backtrace	Niceback enabled

https://github.com/Tronic/niceback

Add social preview image

Hi! Thank you for the xontrib!

If you open xontrib topic on Github and scroll down you'll see the cute preview images for some xontribs. This is "Social preview" image that could be uploaded in the Settings of the repo.

Please take a common screenshot and put it to the preview image.

Thanks!

Switch dependency 'backtrace' to 'pretty-traceback'

The backtrace package is basically pinning for the fjords, but a replacement seems to be available.

Switching to it would also solve issue #4 (colorama version pinning is already loosened in backtrace's source, but was never released on PyPi).

Installation fails due to conflicting colorama version

Hi, users are unable to run Xontrib-readable-traceback due to dependency conflict with colorama package. As shown in the following full dependency graph of Xontrib-readable-traceback, Xontrib-readable-traceback requires colorama>=0.3.7，while backtrace>=1.0.2 requires colorama==0.3.7.

According to pip’s “first found wins” installation strategy, colorama 0.4.3 is the actually installed version. However, colorama 0.4.3 does not satisfy colorama==0.3.7.

Dependency tree-----------

xontrib-readable-traceback - 0.3.2
| +- backtrace(install version:0.2.1 version range:*)
| | +- colorama(install version:0.3.7 version range:==0.3.7)
| +- colorama(install version:0.4.3 version range:>=0.3.7)

Thanks for your help.
Best,
Neolith

add CI/CD

I want CI/CD.

Add tags to repo

Hi! Thank you for the useful xontrib!

Please add xonsh and xontrib tags to the repo:

It helps spread the word about xontrib on Github.